Rename and add documentation to kubernetes configuration and dockerfi…

…les (#11450) changelog: Internal, Documentation, Clarify usage of kubernetes configurations and files
18F · Nov 4, 2024 · 301bfdb · 301bfdb
1 parent 92165a1
commit 301bfdb
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 3 deletions.
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -177,7 +177,7 @@ build-idp-image:
     - >-
       /kaniko/executor
       --context "${CI_PROJECT_DIR}"
-      --dockerfile "${CI_PROJECT_DIR}/dockerfiles/idp_prod.Dockerfile"
+      --dockerfile "${CI_PROJECT_DIR}/dockerfiles/idp_deploy.Dockerfile"
       --destination "${ECR_REGISTRY}/identity-idp/idp:${CI_COMMIT_SHA}"
       ${BRANCH_TAGGING_STRING}
       --cache-repo="${ECR_REGISTRY}/identity-idp/idp/cache"

diff --git a/config/application.yml.default.prod → config/application.yml.default.k8s_deploy b/config/application.yml.default.prod → config/application.yml.default.k8s_deploy
diff --git a/config/application.yml.default.docker → config/application.yml.default.review_app b/config/application.yml.default.docker → config/application.yml.default.review_app
diff --git a/dockerfiles/idp_prod.Dockerfile → dockerfiles/idp_deploy.Dockerfile b/dockerfiles/idp_prod.Dockerfile → dockerfiles/idp_deploy.Dockerfile
@@ -1,4 +1,6 @@
 #########################################################################
+# This is a "production-ready" image build for the IDP that is suitable
+# for deployment.
 # This is a multi-stage build.  This stage just builds and downloads
 # gems and yarn stuff and large files.  We have it so that we can
 # avoid having build-essential and the large-files token be in the
@@ -103,7 +105,7 @@ COPY keys.example $RAILS_ROOT/keys
 COPY public/ban-robots.txt $RAILS_ROOT/public/robots.txt
 
 # Copy application.yml.default to application.yml
-COPY ./config/application.yml.default.prod $RAILS_ROOT/config/application.yml
+COPY ./config/application.yml.default.k8s_deploy $RAILS_ROOT/config/application.yml
 
 # Precompile assets
 RUN SKIP_YARN_INSTALL=true bundle exec rake assets:precompile && rm -r node_modules/ && rm -r .yarn-cache/

diff --git a/dockerfiles/idp_prod.Dockerfile.dockerignore → ...rfiles/idp_deploy.Dockerfile.dockerignore b/dockerfiles/idp_prod.Dockerfile.dockerignore → ...rfiles/idp_deploy.Dockerfile.dockerignore
diff --git a/dockerfiles/idp_review_app.Dockerfile b/dockerfiles/idp_review_app.Dockerfile
@@ -130,7 +130,7 @@ COPY --chown=app:app pwned_passwords/pwned_passwords.txt.sample $RAILS_ROOT/pwne
 COPY --chown=app:app public/ban-robots.txt $RAILS_ROOT/public/robots.txt
 
 # Copy application.yml.default to application.yml
-COPY --chown=app:app ./config/application.yml.default.docker $RAILS_ROOT/config/application.yml
+COPY --chown=app:app ./config/application.yml.default.review_app $RAILS_ROOT/config/application.yml
 
 # Setup config files
 COPY --chown=app:app config/agencies.localdev.yml $RAILS_ROOT/config/agencies.yml