Remove deploy -f by introducing project_init.bash

Also make some script IF conditions more mac-friendly. PiperOrigin-RevId: 294295136 Change-Id: I9032c0acddc737af6db7800355c0b3dbf65889c1
GoogleCloudPlatform · Feb 10, 2020 · 9434ef3 · 9434ef3
1 parent 324b139
commit 9434ef3
Show file tree

Hide file tree

Showing 4 changed files with 170 additions and 127 deletions.
diff --git a/deploy.bash b/deploy.bash
@@ -27,7 +27,6 @@ SERVICE_NAMES=("_ic_" "_dam_" "_personas_" "_icdemo_" "_damdemo_")
 ENV=""
 unset PROMPT
 unset BYPASS_BUILD
-unset FAST_DEPLOY
 unset CONFIG_ONLY
 
 print_usage() {
@@ -36,7 +35,6 @@ print_usage() {
   echo -e ${RED?}'  -c \t config generation only'${RESET?}
   echo -e ${RED?}'  -e \t extra environment namespace to include in the deployed service name'${RESET?}
   echo -e ${RED?}'     \t example: "deploy -e staging dam ic" will deploy services as "dam-staging", "ic-staging"'${RESET?}
-  echo -e ${RED?}'  -f \t fast deploy will skip project initialization and service dependency setup'${RESET?}
   echo -e ${RED?}'  -h \t show this help usage'${RESET?}
   echo -e ${RED?}'  -i \t interactive prompts to proceed between steps'${RESET?}
   echo -e ${RED?}'  -p \t GCP project_id to deploy to'${RESET?}
@@ -52,7 +50,7 @@ ARGS=("$@")
 DEPLOY=()
 unset SKIP_ARG
 for arg in "${ARGS[@]}"; do
-  if [[ -v SKIP_ARG ]]; then
+  if [[ "${SKIP_ARG}" != "" ]]; then
     # previous was a flag and this is that flag's string argument
     unset SKIP_ARG
   elif [[ $arg == -* ]]; then
@@ -75,12 +73,11 @@ if [[ "${#DEPLOY[@]}" == "0" ]]; then
   DEPLOY=("${SERVICE_NAMES[@]}")
 fi
 
-while getopts ':bce:fhip:' flag; do
+while getopts ':bce:hip:' flag; do
   case "${flag}" in
     b) BYPASS_BUILD='true' ;;
     c) CONFIG_ONLY='true' ;;
     e) ENV="-${OPTARG}" ;;
-    f) FAST_DEPLOY='true' ;;
     h) print_usage
        exit 1 ;;
     i) PROMPT='true' ;;
@@ -91,7 +88,7 @@ while getopts ':bce:fhip:' flag; do
   esac
 done
 
-if [[ -z "${PROJECT}" ]]; then
+if [[ "${PROJECT}" == "" ]]; then
   echo -e ${RED?}'Must provide a project via $PROJECT or -p project'${RESET?}
   print_usage
   exit 1
@@ -109,22 +106,21 @@ deploy_service() {
 # Export the id of your project to environment variable PROJECT.
 echo -e ${GREEN?}'Starting deployment to project: '${PROJECT?}${RESET?}
 gcloud config set project ${PROJECT?}
-export PROJECT_NUMBER=$(gcloud projects list --filter="${PROJECT?}" --format="value(PROJECT_NUMBER)")
 
 # Generate the config files
-if [[ -v IC_CONFIG ]]; then
-  echo -e ${GREEN?}'Using the provided IC_CONFIG files at: '${IC_CONFIG?}${RESET?}
-else
+if [[ "${IC_CONFIG}" == "" ]]; then
   echo -e ${GREEN?}'Generating the default IC config files.'${RESET?}
   echo -e ${GREEN?}'To use your own configs instead, set environment variable "IC_CONFIG" to point to your config folders.'${RESET?}
-fi
-if [[ -v DAM_CONFIG ]]; then
-  echo -e ${GREEN?}'Using the provided DAM_CONFIG file at: '${DAM_CONFIG?}${RESET?}
 else
+  echo -e ${GREEN?}'Using the provided IC_CONFIG files at: '${IC_CONFIG?}${RESET?}
+fi
+if [[ "${DAM_CONFIG}" == "" ]]; then
   echo -e ${GREEN?}'Generating the default DAM config files.'${RESET?}
   echo -e ${GREEN?}'To use your own configs instead, set environment variable "DAM_CONFIG" to point to your config folders.'${RESET?}
+else
+  echo -e ${GREEN?}'Using the provided DAM_CONFIG file at: '${DAM_CONFIG?}${RESET?}
 fi
-if [[ -v PROMPT ]]; then
+if [[ "$PROMPT" != "" ]]; then
   echo -e ${GREEN?}'PRESS ENTER TO CONTINUE...'${RESET?}
   read
 fi
@@ -133,16 +129,16 @@ fi
 mkdir -p ./deploy/config/ic/
 mkdir -p ./deploy/config/dam/
 
-if [ -v IC_CONFIG ]; then
-  cp -R $IC_CONFIG/* ./deploy/config/ic/
-else
+if [[ "${IC_CONFIG}" == "" ]]; then
   cp -R ./deploy/config/ic-template/* ./deploy/config/ic/
+else
+  cp -R $IC_CONFIG/* ./deploy/config/ic/
 fi
 
-if [ -v DAM_CONFIG ]; then
-  cp -R $DAM_CONFIG/* ./deploy/config/dam/
-else
+if [[ "${DAM_CONFIG}" == "" ]]; then
   cp -R ./deploy/config/dam-template/* ./deploy/config/dam/
+else
+  cp -R $DAM_CONFIG/* ./deploy/config/dam/
 fi
 
 sed -i 's/${YOUR_PROJECT_ID}/'${PROJECT?}'/g' ./deploy/config/ic/config_master_main_latest.json
@@ -173,96 +169,15 @@ sed -i 's/${YOUR_ENVIRONMENT}/'${ENV?}'/g' ./deploy/build/icdemo/icdemo.yaml
 sed -i 's/${YOUR_ENVIRONMENT}/'${ENV?}'/g' ./deploy/build/dam/dam.yaml
 sed -i 's/${YOUR_ENVIRONMENT}/'${ENV?}'/g' ./deploy/build/damdemo/damdemo.yaml
 
-if [[ -v CONFIG_ONLY ]]; then
+if [[ "${CONFIG_ONLY}" != "" ]]; then
   echo -e ${GREEN?}'CONFIG_ONLY flag is set. Skipping all other steps.'${RESET?}
   exit 0
 fi
 
-if [[ -v FAST_DEPLOY ]]; then
-  echo -e ${GREEN?}'FAST_DEPLOY flag is set. Skipping preparing the GCP project for deployment.'${RESET?}
-else
-  echo -e ${GREEN?}'Preparing the GCP project for deployment. To skip, set "FAST_DEPLOY" flag -f.'${RESET?}
-  # Enbable the required APIs.
-  echo -e ${GREEN?}'Enabling the required APIs.'${RESET?}
-
-  gcloud services enable \
-    appengine.googleapis.com \
-    appengineflex.googleapis.com \
-    appenginestandard.googleapis.com \
-    sql-component.googleapis.com \
-    sqladmin.googleapis.com \
-    datastore.googleapis.com \
-    iam.googleapis.com \
-    cloudbuild.googleapis.com \
-    bigquery.googleapis.com \
-    storage-component.googleapis.com \
-    cloudkms.googleapis.com
-
-  # Create a GAE app.
-  gcloud app create --region=us-central
-
-  # Grant the required permissions.
-  echo -e ${GREEN?}'Granting the required permissions.'${RESET?}
-
-  gcloud projects add-iam-policy-binding -q ${PROJECT?} \
-    --member serviceAccount:${PROJECT?}@appspot.gserviceaccount.com --role roles/cloudkms.cryptoKeyEncrypterDecrypter
-  gcloud projects add-iam-policy-binding -q ${PROJECT?} \
-    --member serviceAccount:${PROJECT?}@appspot.gserviceaccount.com --role roles/iam.serviceAccountTokenCreator
-
-  gcloud projects add-iam-policy-binding -q ${PROJECT?} \
-    --member serviceAccount:service-${PROJECT_NUMBER?}@gae-api-prod.google.com.iam.gserviceaccount.com --role roles/cloudsql.client
-  gcloud projects add-iam-policy-binding -q ${PROJECT?} \
-    --member serviceAccount:service-${PROJECT_NUMBER?}@gae-api-prod.google.com.iam.gserviceaccount.com --role roles/editor
-  gcloud projects add-iam-policy-binding -q ${PROJECT?} \
-    --member serviceAccount:service-${PROJECT_NUMBER?}@gae-api-prod.google.com.iam.gserviceaccount.com --role roles/resourcemanager.projectIamAdmin
-
-  # TODO: make region configurable.
-
-  # Setup Cloud SQL
-  # Create a CloudSQL db-f1-micro (memory=128M, disk=250G) postgres 11 instance in us-central-1.
-  echo -e ${GREEN?}'Creating Cloud SQL database for Hydra.'${RESET?}
-
-  gcloud sql instances create hydra --database-version=POSTGRES_11 \
-    --tier=db-f1-micro --region=us-central1
-  # Create user: name="${NAME}", password="${PASSWORD}"
-  gcloud sql users create hydra --instance=hydra --password=hydra
-  # Create database ic
-  gcloud sql databases create ic --instance=hydra
-  # Create database dam
-  gcloud sql databases create dam --instance=hydra
-
-  echo -e ${GREEN?}'Creating a GCS bucket with an example file.'${RESET?}
-
-  gsutil mb gs://${PROJECT?}-test-dataset
-  tempdir=`mktemp -d`
-  pushd $tempdir
-  echo "This is an example" > example.txt
-  gsutil cp example.txt gs://${PROJECT?}-test-dataset
-  popd
-  rm -rf $tempdir
-
-  # Deploy a simple defaut app to GAE default service.
-  echo -e ${GREEN?}'Deploy a helloworld to GAE default service.'${RESET?}
-
-  tempdir=`mktemp -d`
-  pushd $tempdir
-  git clone https://github.com/GoogleCloudPlatform/golang-samples.git
-  pushd golang-samples/appengine/go11x/helloworld
-  gcloud -q app deploy .
-  popd
-  popd
-  rm -rf $tempdir
-
-  echo -e ${GREEN?}'Building Base Hydra Docker Image.'${RESET?}
-  gcloud builds submit --config deploy/build/hydra/cloudbuild.yaml .
-fi
-
 # Build the Personas, IC, ICDEMO, DAM, and DAMDEMO images
-if [[ -v BYPASS_BUILD ]]; then
-  echo -e ${GREEN?}'BYPASS_BUILD flag is set. Bypassing the building of Docker images for the services.'${RESET?}
-else
+if [[ "${BYPASS_BUILD}" == "" ]]; then
   echo -e ${GREEN?}'Building Docker images for the services.'${RESET?}
-  if [[ -v PROMPT ]]; then
+  if [[ "$PROMPT" != "" ]]; then
     echo -e ${GREEN?}'PRESS ENTER TO CONTINUE...'${RESET?}
     read
   fi
@@ -291,11 +206,13 @@ else
     echo -e ${GREEN?}'Building DAMDEMO Docker Image.'${RESET?}
     gcloud builds submit --config deploy/build/damdemo/cloudbuild.yaml .
   fi
+else
+  echo -e ${GREEN?}'BYPASS_BUILD flag is set. Bypassing the building of Docker images for the services.'${RESET?}
 fi
 
 # Deploy Services
 echo -e ${GREEN?}'Deploying services to the GCP project.'${RESET?}
-if [[ -v PROMPT ]]; then
+if [[ "${PROMPT}" != "" ]]; then
   echo -e ${GREEN?}'PRESS ENTER TO CONTINUE...'${RESET?}
   read
 fi

diff --git a/deploy.md b/deploy.md
@@ -45,10 +45,17 @@ To create a Google Cloud project, do the following:
 
 1.  Create a GCP project using the GCP Developer Console.
 
+1.  Learn about Project Initialization [here](#project-initialization). When
+    ready, run:
+
+    ```
+    ./project_init.bash -p <gcp-project-id>
+    ```
+
 1.  Run the following setup script to deploy components with default settings
     that can be tested:
 
-        ```bash
+        ```
         export PROJECT=<gcp-project-id>
         ./deploy.bash
         ```
@@ -95,14 +102,14 @@ In a browser, open `https://icdemo-dot-${YOUR_PROJECT_ID}.appspot.com/test` and
 For example, `deploy.bash -e staging -p my-project` would create an `icdemo`
 page of: `https://icdemo-staging-dot-my-project.appspot.com/test`.
 
-## Fast deploy mode
+## Project Initialization
 
-Fast deploy mode is available in `deploy.bash` using the `-f` flag as a means
-to bypass setting up the federated access service dependencies within a project.
-Fast deploy may not be appropriate for production environments, and should be
-reviewed carefully before attempting to use it on production binaries.
+**Warning**: The project initialization may not be appropriate for production
+environments, and should be reviewed carefully before attempting to use it for a
+production environment.
 
-Fast deploy skips steps such as:
+Project initialization prepares a GCP project to host Federated Access services.
+For example, it initializes or enables the following:
 
 *  enabling gcloud services on the project
 *  setting up Google App Engine (GAE) to deploy services within a given region
@@ -115,34 +122,27 @@ Fast deploy skips steps such as:
    etc.)
 *  ... and potentially more items as well
 
-If any dependencies change with these underlying services, then `-f` should
-not be used. In this way, a rebuild of the underlying services can attempt to
-deploy these changes. Examples include:
+If any dependencies change with these underlying services, then project
+initialization will need to be performed again. In this way, a rebuild of the
+underlying services can attempt to deploy these changes. Examples include:
 
 *  changes to usernames and passwords of databases
 *  deploying to different regions or using other underlying services to deploy
 *  Hydra binary or configuation changes
 *  permission changes
 *  etc.
 
-However, this flag exists because many non-prod deployments may have regular
-roll outs without affecting the underlying services, and in such cases the use
-of `-f` can speed up the deployment time.
-
-**tip:** if your deployment environment does not match your expectations and
-it was deployed using `-f`, then you may wish to deploy again without `-f`
-to see if a rebuild of your environment fixes the problem.
-
-**warning:** use this flag with care in production environments, or even
-consider removing it from your production deployment script all together.
+**Tip:** if over time your deployment environment does not match your
+expectations and it was deployed using `project_init.bash`, then you may wish
+run `project_init.bash` again to see if a rebuild of your environment fixes the
+problem.
 
 ## Environment variables for the deploy script
 
 It may be useful to create a wrapper script to control some settings to
 `deploy.bash`. Here is an example `my_deploy.bash`:
 
 ```
-export CUSTOM_CONFIG_DIR=/<path-to-my-configs>
 export PROJECT=<my-gcp-project>
 export DAM_CONFIG=${CUSTOM_CONFIG_DIR?}/dam
 export IC_CONFIG=${CUSTOM_CONFIG_DIR?}/ic