Merge pull request #424 from CodeForPhilly/issue-#421

Update to docs with references to new deployment process

Author: MooseQuest

docs/SUMMARY.md

@@ -9,7 +9,8 @@
   - [Data Analysis](contributing/data-analysis.md)
   - [Operations Support](contributing/operations-support.md)
 - Operations
-  - [Release Process](./operations/release-process.md)
+  - [Preparing a new release](./operations/prepare-new-chime-release.md)
+  - [Release Process](./operations/release=process.md)
   - [The `chime-live` Cluster](./operations/chime-live-cluster.md)
   - [Deploy to Heroku](./operations/heroku.md)
   - [Deploy with Chef Habitat](./operations/habitat.md)

docs/operations/chime-live-cluster.md

@@ -28,89 +28,4 @@
 
     ```bash
     kubectl get pod --all-namespaces
-    ```
-
-## Deploying a New CHIME Version
-
-1. [Create a new release](release-process.md)
-2. Wait for the `Docker` GitHub Actions workflow to complete
-3. Verify the new version shows up at the top as "Latest version" here: https://github.com/CodeForPhilly/chime/packages/155340
-4. Open a new issue on GitHub titled "Deploy chime $VERSION" (ex: https://github.com/CodeForPhilly/chime/issues/98)
-  * Note the PR in which the release was approved
-  * Confirm that the tag for the version was created
-5. Create a local branch (based on "develop") to perform deploy time changed on, named "deploy/$VERSION"
-
-    ```bash
-    VERSION=1.2.3
-    git rev-parse --abbrev-ref HEAD
-    # develop
-    git pull
-    git checkout -b deploy/$VERSION
-    ```
-
-6. Update the app.yaml manifest file
-
-    ```bash
-    VERSION=1.2.3
-    sed -Ei "s/(- image: .*):(.*)/\1:$VERSION/" k8s/app.yaml
-    git add -A
-    # verify changes are as expected
-    git diff --staged
-    git commit -m "Deploy chime $VERSION"
-    ```
-
-7. Push changes
-
-    ```bash
-    VERSION=1.2.3
-    git push -u origin deploy/$VERSION
-    ```
-
-8. Open PR on GitHub to merge changes back into develop, ideally with
- the review of another DevOps admin whenever possible. Ensure to link
- to the PR in the deployment issue previously opened on GitHub.
-
-9. Run:
-
-    ```bash
-    kubectl apply -f k8s/app.yaml
-    ```
-
-10. Watch rollout status:
-
-    ```bash
-    kubectl -n chime rollout status deployment.v1.apps/chime
-    ```
-
-11. Confirm the expected version is running
-
-    ```bash
-    kubectl -n chime get deployment chime -o yaml | grep image:
-    #  - image: docker.pkg.github.com/codeforphilly/chime/penn-chime:$VERSION
-    ```
-
-12. Paste the output from steps 11 & 12 into the previously opened deployment issue
- to document the successful deployment and close the issue
-13. $$$ PROFIT $$$
-
-## Applying Changes to `k8s/` Manifests
-
-After making changes to the manifests in `k8s/` that you want to apply, first review the diff for what you're about to change using an editor that wil color-code the output and make it easy to review:
-
-```bash
-kubectl diff -Rf k8s/ | code -
-```
-
-*Ignore any instances of `generation` being incremented*
-
-Once you're satisfied with the results of the diff, you can apply a single manifest:
-
-```bash
-kubectl apply -f k8s/infra/ingress-nginx.yaml
-```
-
-Or the entire directory:
-
-```bash
-kubectl apply -Rf k8s/
-```
+    ```

docs/operations/prepare-new-chime-release.md

@@ -0,0 +1,40 @@
+# Operations: Prepare New Chime Release
+
+At the end of following this process you will have deployed a new CHIME version to https://penn-chime.phl.io
+
+## Start Here
+
+## Prepare Chime on the Develop Branch
+
+1. Open a new issue on GitHub titled "Deploy chime $VERSION" (ex: https://github.com/CodeForPhilly/chime/issues/98)
+  * Note the PR in which the release was approved
+  * Confirm that the tag for the version was created
+2. Create a local branch (based on "develop") to perform deploy time changed on, named "deploy/$VERSION"
+
+    ```bash
+    export VERSION=x.x.x #set this to the release version you are releasing. (export VERSION=1.1.1 for version 1.1.1)
+    git checkout develop
+    git pull
+    git checkout -b deploy/$VERSION # this will ultimately create a branch deploy/1.1.1 (from the reference above)
+    ```
+
+3. Update the app.yaml manifest file using an editor. You will need to change the line that has: ```- image: docker.pkg.github.com/codeforphilly/chime/penn-chime:<insert versions here>```
+    * After that is complete, update your branch.
+
+    ```bash
+    git add k8s/app.yml
+    git diff --staged
+    git commit -m "Deploy chime $VERSION"
+    ```
+
+4. Push changes
+
+    ```bash
+    git push -u origin deploy/$VERSION
+    ```
+
+5. [Open PR on GitHub](https://github.com/CodeForPhilly/chime/compare) to merge changes back into develop, ideally with
+ the review of another DevOps admin whenever possible. Ensure to link
+ to the PR in the deployment issue previously opened on GitHub.
+
+6. One approved you will need to [create a release to auto deploy](release-process.md)

docs/operations/release-process.md

@@ -1,9 +1,6 @@
 # Operations: Release Process
 
-1. Merge pull requests into `develop`
-2. Chose a new version number by incrementing the previous release according to [semver](https://semver.org/)
-   - Do not bump the MAJOR version unless the team is ready to create a new `releases/v#` branch
-3. Open a pull request to merge `develop` into `releases/v1`
+1. Open a pull request to merge `develop` into `releases/v1`
    - **Title**: `Release: CHIME v1.#.#`
    - **Description**: Generate with this command:
 
@@ -21,5 +18,4 @@
 6. [Create a new release against `releases/v1`](https://github.com/CodeForPhilly/chime/releases/new?target=releases/v1)
    - **Tag version:** `v1.#.#`
    - **Release Title:** `CHIME v1.#.#`
-   - **Description:** Copy release notes from pull request
-7. [Deploy to the `chime-live` cluster](chime-live-cluster.md)
+   - **Description:** Copy release notes from pull request