Skip to content

Commit

Permalink
Fixed some problems
Browse files Browse the repository at this point in the history
  • Loading branch information
kellie-freeman committed Sep 11, 2024
1 parent 6748652 commit a320ba1
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 23 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ Many of the files in the repository can be linted or formatted to maintain a sta

## Release Drafter

This repository uses [Release Drafter](https://github.com/release-drafter/release-drafter) thus it is recommended to use [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) to ease labelling your pull request accordingly.
This repository uses [Release Drafter](https://github.com/release-drafter/release-drafter). Therefore, it is recommended that you use [Semantic Commit Messages](https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716) to label your pull requests accordingly.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The CloudBees CD/RO AWS add-on streamlines the adoption and experimentation of C
- Providing a series of opinionated [blueprints](blueprints) that implement the CloudBees CD/RO add-on module for use with [Amazon EKS blueprints for Terraform](https://aws-ia.github.io/terraform-aws-eks-blueprints-addons/main/) which are aligned with the [EKS Best Practices Guides](https://aws.github.io/aws-eks-best-practices/).

## CloudBees CD/RO license
You must have a valid license to operate the CloudBees CD/RO server. By default, CloudBees CD/RO uses the Server License type. For more information, refer to [CloudBees CD/RO Licensing](https://docs.cloudbees.com/docs/cloudbees-cd/latest/set-up-cdro/licenses).
You must have a valid license to operate the CloudBees CD/RO server. By default, CloudBees CD/RO uses the server license type. For more information, refer to [Licenses](https://docs.cloudbees.com/docs/cloudbees-cd/latest/set-up-cdro/licenses).

## Usage

Expand All @@ -35,9 +35,6 @@ module "eks_blueprints_addon_cbcd" {

By default, it uses a minimum required configuration described in the Helm chart [values.yml](values.yml). If you need to override any default settings with the chart, you can do so by passing the `helm_config` variable.

> [!TIP]
> The blueprints lifecycle (`deploy` > `validate` > `destroy`) can be orchestrated via the companion [Makefile](Makefile).
## Prerequisites

### Tooling
Expand All @@ -53,7 +50,7 @@ Before getting started, you must export your required [AWS Environment Variables

### Existing AWS 53 hosted zone

These blueprints rely on an existing hosted zone in AWS Route 53. If you do not have a hosted zone, you can create one by following the [AWS Rout 53 documentation](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html).
These blueprints rely on an existing hosted zone in AWS Route 53. If you do not have a hosted zone, you can create one by following the [AWS Route 53 documentation](https://docs.aws.amazon.com/Route53/latest/DeveloperGuide/hosted-zones-working-with.html).

## Data storage options

Expand Down
3 changes: 1 addition & 2 deletions blueprints/01-getting-started/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# CloudBees CD/RO blueprint add-on: Get started

Get started with the [CloudBees CD/RO on Kubernetes
](https://docs.cloudbees.com/docs/cloudbees-cd/latest/install-k8s/) by running this blueprint, which only installs the product and its [prerequisites](https://docs.cloudbees.com/docs/cloudbees-cd/latest/install-k8s/installation, to help you understand the minimum setup:
Get started with [CloudBees CD/RO in EKS](https://docs.cloudbees.com/docs/cloudbees-cd/latest/install-k8s/) by running this blueprint, which only installs the product and its [prerequisites](https://docs.cloudbees.com/docs/cloudbees-cd/latest/install-k8s/installation), to help you understand the minimum setup:

- Amazon Web Services (AWS) certificate manager
- The following [Amazon EKS blueprints add-ons](https://aws-ia.github.io/terraform-aws-eks-blueprints-addons/main/):
Expand Down
6 changes: 3 additions & 3 deletions blueprints/01-getting-started/outputs.tf
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

output "kubeconfig_export" {
description = "Export the KUBECONFIG environment variable to access the Kubernetes API."
description = "Exports the KUBECONFIG environment variable to access the Kubernetes API."
value = "export KUBECONFIG=${local.kubeconfig_file_path}"
}

output "kubeconfig_add" {
description = "Add Kubeconfig to your local configuration to access the Kubernetes API."
description = "Adds Kubeconfig to your local configuration to access the Kubernetes API."
value = "aws eks update-kubeconfig --region ${local.region} --name ${local.cluster_name}"
}

Expand All @@ -26,7 +26,7 @@ output "cbcd_url" {
}

output "cbcd_password" {
description = "Command to get the admin password for the CloudBees CD/RO add-on."
description = "Retrieves the admin password for the CloudBees CD/RO add-on."
value = module.eks_blueprints_addon_cbcd.cbcd_password
}

Expand Down
9 changes: 3 additions & 6 deletions blueprints/02-at-scale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ Once you have familiarized yourself with the [CloudBees CD/RO blueprint: Get sta
> [!TIP]
> A [resource group](https://docs.aws.amazon.com/ARG/latest/userguide/resource-groups.html) is also included, to get a full list of all resources created by this blueprint.
## CloudBees CD/RO license
A license is required to use CloudBees CD/RO. Please refer to [CloudBees CD/RO Licensing](https://docs.cloudbees.com/docs/cloudbees-cd/latest/set-up-cdro/licenses) for more information.

## Architecture

![Architecture](img/at-scale.architect.drawio.svg)
Expand Down Expand Up @@ -69,7 +66,7 @@ A license is required to use CloudBees CD/RO. Please refer to [CloudBees CD/RO L
| vpc_arn | VPC ID |
<!-- END_TF_DOCS -->

~~## Deploy
## Deploy

When preparing to deploy, you must complete the following steps:

Expand Down Expand Up @@ -112,7 +109,7 @@ Once you can access the Kubernetes API from your terminal, complete the followin
```
### Back up and restore

#### Back up and restore Database storage using Amazon Relational Database Service (Amazon RDS)
#### Back up and restore database storage using Amazon Relational Database Service (Amazon RDS)

1. Issue the following command to create a snapshot of the Amazon RDS instance:

Expand Down Expand Up @@ -144,7 +141,7 @@ Once you can access the Kubernetes API from your terminal, complete the followin
eval $(terraform output --raw velero_restore_team_cd)
```

4. Issue the following command to restore from an Amazon EFS access point, that matches the CloudBees CD/RO PVC):
4. Issue the following command to restore from an Amazon EFS access point, that matches the CloudBees CD/RO PVC:

```sh
eval $(terraform output --raw efs_access_points) | . jq .AccessPoints[].RootDirectory.Path
Expand Down
10 changes: 5 additions & 5 deletions blueprints/02-at-scale/outputs.tf
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
output "kubeconfig_export" {
description = "Export the KUBECONFIG environment variable to access the Kubernetes API."
description = "Exports the KUBECONFIG environment variable to access the Kubernetes API."
value = "export KUBECONFIG=${local.kubeconfig_file_path}"
}

output "kubeconfig_add" {
output "kubeconfig_asdd" {
description = "Add kubeconfig to your local configuration to access the Kubernetes API."
value = "aws eks update-kubeconfig --region ${local.region} --name ${local.cluster_name}"
}
Expand All @@ -25,7 +25,7 @@ output "cbcd_url" {
}

output "cbcd_password" {
description = "Retrieve the administrator password for CloudBees CD/RO."
description = "Retrieves the administrator password for CloudBees CD/RO."
value = module.eks_blueprints_addon_cbcd.cbcd_password
}

Expand All @@ -45,12 +45,12 @@ output "rds_arn" {
}

output "rds_backup_cmd" {
description = "Perform a database backup."
description = "Performs a database backup."
value = "aws rds create-db-snapshot --db-instance-identifier ${local.rds_instance_id} --db-snapshot-identifier ${local.rds_snapshot_id}"
}

output "rds_restore_cmd" {
description = "Perform a database restore from a snapshot."
description = "Performs a database restore from a snapshot."
value = "aws rds restore-db-instance-from-db-snapshot --db-instance-identifier ${local.rds_instance_id} --db-snapshot-identifier ${local.rds_snapshot_id}"
}

Expand Down
2 changes: 1 addition & 1 deletion outputs.tf
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ output "cbcd_url" {
}

output "cbcd_password" {
description = "Command to retrieve the admin password of CloudBees CD/RO."
description = "Retrieves the admin password of CloudBees CD/RO."
value = "kubectl get secret --namespace ${local.namespace} cloudbees-cd-cloudbees-flow-credentials -o jsonpath='{.data.CBF_SERVER_ADMIN_PASSWORD}' | base64 -d; echo"
}

Expand Down

0 comments on commit a320ba1

Please sign in to comment.