switch to more standard & flexible CI/CD variable. Documentation++. Some no-longer-used lines decluttered

Author: traceypooh

README.md

@@ -56,6 +56,7 @@ _**Note:** For urls like https://archive.org/services/project -- watch out for r
 ### Customizing
 There are various options that can be used in conjunction with the `project.nomad` and `.gitlab-ci.yml` files, keys:
 ```text
+NOMAD_VAR_BUILD_DEPLOY
 NOMAD_VAR_CHECK_PATH
 NOMAD_VAR_CHECK_PROTOCOL
 NOMAD_VAR_CHECK_TIMEOUT
@@ -81,12 +82,21 @@ NOMAD_VAR_VOLUMES
 - You can simply insert them, with values, in your project's `.gitlab-ci.yml` file before including _our_ [ci.yml](ci.yml) like above.
 - Examples 👇
 #### Don't actually deploy containers to nomad
-Perhaps your project just wants to leverage the CI (Continuous Integration) for [buil] and/or [test] steps - but not CD (Continuous Deployment).  An example might be a back-end container that runs elsewhere and doesn't have web listener.
+Perhaps your project just wants to leverage the CI (Continuous Integration) for [build] and/or [test] steps - but not CD (Continuous Deployment).  An example might be a back-end container that runs elsewhere and doesn't have web listener.
 ```yaml
 variables:
   NOMAD_VAR_NO_DEPLOY: 'true'
 ```
 
+#### Build one docker image for CI and one docker image for CD
+If your project might want to build & use a larger docker image for the CI (Continuous Integration)
+and a smaller docker image for CD (Continuous Deploy), you can set this variable to an alternate
+Dockerfile location in your repo, relative to the top dir.
+```yaml
+variables:
+  NOMAD_VAR_BUILD_DEPLOY: 'Dockerfile.deploy'
+```
+
 #### Custom default RAM expectations from (default) 300 MB to 1 GB
 This value is the _expected_ value for your container's average running needs/usage, helpful for `nomad` scheduling purposes.  It is a "soft limit" and we use *ten times* this amount to be the amount used for a "hard limit".  If your allocated container exceeds the hard limit, the container may be restarted by `nomad` if there is memory pressure on the Virtual Machine the container is running on.
 ```yaml
@@ -216,6 +226,16 @@ variables:
   NOMAD_VAR_NAMESPACE: 'team-titan'
 ```
 
+#### Only `docker tag` to `:latest` after all CI passes
+This is useful for repos that are setting up "serverless" docker images (typically don't do CD),
+and the `:latest` tag could get re-pulled anytime after that tag is pushed to the registry.
+The normal commit hash related tag will still get tagged & pushed, during [build], for CI tests.
+The `:latest` tag will get tagged & pushed *after* all CI tests have succeeded.
+```yaml
+variables:
+  NOMAD_VAR_SERVERLESS: 'true'
+```
+
 
 
 #### More customizations

build.sh

@@ -34,10 +34,10 @@ if [ "$NOMAD_VAR_SERVERLESS" != "" ]; then
   PUSH_LATEST=
 fi
 
-if [ "$BUILD_DEPLOY" = true ]; then
+if [ "$NOMAD_VAR_BUILD_DEPLOY" ]; then
   PUSH_LATEST=
   export CI_REGISTRY_TAG=${CI_COMMIT_SHA}-deploy
-  export DOCKERFILE_PATH=$(ls Dockerfile.deploy Containerfile.deploy Containerfile.in.deploy 2>/dev/null |head -1)
+  export DOCKERFILE_PATH=$NOMAD_VAR_BUILD_DEPLOY
 fi
 
 if [[ -z "$CI_REGISTRY_TAG" ]]; then

ci.yml

@@ -13,7 +13,7 @@
 # to whatever your Nomad cluster was setup to.
 
 
-# NOTE: changes to *this* repo, will fire of GitHub Actions here:
+# NOTE: changes to *this* repo, will fire off GitHub Actions here:
 #   https://github.com/internetarchive/nomad/blob/main/.github/workflows/cicd.yml
 # which will re/make this container image:
 image: ghcr.io/internetarchive/nomad:main
@@ -29,12 +29,9 @@ build:
   # This was adapted & simplified from:
   # https://gitlab.com/gitlab-org/gitlab/-/raw/master/lib/gitlab/ci/templates/Jobs/Build.gitlab-ci.yml
   stage: build
-  variables:
-    DOCKER_HOST: 'unix:///run/podman/podman.sock'
-    DOCKER_TLS_CERTDIR: ''
-    DOCKER_BUILDKIT: 1
   script:
     # https://github.com/internetarchive/nomad/blob/main/build.sh
+    - export NOMAD_VAR_BUILD_DEPLOY=""
     - /build.sh
   artifacts:
     reports:
@@ -48,14 +45,11 @@ build_deploy:
   stage: build
   script:
     # https://github.com/internetarchive/nomad/blob/main/build.sh
-    - export BUILD_DEPLOY=true
     - /build.sh
-
   rules:
-    - exists:
-      - Dockerfile.deploy
-      - Containerfile.deploy
-      - Containerfile.in.deploy
+    - if: '$BUILD_DISABLED'
+      when: never
+    - if: '$NOMAD_VAR_BUILD_DEPLOY && $CI_COMMIT_BRANCH'
 
 deploy:
   stage: deploy

deploy.sh

@@ -23,9 +23,10 @@ function main() {
     NOMAD_VAR_DEPLOY_WITH_PODMAN=${NOMAD_VAR_DEPLOY_WITH_PODMAN:-""}
     NOMAD_VAR_LEGACY_SERVICE_NAMES_URLPREFIX=${NOMAD_VAR_LEGACY_SERVICE_NAMES_URLPREFIX:-""}
     CI_REGISTRY_TAG=${CI_REGISTRY_TAG:-""}
+    NOMAD_VAR_BUILD_DEPLOY=${NOMAD_VAR_BUILD_DEPLOY:-""}
   fi
 
-  if [ -e Dockerfile.deploy -o -e Containerfile.deploy -o -e Containerfile.in.deploy ]; then
+  if [ "$NOMAD_VAR_BUILD_DEPLOY" ]; then
     CI_REGISTRY_TAG=${CI_COMMIT_SHA}-deploy
   else
     CI_REGISTRY_TAG=$CI_COMMIT_SHA