minor readme updates (#2335)

* minor readme updates * remove docker compose * Create architecture diagram for the `trigger-code-reference` (#2334) * use json array form to solve buildx warning about shell interpretation and OS signal handling * move description -> README; container build/tests passed locally * add tcr arc diagram * minor readme updates * remove docker compose --------- Co-authored-by: Robert Mitchell <[email protected]>
CDCgov · Aug 8, 2024 · df03e59 · df03e59
1 parent 13772e4
commit df03e59
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 3 deletions.
diff --git a/containers/tefca-viewer/docker-compose.yaml b/containers/tefca-viewer/docker-compose.yaml
@@ -1,5 +1,6 @@
 services:
   tefca-viewer:
+    platform: linux/amd64
     build:
       context: ../../
       dockerfile: ./containers/tefca-viewer/Dockerfile

diff --git a/containers/trigger-code-reference/Dockerfile b/containers/trigger-code-reference/Dockerfile
@@ -11,4 +11,4 @@ COPY ./seed-scripts /code/seed-scripts
 COPY ./README.md /code/README.md
 
 EXPOSE 8080
-CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8080"]
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8080"]
diff --git a/containers/trigger-code-reference/README.md b/containers/trigger-code-reference/README.md
@@ -43,7 +43,7 @@ To build the Docker image for the trigger code reference from source instead of
 1. Ensure that both [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker](https://docs.docker.com/get-docker/) are installed.
 2. Clone the PHDI repository with `git clone https://github.com/CDCgov/phdi`.
 3. Navigate to `/phdi/containers/trigger-code-reference/`.
-4. Run `docker build -t trigger-code-reference .`.
+4. Run `docker buildx build --platform linux/amd64 -t trigger-code-reference .`.
 
 ### The API
 

diff --git a/containers/validation/description.md b/containers/validation/description.md
@@ -38,7 +38,7 @@ To build the Docker image for the Validation service from source code instead of
 1. Ensure that both [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) and [Docker](https://docs.docker.com/get-docker/) are installed.
 2. Clone the PHDI repository with `git clone https://github.com/CDCgov/phdi`.
 3. Navigate to `/phdi/containers/validation/`.
-4. Run `docker build -t validation .`.
+4. Run `docker buildx build --platform linux/amd64 -t validation .`.
 
 ### The API