From 301bfdbd67995d2da6ea709016c35ba03613a4e7 Mon Sep 17 00:00:00 2001
From: Mitchell Henke <mitchell.henke@gsa.gov>
Date: Mon, 4 Nov 2024 16:55:13 -0600
Subject: [PATCH] Rename and add documentation to kubernetes configuration and
 dockerfiles (#11450)

changelog: Internal, Documentation, Clarify usage of kubernetes configurations and files
---
 .gitlab-ci.yml                                                | 2 +-
 ...on.yml.default.prod => application.yml.default.k8s_deploy} | 0
 ....yml.default.docker => application.yml.default.review_app} | 0
 dockerfiles/{idp_prod.Dockerfile => idp_deploy.Dockerfile}    | 4 +++-
 ...erfile.dockerignore => idp_deploy.Dockerfile.dockerignore} | 0
 dockerfiles/idp_review_app.Dockerfile                         | 2 +-
 6 files changed, 5 insertions(+), 3 deletions(-)
 rename config/{application.yml.default.prod => application.yml.default.k8s_deploy} (100%)
 rename config/{application.yml.default.docker => application.yml.default.review_app} (100%)
 rename dockerfiles/{idp_prod.Dockerfile => idp_deploy.Dockerfile} (98%)
 rename dockerfiles/{idp_prod.Dockerfile.dockerignore => idp_deploy.Dockerfile.dockerignore} (100%)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index c445cd7c076..7ed90ce7bfa 100644
--- 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 b/config/application.yml.default.k8s_deploy
similarity index 100%
rename from config/application.yml.default.prod
rename to config/application.yml.default.k8s_deploy
diff --git a/config/application.yml.default.docker b/config/application.yml.default.review_app
similarity index 100%
rename from config/application.yml.default.docker
rename to config/application.yml.default.review_app
diff --git a/dockerfiles/idp_prod.Dockerfile b/dockerfiles/idp_deploy.Dockerfile
similarity index 98%
rename from dockerfiles/idp_prod.Dockerfile
rename to dockerfiles/idp_deploy.Dockerfile
index 893f96d868f..9b525d3433c 100644
--- a/dockerfiles/idp_prod.Dockerfile
+++ b/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 b/dockerfiles/idp_deploy.Dockerfile.dockerignore
similarity index 100%
rename from dockerfiles/idp_prod.Dockerfile.dockerignore
rename to dockerfiles/idp_deploy.Dockerfile.dockerignore
diff --git a/dockerfiles/idp_review_app.Dockerfile b/dockerfiles/idp_review_app.Dockerfile
index 8aab8bd6afd..f868dd044c7 100644
--- 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