WIP

Author: justin808

.controlplane/controlplane.yml

@@ -1,10 +1,19 @@
-# Configuration for "Heroku to CPLN playbook" custom scripts
+# Configuration for `cpl` commands.
+
+# Keys beginning with "cpln_" correspond to your settings in Control Plane.
+
+# Global settings that apply to `cpl` usage.
+# You can opt out of allowing the use of CPLN_ORG and CPLN_APP env vars
+# to avoid any accidents with the wrong org / app.
+allow_org_override_by_env: true
+allow_app_override_by_env: true
+
 aliases:
   common: &common
-    # Org for staging and QA apps is typically set as an alias
+    # Org for staging and QA apps is typically set as an alias, shared by all apps, except for production apps.
     # Production apps will use a different org than staging for security.
     # Change this value to your org name
-    # or set ENV value to CPLN_ORG as that will override whatever is used here for all cpl commands
+    # or set ENV CPLN_ORG to your org name as that will override whatever is used here for all cpl commands
     # cpln_org: shakacode-open-source-examples
 
     # Example apps use only location. CPLN offers the ability to use multiple locations.
@@ -25,11 +34,15 @@ aliases:
 apps:
   react-webpack-rails-tutorial:
     <<: *common
-  tutorial-app:
+    # Don't allow overriding the org and app by ENV vars b/c production is sensitive!
+    allow_org_override_by_env: false
+    allow_app_override_by_env: false
+  react-webpack-rails-tutorial-staging:
     <<: *common
   # QA Apps are like Heroku review apps, but the use `prefix` so you can run a commmand like
   # this to create a QA app for the tutorial app.
-  # `cpl setup gvc postgres redis rails -a qa-tutorial-app-pr-1234`
-  qa-tutorial-app:
+  # `cpl setup gvc postgres redis rails -a qa-react-webpack-rails-tutorial-pr-1234`
+  qa-react-webpack-rails-tutorial:
     <<: *common
+    # Prefix is used to identify these "qa" apps.
     prefix: true

.controlplane/readme.md

@@ -12,7 +12,8 @@ You can see the definition of Postgres and Redis in the `.controlplane/templates
 
 1. Ensure your [Control Plane](https://controlplane.com) account is set up.
 You should have an `organization` `<your-org>` for testing in that account.
-You will modify value for `aliases.common.cpln_org` in `.controlplane/controlplane.yml`.
+Set ENV variable `CPLN_ORG` to `<your-org>`. Alternatively, you may modify the 
+value for `aliases.common.cpln_org` in `.controlplane/controlplane.yml`.
 If you need an organization, please [contact Shakacode](mailto:[email protected]).
 
 2. Install Control Plane CLI (and configure access) using `npm install -g @controlplane/cli`.
@@ -58,10 +59,10 @@ and not `cpln` which is the Control Plane CLI.
 
 ```sh
 # Use environment variable to prevent repetition
-export APP_NAME=tutorial-app
+export APP_NAME=react-webpack-rails-tutorial
 
 # Provision all infrastructure on Control Plane.
-# app tutorial-app will be created per definition in .controlplane/controlplane.yml
+# app react-webpack-rails-tutorial will be created per definition in .controlplane/controlplane.yml
 cpl apply-template gvc postgres redis rails daily-task -a $APP_NAME
 
 # Build and push docker image to Control Plane repository
@@ -83,11 +84,11 @@ cpl open -a $APP_NAME
 
 ### Promoting code updates
 
-After committing code, you will update your deployment of `tutorial-app` with the following commands:
+After committing code, you will update your deployment of `react-webpack-rails-tutorial` with the following commands:
 
 ```sh
-# Assuming you have already set APP_NAME env variable to tutorial-app
-# Build and push new image with sequential image tagging, e.g. 'tutorial-app:1', then 'tutorial-app:2', etc.
+# Assuming you have already set APP_NAME env variable to react-webpack-rails-tutorial
+# Build and push new image with sequential image tagging, e.g. 'react-webpack-rails-tutorial:1', then 'react-webpack-rails-tutorial:2', etc.
 cpl build-image -a $APP_NAME
 
 # Run database migrations (or other release tasks) with latest image,
@@ -102,7 +103,7 @@ cpl deploy-image -a $APP_NAME
 If you needed to push a new image with a specific commit SHA, you can run the following command:
 
 ```sh
-# Build and push with sequential image tagging and commit SHA, e.g. 'tutorial-app:123_ABCD'
+# Build and push with sequential image tagging and commit SHA, e.g. 'react-webpack-rails-tutorial:123_ABCD'
 cpl build-image -a $APP_NAME --commit ABCD
 ```
 

.github/workflows/deploy-to-control-plane.yml

@@ -17,7 +17,7 @@ env:
   CPLN_TOKEN: ${{secrets.CPLN_TOKEN}}
 
 jobs:
-  deploy-to-control-plane:
+  deploy-to-control-plane-staging:
     runs-on: ubuntu-latest
 
     steps:
@@ -55,8 +55,8 @@ jobs:
       - name: cpl build-image
         run: |
           cpln image docker-login
-          cpl build-image -a ${{ secrets.APP_NAME_STAGING }} --commit ${{steps.vars.outputs.sha_short}}
+          cpl build-image -a ${{ secrets.APP_NAME_STAGING }} --commit ${{steps.vars.outputs.sha_short}} --org ${{secrets.CPLN_ORG_STAGING}} 
 
       - name: Deploy to Control Plane
         run: |
-          cpl deploy-image -a ${{ secrets.APP_NAME_STAGING }} 
+          cpl deploy-image -a ${{ secrets.APP_NAME_STAGING }} --org ${{secrets.CPLN_ORG_STAGING}}