Merge https://github.com/cisagov/skeleton-docker into lineage/skeleton

# Conflicts: # README.md # compose.yml
cisagov · Feb 7, 2025 · 183b7f1 · 183b7f1
2 parents 3454986 + eafe720
commit 183b7f1
Show file tree

Hide file tree

Showing 5 changed files with 66 additions and 30 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -419,16 +419,14 @@ jobs:
           path: ${{ env.BUILDX_CACHE_DIR }}
           restore-keys: |
             ${{ env.BASE_CACHE_KEY }}
-      - name: Create cross-platform support Dockerfile-x
-        run: ./buildx-dockerfile.sh
       - name: Build and push platform images to registries
         id: docker_build
         uses: docker/build-push-action@v6
         with:
           cache-from: type=local,src=${{ env.BUILDX_CACHE_DIR }}
           cache-to: type=local,dest=${{ env.BUILDX_CACHE_DIR }}
           context: .
-          file: ./Dockerfile-x
+          file: ./Dockerfile
           labels: ${{ needs.prepare.outputs.labels }}
           platforms: |
             linux/amd64

diff --git a/README.md b/README.md
@@ -31,11 +31,11 @@ docker run cisagov/example:0.2.0
 
 ### Running with Docker Compose ###
 
-1. Create a `docker-compose.yml` file similar to the one below to use [Docker Compose](https://docs.docker.com/compose/).
+1. Create a `compose.yml` file similar to the one below to use [Docker Compose](https://docs.docker.com/compose/).
 
     ```yaml
     ---
-    version: "3.7"
+    name: skeleton-docker
 
     secrets:
       credentials:
@@ -49,6 +49,7 @@ docker run cisagov/example:0.2.0
         restart: "no"
 =======
       example:
+<<<<<<< HEAD
         image: cisagov/example:0.2.0
         volumes:
           - type: bind
@@ -63,6 +64,19 @@ docker run cisagov/example:0.2.0
         secrets:
           - source: credentials
             target: credentials
+=======
+        environment:
+          - ECHO_MESSAGE="Hello from docker compose"
+        image: cisagov/example:0.2.0
+        ports:
+          - protocol: tcp
+            published: "8080"
+            target: 8080
+        volumes:
+          - source: <your_log_dir>
+            target: /var/log
+            type: bind
+>>>>>>> eafe720594319b9503bd5e6d7e5b59e61ff9d6d5
     ```
 
 #### Issue a new certificate ####
@@ -141,11 +155,11 @@ want set:
     credential_source = Ec2InstanceMetadata
     ```
 
-1. Then add the secret to your `docker-compose.yml` file:
+1. Then add the secret to your `compose.yml` file:
 
     ```yaml
     ---
-    version: "3.7"
+    name: skeleton-docker
 
     secrets:
       credentials:
@@ -159,6 +173,7 @@ want set:
         restart: "no"
 =======
       example:
+<<<<<<< HEAD
         image: cisagov/example:0.2.0
         volumes:
           - type: bind
@@ -173,6 +188,22 @@ want set:
         secrets:
           - source: credentials
             target: credentials
+=======
+        environment:
+          - ECHO_MESSAGE="Hello from docker compose"
+        image: cisagov/example:0.2.0
+        ports:
+          - protocol: tcp
+            published: "8080"
+            target: 8080
+        secrets:
+          - source: quote_txt
+            target: quote.txt
+        volumes:
+          - source: <your_log_dir>
+            target: /var/log
+            type: bind
+>>>>>>> eafe720594319b9503bd5e6d7e5b59e61ff9d6d5
     ```
 
 ## Updating your container ##
@@ -249,9 +280,9 @@ If you want to add or remove dependencies you would update the `src/Pipfile` fil
 and then update dependencies as you would above.
 
 > [!NOTE]
-> You should only specify packages that are explicitly needed for your Docker
-> configuration. Allow [Pipenv] to manage the dependencies of the specified
-> packages.
+> You should only specify packages that are direct requirements of
+> your Docker configuration. Allow [Pipenv] to manage the dependencies
+> of the specified packages.
 
 ## Image tags ##
 
@@ -290,8 +321,15 @@ There are no exposed ports.
 <!--
 | Port | Purpose        |
 |------|----------------|
+<<<<<<< HEAD
 | PORT_NUMBER | Describe its purpose. |
 -->
+=======
+| 8080 | Example only; nothing is actually listening on the port |
+
+The sample [Docker composition](compose.yml) publishes the
+exposed port at 8080.
+>>>>>>> eafe720594319b9503bd5e6d7e5b59e61ff9d6d5
 
 ## Environment variables ##
 

diff --git a/buildx-dockerfile.sh b/buildx-dockerfile.sh
diff --git a/docker-compose.yml → compose.yml b/docker-compose.yml → compose.yml
@@ -1,8 +1,8 @@
 ---
-version: "3.7"
-
 # This Docker composition file is used to build and test the container
 
+name: skeleton-docker
+
 secrets:
   credentials:
     file: ./src/secrets/credentials
@@ -15,9 +15,12 @@ services:
       # e.g., --build-arg VERSION=0.0.1
       context: .
       dockerfile: Dockerfile
+<<<<<<< HEAD:docker-compose.yml
     image: cisagov/certboto
     init: true
     restart: "no"
+=======
+>>>>>>> eafe720594319b9503bd5e6d7e5b59e61ff9d6d5:compose.yml
     environment:
 <<<<<<< HEAD
       - AWS_DEFAULT_REGION=us-east-1
@@ -26,19 +29,30 @@ services:
       - DNS_PROFILE=dns-role
 =======
       - ECHO_MESSAGE=Hello World from docker compose!
+    image: cisagov/example
+    init: true
     ports:
-      - target: 8421
-        published: 8421
+      - mode: host
         protocol: tcp
+<<<<<<< HEAD:docker-compose.yml
         mode: host
 >>>>>>> 0d48ebd47a28a887868ea3093e675e95f3843561
+=======
+        published: "8421"
+        target: 8421
+    restart: "no"
+>>>>>>> eafe720594319b9503bd5e6d7e5b59e61ff9d6d5:compose.yml
     secrets:
       - source: credentials
         target: credentials
 
   certboto-version:
     # Run the container to collect version information
+<<<<<<< HEAD:docker-compose.yml
     image: cisagov/certboto
+=======
+    command: --version
+    image: cisagov/example
+>>>>>>> eafe720594319b9503bd5e6d7e5b59e61ff9d6d5:compose.yml
     init: true
     restart: "no"
-    command: --version
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,4 +1,5 @@
 --requirement requirements-test.txt
 ipython
 pipenv
+# The bump-version script requires at least version 3 of semver.
 semver>=3