Skip to content

Commit

Permalink
Merge pull request #202 from cloudbees/DOCS-10873
Browse files Browse the repository at this point in the history
[DOCS-10873] Copy edits for the latest release
  • Loading branch information
carlosrodlop authored Oct 4, 2024
2 parents a9fdc33 + a40550c commit 38ae098
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 72 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,9 @@ The CloudBees CI add-on uses `helms release` for its resources definition, makin
| create_reg_secret | Create a Kubernetes dockerconfigjson secret for container registry authentication (cbci-sec-reg) for CI builds agents. | `bool` | `false` | no |
| helm_config | CloudBees CI Helm chart configuration. | `any` | <pre>{<br> "values": [<br> ""<br> ]<br>}</pre> | no |
| prometheus_target | Creates a service monitor to discover the CloudBees CI Prometheus target dynamically. It is designed to be enabled with the AWS EKS Terraform Addon Kube Prometheus Stack. | `bool` | `false` | no |
| prometheus_target_ns | Namespace. It is designed to be enabled with the AWS EKS Terraform Addon Kube Prometheus Stack. It is required when prometheus_target is enabled. | `string` | `"observability"` | no |
| prometheus_target_ns | Prometheus target namespace, designed to be enabled with the AWS EKS Terraform Addon Kube Prometheus Stack. It is required when prometheus_target is enabled. | `string` | `"observability"` | no |
| reg_secret_auth | Registry server authentication details for cbci-sec-reg secret. It is required when create_reg_secret is enabled. | `map(string)` | <pre>{<br> "email": "foo.bar@acme.com",<br> "password": "changeme1234",<br> "server": "my-registry.acme:5000",<br> "username": "foo"<br>}</pre> | no |
| reg_secret_ns | Agent namespace to allocate cbci-sec-reg secret. It is required when create_reg_secret is enabled. | `string` | `"cbci"` | no |
| reg_secret_ns | Agent namespace to allocate the cbci-sec-reg secret. It is required when create_reg_secret is enabled. | `string` | `"cbci"` | no |

### Outputs

Expand All @@ -125,7 +125,7 @@ The CloudBees CI add-on uses `helms release` for its resources definition, makin
| cbci_oc_pod | Operations center pod for the CloudBees CI add-on. |
| cbci_oc_url | Operations center URL for the CloudBees CI add-on using a subdomain and certificates. |
| cbci_sec_casc | Optional. Kubernetes secrets name for CloudBees CI Casc. |
| cbci_sec_registry | Optional. Kubernetes secrets name for CloudBees CI agents to authenticate to registry. |
| cbci_sec_registry | Optional. Kubernetes secrets name for CloudBees CI agents to authenticate the registry. |
| merged_helm_config | (merged) Helm configuration for CloudBees CI. |
<!-- END_TF_DOCS -->

Expand Down
16 changes: 8 additions & 8 deletions blueprints/01-getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,8 +62,8 @@ This blueprint presents the minimum setup to run CloudBees CI on Amazon EKS; one
When preparing to deploy, you must complete the following steps:

1. Customize your Terraform values by copying `.auto.tfvars.example` to `.auto.tfvars`.
2. Initialize the root module and any associated configuration for providers.
3. Create the resources and deploy CloudBees CI to an EKS cluster. Refer to [Amazon EKS Blueprints for Terraform - Deploy](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#deploy).
1. Initialize the root module and any associated configuration for providers.
1. Create the resources and deploy CloudBees CI to an EKS cluster. Refer to [Amazon EKS Blueprints for Terraform - Deploy](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#deploy).

For more information, refer to [The Core Terraform Workflow](https://www.terraform.io/intro/core-workflow) documentation.

Expand Down Expand Up @@ -94,37 +94,37 @@ Once you can access the Kubernetes API from your terminal, complete the followin
eval $(terraform output --raw cbci_oc_pod)
```

2. Issue the following command to verify that the Ingress is ready and has assigned a valid `ADDRESS`:
1. Issue the following command to verify that the Ingress is ready and has assigned a valid `ADDRESS`:

```sh
eval $(terraform output --raw cbci_oc_ing)
```

3. Issue the following command to verify that the operations center service is running from inside the Kubernetes cluster:
1. Issue the following command to verify that the operations center service is running from inside the Kubernetes cluster:

```sh
eval $(terraform output --raw cbci_liveness_probe_int)
```

If the command is successful, no output is returned.

4. Issue the following command to verify that the operations center service is running from outside the Kubernetes cluster:
1. Issue the following command to verify that the operations center service is running from outside the Kubernetes cluster:

```sh
eval $(terraform output --raw cbci_liveness_probe_ext)
```

If the command is successful, no output is returned.

5. DNS propagation may take several minutes. Once propagation is complete, issue the following command, copy the output, and then paste it into a web browser.
1. DNS propagation may take several minutes. Once propagation is complete, issue the following command, copy the output, and then paste it into a web browser.

```sh
terraform output cbci_oc_url
```

6. Paste the output of the previous command into your browser to access the CloudBees CI setup wizard to complete the CloudBees CI operations center installation.
1. Paste the output of the previous command into your browser to access the CloudBees CI setup wizard to complete the CloudBees CI operations center installation.

7. Issue the following command to retrieve the first administrative user password (required):
1. Issue the following command to retrieve the first administrative user password (required):

```sh
eval $(terraform output --raw cbci_initial_admin_password)
Expand Down
Loading

0 comments on commit 38ae098

Please sign in to comment.