syntaqx · December 2, 2024 05:40 · Dec 2, 2024 · Dec 2, 2024
diff --git a/1.md b/1.md
@@ -1,12 +1,16 @@
-Follow these instructions to prepare your existing Heroku app for Docker-based deployment.
+# Setting Up Your Heroku App for Docker-Based Deployment
+
+Follow these instructions to prepare your Heroku app for Docker-based deployment.
+
+---
 
 ## Step 1: Open Your Terminal and Navigate to Your Code
 
 - Open a terminal.
 - Move into your project directory. For example:
 
 ```sh
-cd ~/Code/example/raffle
+cd ~/Code/example/api
 ```
 
 Confirm you’re in the right place by listing the files:
@@ -15,7 +19,9 @@ Confirm you’re in the right place by listing the files:
 ls
 ```
 
-You should see your Dockerfile and Python app files here.
+You should see your `Dockerfile` and Python app files here.
+
+---
 
 ## Step 2: Log In to Heroku
 
@@ -25,6 +31,8 @@ Authenticate with the Heroku CLI:
 heroku login
 ```
 
+---
+
 ## Step 3: Install the Heroku Container Plugin
 
 Ensure the Heroku CLI is ready for Docker-based deployments by installing the required plugin:
@@ -33,48 +41,97 @@ Ensure the Heroku CLI is ready for Docker-based deployments by installing the re
 heroku plugins:install @heroku-cli/plugin-container-registry
 ```
 
-### Step 4: Link Your Repository to the Existing Heroku App
+---
+
+## Step 4: Create or Link Your Heroku App
+
+### If the app doesn’t exist, create it:
+
+Replace `example-api` with the name you want for your app:
+
+```sh
+heroku create example-api
+```
 
-If the Heroku app already exists, link it to your local repository. Replace example-api with the name of your Heroku app:
+### If the app already exists, link it to your local repository:
+Replace `example-api` with the name of your Heroku app:
 
 ```sh
 heroku git:remote -a example-api
 ```
 
-### Step 5: Clear Any Existing Buildpacks
+---
 
-Since we are deploying with Docker, you must clear any buildpacks set for the Heroku app:
+## Step 5: Clear Any Existing Buildpacks
 
-```
+Since we are deploying with Docker, clear any buildpacks set for the Heroku app:
+
+```sh
 heroku buildpacks:clear --app example-api
 ```
 
-### Step 6: Log In to Heroku Container Registry
+---
+
+## Step 6: Log In to Heroku Container Registry
 
 Authenticate Docker with Heroku’s container registry:
 
-```
+```sh
 heroku container:login
 ```
 
-### Step 7: Configure Environment Variables
+---
+
+## Step 7: Configure Environment Variables
 
 Set environment variables required for your Python app. Replace placeholder values with actual data:
 
 ```sh
+heroku config:set FLASK_ENV=production --app example-api
 heroku config:set MONGO_URI=mongodb+srv://<username>:<password>@cluster.example.com/dbname --app example-api
 heroku config:set ADMIN_USERNAME=admin --app example-api
 heroku config:set ADMIN_PASSWORD=securepassword --app example-api
-heroku config:set FLASK_ENV=production --app example-api
 ```
 
+---
+
 ## Step 8: Scale the Dynos
-Make sure the app has at least one dyno running for the web process:
+
+Make sure the app has at least one dyno running for the `web` process:
 
 ```sh
 heroku ps:scale web=1 --app example-api
 ```
 
+---
+
+## Step 9: Build and Tag Your Docker Image Locally
+
+Before pushing the image to Heroku, build it locally and tag it for the Heroku container registry:
+
+```
+docker build -t registry.heroku.com/example-api/web .
+```
+
+---
+
+## Step 10: Push Your Docker Build to Heroku
+
+Push the Docker image to Heroku and release it to confirm that the app is live:
+
+```
+heroku container:push web --app example-api
+heroku container:release web --app example-api
+```
+
+---
+
 ## Setup Complete
-Your Heroku app is now ready to accept Docker-based deployments.
-You don’t need to deploy locally; the GitHub Actions workflow will handle everything when you push to the main branch.
+
+Your Heroku app is now configured for Docker-based deployments. You’ve also pushed a build to Heroku to confirm everything is working. Going forward, you can automate this process using GitHub Actions.
+
+---
+
+## Example GitHub Workflows for Future Automation
+
+To automate deployments, consider the following example workflows
diff --git a/deploy-heroku-only.md → deploy-heroku-only.yml b/deploy-heroku-only.md → deploy-heroku-only.yml
diff --git a/1.md b/1.md
@@ -0,0 +1,80 @@
+Follow these instructions to prepare your existing Heroku app for Docker-based deployment.
+
+## Step 1: Open Your Terminal and Navigate to Your Code
+
+- Open a terminal.
+- Move into your project directory. For example:
+
+```sh
+cd ~/Code/example/raffle
+```
+
+Confirm you’re in the right place by listing the files:
+
+```sh
+ls
+```
+
+You should see your Dockerfile and Python app files here.
+
+## Step 2: Log In to Heroku
+
+Authenticate with the Heroku CLI:
+
+```sh
+heroku login
+```
+
+## Step 3: Install the Heroku Container Plugin
+
+Ensure the Heroku CLI is ready for Docker-based deployments by installing the required plugin:
+
+```sh
+heroku plugins:install @heroku-cli/plugin-container-registry
+```
+
+### Step 4: Link Your Repository to the Existing Heroku App
+
+If the Heroku app already exists, link it to your local repository. Replace example-api with the name of your Heroku app:
+
+```sh
+heroku git:remote -a example-api
+```
+
+### Step 5: Clear Any Existing Buildpacks
+
+Since we are deploying with Docker, you must clear any buildpacks set for the Heroku app:
+
+```
+heroku buildpacks:clear --app example-api
+```
+
+### Step 6: Log In to Heroku Container Registry
+
+Authenticate Docker with Heroku’s container registry:
+
+```
+heroku container:login
+```
+
+### Step 7: Configure Environment Variables
+
+Set environment variables required for your Python app. Replace placeholder values with actual data:
+
+```sh
+heroku config:set MONGO_URI=mongodb+srv://<username>:<password>@cluster.example.com/dbname --app example-api
+heroku config:set ADMIN_USERNAME=admin --app example-api
+heroku config:set ADMIN_PASSWORD=securepassword --app example-api
+heroku config:set FLASK_ENV=production --app example-api
+```
+
+## Step 8: Scale the Dynos
+Make sure the app has at least one dyno running for the web process:
+
+```sh
+heroku ps:scale web=1 --app example-api
+```
+
+## Setup Complete
+Your Heroku app is now ready to accept Docker-based deployments.
+You don’t need to deploy locally; the GitHub Actions workflow will handle everything when you push to the main branch.
diff --git a/deploy-dockerhub.yml b/deploy-dockerhub.yml
@@ -0,0 +1,85 @@
+name: Docker CI
+
+on:
+  push:
+    branches:
+      - main # Trigger only on the main branch
+
+env:
+  DOCKERHUB_IMAGE: example/api
+  HEROKU_APP_NAME: example-api
+  HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Step 1: Check out the repository
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Step 2: Generate metadata for Docker images
+    - name: Docker meta
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: |
+          ${{ env.DOCKERHUB_IMAGE }}
+        tags: |
+          type=ref,event=branch
+          type=sha
+        flavor: |
+          latest=auto
+          prefix=
+          suffix=
+
+    # Step 3: Set up QEMU for cross-platform builds
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+
+    # Step 4: Set up Docker Buildx
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    # Step 5: Log in to Docker Hub
+    - name: Login to Docker Hub
+      uses: docker/login-action@v3
+      with:
+        username: ${{ secrets.DOCKERHUB_USERNAME }}
+        password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+    # Step 6: Sign into the Heroku Container Registry
+    - name: Sign into the Heroku Container Registry
+      run: heroku container:login
+
+    # Step 7: Build and push Docker images to both Docker Hub and Heroku with caching
+    - name: Build and push
+      uses: docker/build-push-action@v6
+      with:
+        context: .
+        platforms: linux/amd64,linux/arm64
+        push: true
+        cache-from: type=registry,ref=${{ env.DOCKERHUB_IMAGE }}:buildcache
+        cache-to: type=registry,ref=${{ env.DOCKERHUB_IMAGE }}:buildcache,mode=max
+        tags: |
+          ${{ steps.meta.outputs.tags }}
+          registry.heroku.com/${{ env.HEROKU_APP_NAME }}/web
+        labels: ${{ steps.meta.outputs.labels }}
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' # Only deploy on the main branch
+    environment:
+      name: production
+      url: https://api.example.org/
+
+    steps:
+    # Step 1: Sign into the Heroku Container Registry
+    - name: Sign into the Heroku Container Registry
+      run: heroku container:login
+
+    # Step 2: Release the image on Heroku
+    - name: Release to Heroku
+      run: heroku container:release web --app ${{ env.HEROKU_APP_NAME }}
diff --git a/deploy-heroku-only.md b/deploy-heroku-only.md
@@ -0,0 +1,72 @@
+name: Docker CI
+
+on:
+  push:
+    branches:
+      - main # Trigger only on the main branch
+
+env:
+  HEROKU_APP_NAME: example-api
+  HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    # Step 1: Check out the repository
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    # Step 2: Generate metadata for Docker images
+    - name: Docker meta
+      id: meta
+      uses: docker/metadata-action@v5
+      with:
+        images: registry.heroku.com/${{ env.HEROKU_APP_NAME }}/web
+        tags: |
+          type=ref,event=branch
+          type=sha
+        flavor: |
+          latest=auto
+          prefix=
+          suffix=
+
+    # Step 3: Set up QEMU for cross-platform builds
+    - name: Set up QEMU
+      uses: docker/setup-qemu-action@v3
+
+    # Step 4: Set up Docker Buildx
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    # Step 5: Sign into the Heroku Container Registry
+    - name: Sign into the Heroku Container Registry
+      run: heroku container:login
+
+    # Step 6: Build and push the Docker image to Heroku
+    - name: Build and push
+      uses: docker/build-push-action@v6
+      with:
+        context: .
+        platforms: linux/amd64,linux/arm64
+        push: true
+        tags: ${{ steps.meta.outputs.tags }}
+        labels: ${{ steps.meta.outputs.labels }}
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main' # Only deploy on the main branch
+    environment:
+      name: production
+      url: https://api.example.org/
+
+    steps:
+    # Step 1: Sign into the Heroku Container Registry
+    - name: Sign into the Heroku Container Registry
+      run: heroku container:login
+
+    # Step 2: Release the image on Heroku
+    - name: Release to Heroku
+      run: heroku container:release web --app ${{ env.HEROKU_APP_NAME }}