Skip to content

Commit

Permalink
Merge branch 'develop' of github.com:cloudbees/terraform-aws-cloudbee…
Browse files Browse the repository at this point in the history
…s-ci-eks-addon into develop
  • Loading branch information
carlosrodlop committed Mar 15, 2024
2 parents 44c28b4 + 4a55f6c commit a9d2088
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ To submit a pull request:
5. Submit a pull request against the `develop` branch and answer any default questions in the pull request interface.

> [!IMPORTANT]
> Validate Casc Bundle SCM is pointing to the `develop` branch.
> You must validate that the CasC bundle source control management (SCM) tool is pointing to the `develop` branch.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

Expand All @@ -49,7 +49,7 @@ To submit a pull request:

### Pre-commits: Linting, formatting and secrets scanning

Many of the files in the repository can be lined or formatted to maintain a standard of quality. Additionally, secret leaks are watched via [gitleaks](https://github.com/zricethezav/gitleaks#pre-commit) and [git-secrets](https://github.com/awslabs/git-secrets).
Many of the files in the repository can be linted or formatted to maintain a standard of quality. Additionally, secret leaks are watched via [gitleaks](https://github.com/zricethezav/gitleaks#pre-commit) and [git-secrets](https://github.com/awslabs/git-secrets).

When working with the repository for the first time, you must run `pre-commit`:

Expand All @@ -76,14 +76,14 @@ The [bp-tf-ci.yaml](.cloudbees/workflows/bp-tf-ci.yaml) blueprints are orchestra
## Release

Pre-requisites:
Prerequisites:

1. Project Admins create a Pull Request from `develop` to `main`.
1. Project administrators must create a pull request from the `develop` branch to the `main` branch.

> [!IMPORTANT]
> Validate Casc Bundle SCM is pointing to the `main` branch.
> You must validate that the CasC bundle SCM tool is pointing to the `main` branch.
2. Once it is merged, ensure `main` branch successfully passes the [Terraform CI build](#Blueprint Terraform_CI_pipeline).
2. Once the pull request is merged, verify that the `main` branch successfully passes the [Terraform CI build](#blueprint-terraform-ci-pipeline).

This project uses [Release Drafter](https://github.com/release-drafter/release-drafter); pull request labels should be set accordingly.

Expand Down
6 changes: 3 additions & 3 deletions blueprints/02-at-scale/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,18 +90,18 @@ Once you have familiarized yourself with [CloudBees CI blueprint add-on: Get sta

## Deploy

In addition to the minimum required settings explained in [Get started - Deploy](../01-getting-started/README.md#deploy), when preparing to deploy, you must [customize the secrets file](#customize-secrets-file) and [update Amazon S3 bucket settings in Casc](#update-amazon-s3-bucket-settings)
In addition to the minimum required settings explained in [Get started - Deploy](../01-getting-started/README.md#deploy), when preparing to deploy, you must [create the secrets file](#create-the-secrets-file) and [update Amazon S3 bucket settings](#update-amazon-s3-bucket-settings)

> [!TIP]
> The `deploy` phase can be orchestrated via the companion [Makefile](../../Makefile).
### Secrets file
### Create the secrets file

You must create your secrets file by copying the contents of [secrets-values.yml.example](k8s/secrets-values.yml.example) to `secrets-values.yml`. This provides [Kubernetes secrets](https://github.com/jenkinsci/configuration-as-code-plugin/blob/master/docs/features/secrets.adoc#kubernetes-secrets) that can be consumed by CasC.

### Update Amazon S3 bucket settings

Since the Terraform variable `suffix` is used for this blueprint (optional), you must update the Amazon S3 bucket name for CloudBees CI controllers and the Amazon S3 bucket for the backup controller cluster operations. To update the Amazon S3 bucket name, you have the following options:
Since the optional Terraform variable `suffix` is used for this blueprint, you must update the Amazon S3 bucket name for CloudBees CI controllers and the Amazon S3 bucket for the backup controller cluster operations. To update the Amazon S3 bucket name, you have the following options:

- [Option 1: Update Amazon S3 bucket name using CasC](#option-1-update-amazon-s3-bucket-name-using-casc)
- [Option 2: Update Amazon S3 bucket name using the CloudBees CI UI](#option-2-update-amazon-s3-bucket-name-using-the-cloudbees-ci-ui)
Expand Down

0 comments on commit a9d2088

Please sign in to comment.