Doc Contributions and Docker Workflows

.cloudbees/workflows/bp-agent-ecr.yaml

@@ -8,7 +8,7 @@ name: agent
 on:
   push:
     branches:
-      - '**'
+      - 'main'
 
 env:
   REGISTRY: public.ecr.aws/r1n1q0e5

.cloudbees/workflows/ldap-gh.yaml

@@ -8,7 +8,7 @@ name: agent
 on:
   push:
     branches:
-      - '**'
+      - 'main'
 
 env:
   REGISTRY: ghcr.io

CONTRIBUTING.md

@@ -4,7 +4,7 @@ This document provides guidelines for contributing to the CloudBees CI add-on fo
 
 ## Design principles
 
-It follows the same approach as the [Terraform AWS EKS Blueprints for Terraform Patterns](https://aws-ia.github.io/terraform-aws-eks-blueprints/)
+It follows the same approach as the [Terraform AWS EKS Blueprints for Terraform Patterns](https://aws-ia.github.io/terraform-aws-eks-blueprints/).
 
 ## Report bugs and feature requests
 
@@ -37,13 +37,26 @@ To submit a pull request:
 3. **Ensure that local tests pass**.
 4. Make commits to your fork using clear commit messages.
 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.
+
 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 >[!TIP]
 > GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
-## CI pipeline
+### 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).
+
+When working with the repository for the first time, you must run `pre-commit`:
+
+1. Run `pre-commit install`.
+2. Run `pre-commit run --all-files`.
+
+## Blueprint Terraform CI pipeline
 
 Validate your pull request changes inside the blueprint agent described in the [Dockerfile](.docker/agent). It is the same agent used for the CI pipeline [bp-agent-ecr.yaml](.cloudbees/workflows/bp-agent-ecr.yaml).
 
@@ -61,17 +74,17 @@ The [bp-tf-ci.yaml](.cloudbees/workflows/bp-tf-ci.yaml) blueprints are orchestra
 > [!IMPORTANT]
 > CloudBees Platform currently only supports push events. Therefore, pull requests are sent to the `dev` branch for integration.
 
-## Pre-commits: Linting, formatting and secrets scanning
+## Release
 
-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).
+Pre-requisites:
 
-When working with the repository for the first time, you must run `pre-commit`:
+1. Project Admins create a Pull Request from `develop` to `main`.
 
-1. Run `pre-commit install`.
-2. Run `pre-commit run --all-files`.
+> [!IMPORTANT]
+> Validate Casc Bundle SCM is pointing to the `main` branch.
 
-## Release
+2. Once it is merged, ensure `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.
+
 Kubernetes' environment versions are managed centrally in the [blueprints/.k8.env](blueprints/.k8s.env) file.
-For a new release, the latest commits in the `main` branch should successfully pass the CI build.

README.md

@@ -44,17 +44,14 @@ module "eks_blueprints_addon_cbci" {
 
 By default, it uses a minimum required configuration described in the Helm chart [values.yaml](values.yml) file. 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
 
 ### Tools
 
 The blueprint `deploy` and `destroy` phases use the same requirements provided in the [AWS EKS Blueprints for Terraform - Prerequisites](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#prerequisites). However, the blueprint `validate` phase may require additional tooling, such as `jq` and `velero`.
 
 > [!NOTE]
-> There is a companion [Dockerfile](.docker) to run the blueprints in a containerized development environment, ensuring all dependencies are met. It can be built using the [Makefile](Makefile) target `make dRun`.
+> There is a companion [Dockerfile](.docker/agent/agent.rootless.Dockerfile) to run the blueprints in a containerized development environment, ensuring all dependencies are met. It can be built using the [Makefile](Makefile) target `make bpAgent-dRun`.
 
 ### AWS authentication
 

blueprints/01-getting-started/README.md

@@ -63,6 +63,9 @@ When preparing to deploy, you must complete the following steps:
 
 For more information, refer to [The Core Terraform Workflow](https://www.terraform.io/intro/core-workflow) documentation.
 
+> [!TIP]
+> The `deploy` phase can be orchestrated via the companion [Makefile](../../Makefile).
+
 ## Validate
 
 Once the blueprint has been deployed, you can validate it.
@@ -126,3 +129,6 @@ Once you can access the Kubernetes API from your terminal, complete the followin
 ## Destroy
 
 To tear down and remove the resources created in the blueprint, complete the steps for [Amazon EKS Blueprints for Terraform - Destroy](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#destroy).
+
+> [!TIP]
+> The `destroy` phase can be orchestrated via the companion [Makefile](../../Makefile).

blueprints/02-at-scale/README.md

@@ -90,18 +90,18 @@ Once you have familiarized yourself with [CloudBees CI blueprint add-on: Get sta
 
 ## Deploy
 
-When preparing to deploy, you must [customize the secrets file](#customize-secrets-file) and [update Amazon S3 bucket settings](#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 [customize the secrets file](#customize-secrets-file) and [update Amazon S3 bucket settings in Casc](#update-amazon-s3-bucket-settings)
 
 > [!TIP]
-> To understand the minimum required settings, refer to [Get started - Deploy](../01-getting-started/README.md#deploy).
+> The `deploy` phase can be orchestrated via the companion [Makefile](../../Makefile).
 
 ### 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, 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 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:
 
  - [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)
@@ -306,6 +306,9 @@ For CloudBees CI build logs:
 
 To tear down and remove the resources created in the blueprint, refer to [Amazon EKS Blueprints for Terraform - Destroy](https://aws-ia.github.io/terraform-aws-eks-blueprints/getting-started/#destroy).
 
+> [!TIP]
+> The `destroy` phase can be orchestrated via the companion [Makefile](../../Makefile).
+
 ## Additional resources
 
 The following videos provide more insights regarding the capabilities presented in this blueprint: