Continuous Deployment via Github Actions (#402)

* Initial commit of actions deploy PoC

* Automatically pull latest tags in dockerfile

* Pull pinned version

* Lower debug threshold on ssh

* Stop all running docker instances

* Parallelize production deploy runs

* Reconcile file paths for integration and production

* Update .github/workflows/deploy-staging-ec2.yml

* Delete deploy-staging-ec2.yml

* Apply suggestions from review, differentiate branch trigger for integration

* Update integration and production release actions with user

* Update README.md

* Update file path for integration (leftover from staging job)

* Correct git pull to git fetch befor checkout

Author: Cassidy Schaufele

.github/workflows/deploy-integration-ec2.yml

@@ -0,0 +1,31 @@
+on:
+  push:
+    branches:
+      - integration
+name: Deploy Integration
+jobs:
+  deploy-integration:
+    if: github.ref == 'refs/heads/integration'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install SSH Key
+        uses: shimataro/[email protected]
+        with:
+          key: ${{ secrets.EC2_RSA_KEY }}
+          known_hosts: ${{ secrets.EC2_KNOWN_HOSTS }}
+          name: id_rsa
+      - name: Deploy Integration to Integration
+        run: |
+          ssh -l ubuntu ${{ secrets.INTEGRATION_HOST}} -T '
+          cd docs-worker-pool
+          git fetch origin
+          git checkout origin/integration
+          sudo docker system prune
+          sudo docker build --no-cache --tag integration .
+          sudo docker stop $(sudo docker ps -a -q)
+          sudo docker build --no-cache --tag stage .
+          sudo sh rundocker.sh
+          '
+          

.github/workflows/deploy-production-ec2.yml

@@ -0,0 +1,53 @@
+on:
+  push:
+    tags:
+      - 'v*'
+name: Deploy Production
+jobs:
+  deploy-production-1:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install SSH Key
+        uses: shimataro/[email protected]
+        with:
+          key: ${{ secrets.EC2_RSA_KEY }}
+          known_hosts: ${{ secrets.EC2_KNOWN_HOSTS }}
+          name: id_rsa
+      - name: SSH to Production 1
+        run: |
+          ssh -l ubuntu ${{ secrets.PRODUCTION_HOST_1}} -T '
+          cd docker/docs-worker-pool
+          git fetch origin
+          git checkout $(git describe --tags)
+          sudo docker system prune
+          sudo docker build --no-cache --tag production .
+          sudo docker stop $(sudo docker ps -a -q)
+          sudo sh rundocker.sh
+          '
+  deploy-production-2:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Install SSH Key
+        uses: shimataro/[email protected]
+        with:
+          key: ${{ secrets.EC2_RSA_KEY }}
+          known_hosts: ${{ secrets.EC2_KNOWN_HOSTS }}
+          name: id_rsa
+      - name: SSH to Production 2
+        run: |
+          ssh -l ubuntu ${{ secrets.PRODUCTION_HOST_2}} -T '
+          cd docker/docs-worker-pool
+          git fetch origin
+          git checkout $(git describe --tags)
+          sudo docker system prune
+          sudo docker build --no-cache --tag production .
+          sudo docker stop $(sudo docker ps -a -q)
+          sudo sh rundocker.sh
+          '
+          

Dockerfile

@@ -42,14 +42,14 @@ RUN python3 -m pip install pip==20.2 flit==3.0.0
 RUN git clone https://github.com/mongodb/snooty-parser.git && \
 	cd snooty-parser && \
 	git fetch --tags && \
-	git checkout <TAG> && \
+	git checkout v0.9.6 && \
 	FLIT_ROOT_INSTALL=1 python3 -m flit install
 
 # install snooty front-end
 RUN git clone https://github.com/mongodb/snooty.git snooty
 RUN cd snooty && \
 	git fetch --all && \
-	git checkout <TAG> && \	
+	git checkout v0.9.8 && \	
 	npm install && \
 	git clone https://github.com/mongodb/docs-tools.git docs-tools && \
 	mkdir -p ./static/images && \

README.md

@@ -49,4 +49,33 @@ npm install --dev
 ./node_modules/.bin/eslint .
 ```
 
-See the [spec doc](https://docs.google.com/document/d/1XZOuuGmozcLQRSDitx0UWhZzJaS4opR1JVwZqDp-N4g/edit?usp=sharing) for more details.
+See the [spec doc](https://docs.google.com/document/d/1XZOuuGmozcLQRSDitx0UWhZzJaS4opR1JVwZqDp-N4g/edit?usp=sharing) for more details.
+
+## Branches
+Development in this repository can be done via forks or branches. Currently, we support an `integration` and `master` branch, in addition to a `meta` branch. In general, the development workflow is to open pull requests against `integration`, and to promote `integration` to `master` after testing prior to a release.
+
+In general, the git workflow within this repository loosely follows https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow .
+
+### Meta
+`Meta` contains various makefiles and .yaml files used for configuration.
+Changes or additions to/of makefiles and .yaml for publishing purposes should be performed against this branch.
+There is no general requirement to keep `Meta` up to date with `Master` or `Integration`.
+
+### Integration
+`Integration` is treated as a running feature branch that should **always** remain up to date with `master`
+
+### Master
+`Master` is treated as our production state branch. In general, pull requests to master should be opened only from integration or a hot-fix feature branch.
+If a change is merged into `Master` that is not present in `Integration`, in general, that change should be merged as well from said branch or fork into integration. 
+
+## Releasing
+docs-worker-pool contains various triggers for release to higher environments. Currently, the repository supports an integration environment (reflecting the state of the integration branch) and a production environment (reflecting the state of the most recent release tag). 
+
+### Integration
+ - Merge a pull request or otherwise push a commit to the integration branch. 
+ - Verify that the deploy-integration-ec2 workflow has executed successfully.
+
+### Production
+ - Merge outstanding changes within `integration` to `master`.
+ - Create release tags.
+ - Verify that the deploy-production-ec2 workflow executed successfully for both job runs across both production instances.