From de981e5e6e2b0594b577611adea448ddc9975d24 Mon Sep 17 00:00:00 2001 From: Elliot Date: Mon, 24 Jun 2024 09:30:32 +0000 Subject: [PATCH] Add warnings about deprecated deployment methods (jenkins, CSR for new organizations) --- 0-bootstrap/README-Jenkins.md | 2 ++ 0-bootstrap/README.md | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/0-bootstrap/README-Jenkins.md b/0-bootstrap/README-Jenkins.md index 688772522..3530cb409 100644 --- a/0-bootstrap/README-Jenkins.md +++ b/0-bootstrap/README-Jenkins.md @@ -1,3 +1,5 @@ +*Warning: the guidance for deploying with Jenkins is no longer actively tested or maintained. While we have left the guidance available for users who prefer Jenkins, we make no guarantees about its quality, and you might be responsible for troubleshooting and modifying the directions.* + # 0-bootstrap - deploying a Jenkins-compatible environment The purpose of this step is to bootstrap a GCP organization, creating all the required resources & permissions to start using the Cloud Foundation Toolkit (CFT). This step also guides you on how to configure a CI/CD project to host a Jenkins Agent, which connects to your existing Jenkins Controller infrastructure & your own Git repos (which might live on-prem). The Jenkins Agent will run [CI/CD Pipelines](../docs/GLOSSARY.md#foundation-cicd-pipeline) for foundations code in subsequent stages. diff --git a/0-bootstrap/README.md b/0-bootstrap/README.md index 9ab209815..f92ddbfe6 100644 --- a/0-bootstrap/README.md +++ b/0-bootstrap/README.md @@ -120,6 +120,8 @@ See [troubleshooting](../docs/TROUBLESHOOTING.md) if you run into issues during ## Deploying with Jenkins +*Warning: the guidance for deploying with Jenkins is no longer actively tested or maintained. While we have left the guidance available for users who prefer Jenkins, we make no guarantees about its quality, and you might be responsible for troubleshooting and modifying the directions.* + If you are using the `jenkins_bootstrap` sub-module, see [README-Jenkins](./README-Jenkins.md) for requirements and instructions on how to run the 0-bootstrap step. Using Jenkins requires a few manual steps, including configuring connectivity with @@ -145,7 +147,9 @@ Using Terraform Cloud requires manual creation of the GitHub repositories or Git ## Deploying with Cloud Build -**Note:** When deploying with cloud build is also possible to use a [script helper](../helpers/foundation-deployer/README.md) to do the deploy. +*Warning: This method has a dependency on Cloud Source Repositories, which is [no longer available to new customers](https://cloud.google.com/source-repositories/docs). If you have previously used the CSR API in your organization then you can use this method, but a newly created organization will not be able to enable CSR and cannot use this deployment method. In that case, we recommend that you follow the directions for deploying locally, Github, Gitlab, or Terraform Cloud instead.* + +The following steps introduce the steps to deploy with Cloud Build Alternatively, use the [helper script](../helpers/foundation-deployer/README.md) to automate all the stages of. Use the helper script when you want to rapidly create and destroy the entire organization for demonstration or testing purposes, without much customization at each stage. 1. Clone [terraform-example-foundation](https://github.com/terraform-google-modules/terraform-example-foundation) into your local environment and navigate to the `0-bootstrap` folder.