Remove set-cbci-location, add doctoc

Author: sboardwell

.pre-commit-config.yaml

@@ -2,6 +2,13 @@
 
 fail_fast: false
 repos:
+- repo: https://github.com/thlorenz/doctoc
+  rev: v2.2.0
+  hooks:
+  - id: doctoc
+    args:
+    - -u
+
 - repo: https://github.com/tcort/markdown-link-check
   rev: v3.13.7
   hooks:

CONTRIBUTING.md

@@ -1,12 +1,42 @@
 # Contribute
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+- [Design principles](#design-principles)
+  - [Changing the default repo and branch](#changing-the-default-repo-and-branch)
+- [Release process](#release-process)
+- [Report bugs and feature requests](#report-bugs-and-feature-requests)
+- [Contribute via pull requests](#contribute-via-pull-requests)
+  - [Pre-commits: Linting, formatting and secrets scanning](#pre-commits-linting-formatting-and-secrets-scanning)
+  - [Blueprint Terraform CI pipeline](#blueprint-terraform-ci-pipeline)
+    - [Prerequisites](#prerequisites)
+- [Release](#release)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 This document provides guidelines for contributing to the CloudBees CI add-on for Amazon EKS blueprints.
 
 ## 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/).
-- The blueprints use a monorepo configuration to ensure that all the components are versioned together. In a production environment, it would be expected to have a single repository for the blueprints, and another repositories for the CloudBees CI configuration as code (CasC) bundles and shared libraries (see [At scale blueprint](blueprints/02-at-scale)). This approach is managed using [Spare Checkouts](https://github.blog/open-source/git/bring-your-monorepo-down-to-size-with-sparse-checkout/).
-  - The make target `CBCI_REPO=https://github.com/example-org/example-repo.git CBCI_BRANCH=new-feat make set-cbci-location` makes possible to switch between branches when you are making updates to the CasC bundles or shared libraries.
+- The blueprints use a monorepo configuration to ensure that all the components are versioned together.
+- In a production environment, it would be expected to have a single repository for the blueprints, and another repositories for the CloudBees CI configuration as code (CasC) bundles and shared libraries (see [At scale blueprint](blueprints/02-at-scale)).
+- This monorepo approach is managed using [Spare Checkouts](https://github.blog/open-source/git/bring-your-monorepo-down-to-size-with-sparse-checkout/).
+
+### Changing the default repo and branch
+
+The following variables found in the [./variables.tf](./variables.tf) make it possible to switch between branches when you are making updates to the CasC bundles or shared libraries.
+
+```sh
+# Optional variables in order to use a different repository and/or branch for CasC and configuration
+# oc_casc_scm_repo_url = "https://github.com/cloudbees-oss/terraform-aws-cloudbees-ci-eks-addon.git"
+# oc_casc_scm_branch    = "develop"
+# oc_casc_scm_bundle_path = "blueprints/02-at-scale/cbci/casc/oc"
+# oc_casc_scm_polling_interval = "PT2M"
+# cbci_casc_path_controller = "blueprints/02-at-scale/cbci/casc/mc"
+# cbci_casc_path_shared_library = "blueprints/02-at-scale/cbci/shared-lib"
+```
 
 ## Release process
 
@@ -64,7 +94,7 @@ To submit a pull request:
 7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 > [!IMPORTANT]
-> If you make updates to embedded repository (for example, CasC bundles), you must push the changes to the public upstream (repository/branch) before running `terraform apply` locally. The endpoint and/or branch can be updated via `set-casc-location` from the companion [Makefile](blueprints/Makefile).
+> If you make updates to embedded repository (for example, CasC bundles), you must push the changes to the public upstream (repository/branch) before running `terraform apply` locally. The endpoint and/or branch can be updated via the terraform variables mentioned in [Changing the default repo and branch](#changing-the-default-repo-and-branch).
 
 ### Pre-commits: Linting, formatting and secrets scanning
 

README.md

@@ -75,7 +75,7 @@ The two main components of CloudBees CI - the operations center and managed cont
 - Amazon EBS volumes are scoped to a particular availability zone to offer high-speed, low-latency access to the Amazon Elastic Compute Cloud (Amazon EC2) instances they are connected to. If an availability zone fails, an Amazon EBS volume becomes inaccessible due to file corruption, or there is a service outage, the data on these volumes becomes inaccessible. The operations center and managed controller pods require this persistent data and have no mechanism to replicate the data, so CloudBees recommends frequent backups for Amazon EBS.
 - Amazon EFS file systems are scoped to an AWS region and can be accessed from any availability zone in the region that the file system was created in. Using Amazon EFS as a storage class for the operations center and managed controllers allows pods to be rescheduled successfully onto healthy nodes in the event of an availability zone outage. Amazon EFS is more expensive than Amazon EBS, but provides greater fault tolerance.
 
-> [!IMPORTANT]  
+> [!IMPORTANT]
 > CloudBees CI High Availability (HA) (active-active) requires Amazon EFS. For more information, refer to [CloudBees CI EKS storage requirements](https://docs.cloudbees.com/docs/cloudbees-ci/latest/eks-install-guide/eks-pre-install-requirements-helm#_storage_requirements).
 
 > [!NOTE]

blueprints/02-at-scale/.auto.tfvars.example

@@ -19,6 +19,15 @@ dh_reg_secret_auth = { # Required.
 #   "cb-purpose" : "demo-env"
 # }
 
+# Optional variables in order to use a different repository and/or branch for CasC and configuration
+# oc_casc_scm_repo_url = "https://github.com/cloudbees-oss/terraform-aws-cloudbees-ci-eks-addon.git"
+# oc_casc_scm_branch    = "develop"
+# oc_casc_scm_bundle_path = "blueprints/02-at-scale/cbci/casc/oc"
+# oc_casc_scm_polling_interval = "PT2M"
+# cbci_casc_path_controller = "blueprints/02-at-scale/cbci/casc/mc"
+# cbci_casc_path_shared_library = "blueprints/02-at-scale/cbci/shared-lib"
+
+
 # suffix = my-demo #Optional
 
 # aws_region = "us-west-2" #Optional

blueprints/Makefile

@@ -78,12 +78,6 @@ set-kube-env: agentCheck
 	@$(call helpers,set-kube-env)
 	@$(call helpers,INFO "Setting Kube environment finished succesfully.")
 
-.PHONY: set-cbci-location
-set-cbci-location: ## Update cbci folder location per parameter. Example: CBCI_REPO=https://github.com/cloudbees/terraform-aws-cloudbees-ci-eks-addon.git CBCI_BRANCH=new-feat make set-cbci-location
-set-cbci-location: agentCheck guard-CBCI_REPO guard-CBCI_BRANCH
-	@$(call helpers,set-cbci-location $(CBCI_REPO) $(CBCI_BRANCH))
-	@$(call helpers,INFO "Setting new Casc location to $(CBCI_REPO) $(CBCI_BRANCH) finished succesfully.")
-
 .PHONY: zip-all-casc-bundles
 zip-all-casc-bundles: ## Creates a zip file containing all cbci casc bundles from 02 At scale. Example: make zip-all-casc-bundles
 zip-all-casc-bundles: agentCheck

blueprints/helpers.sh

@@ -276,21 +276,6 @@ set-kube-env () {
   done
 }
 
-set-cbci-location () {
-  local repo="$1"
-  local branch="$2"
-  #Repo
-  sed -i "s|scmRepo: .*|scmRepo: \"$repo\"|g" "$SCRIPTDIR/02-at-scale/k8s/cbci-values.yml"
-  sed -i "s|scmCascMmStore: .*|scmCascMmStore: \"$repo\"|g" "$SCRIPTDIR/02-at-scale/cbci/casc/oc/variables.yaml"
-  sed -i "s|sharedLibRepo: .*|sharedLibRepo: \"$repo\"|g" "$SCRIPTDIR/02-at-scale/cbci/casc/mc/mc-ha/variables.yaml"
-  sed -i "s|sharedLibRepo: .*|sharedLibRepo: \"$repo\"|g" "$SCRIPTDIR/02-at-scale/cbci/casc/mc/mc-none-ha/variables.yaml"
-  #Branch
-  sed -i "s|scmBranch: .*|scmBranch: $branch|g" "$SCRIPTDIR/02-at-scale/k8s/cbci-values.yml"
-  sed -i "s|cascBranch: .*|cascBranch: $branch|g" "$SCRIPTDIR/02-at-scale/cbci/casc/oc/variables.yaml"
-  sed -i "s|sharedLibBranch: .*|sharedLibBranch: $branch|g" "$SCRIPTDIR/02-at-scale/cbci/casc/mc/mc-ha/variables.yaml"
-  sed -i "s|sharedLibBranch: .*|sharedLibBranch: $branch|g" "$SCRIPTDIR/02-at-scale/cbci/casc/mc/mc-none-ha/variables.yaml"
-}
-
 zip-all-casc-bundles () {
   branch=$(git rev-parse --abbrev-ref HEAD)
   cbciDirInput="$SCRIPTDIR/02-at-scale/cbci"