Consolidate dockerfiles and add docs for development

This will reduce the number of files that need to be managed and dependencies that need updated at the same time.

Author: yachub

.github/dependabot.yml

@@ -1,35 +1,13 @@
 version: 2
 updates:
-# /docker/dev folder
 - package-ecosystem: docker
-  directory: "/docker/dev/"
+  directory: "/docker/"
   schedule:
-    interval: daily
-    time: "13:00"
+    interval: weekly
   open-pull-requests-limit: 10
-# /docker/prod-all-providers folder
+
 - package-ecosystem: bundler
-  directory: "/docker/prod-all-providers/"
+  directory: "/docker/"
   schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
-- package-ecosystem: docker
-  directory: "/docker/prod-all-providers/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
-# /docker/test-all-providers folder
-- package-ecosystem: bundler
-  directory: "/docker/test-all-providers/"
-  schedule:
-    interval: daily
-    time: "13:00"
-  open-pull-requests-limit: 10
-- package-ecosystem: docker
-  directory: "/docker/test-all-providers/"
-  schedule:
-    interval: daily
-    time: "13:00"
+    interval: weekly
   open-pull-requests-limit: 10

.gitignore

@@ -3,3 +3,6 @@
 .vagrant/
 .idea/
 helm-charts/vmpooler/charts/
+/docker/data/redis/**
+!docker/data/**/*.yaml
+!docker/data/**/.gitkeep

README.md

@@ -1,14 +1,35 @@
 # vmpooler-deployment
 
+- [vmpooler-deployment](#vmpooler-deployment)
+  - [VMPooler Components](#vmpooler-components)
+  - [Docker Registry](#docker-registry)
+  - [Helm Repository](#helm-repository)
+    - [Adding / updating charts](#adding--updating-charts)
+  - [Development](#development)
+    - [Docker Compose URLs](#docker-compose-urls)
+    - [Deploy Chart for Testing](#deploy-chart-for-testing)
+  - [Releasing](#releasing)
+  - [Contributing](#contributing)
+  - [License](#license)
+
 This repo contains Dockerfiles and a Helm chart that can be used to deploy [VMPooler](https://github.com/puppetlabs/vmpooler). The Release Engineering team at Puppet uses the code here as part of operating our VMPooler instances.
 
+## VMPooler Components
+
+The docker image gnerated and hosted by this project contain the following VMPooler components:
+
+- [VMPooler Core](https://github.com/puppetlabs/vmpooler)
+- [VMPooler EC2 Provider](https://github.com/puppetlabs/vmpooler-provider-ec2)
+- [VMPooler GCE Provider](https://github.com/puppetlabs/vmpooler-provider-gce)
+- [VMPooler vSphere Provider](https://github.com/puppetlabs/vmpooler-provider-vsphere)
+
 ## Docker Registry
 
 The GitHub Actions in this repository publish images to GitHub Packages. You can browse the VMPooler containers [here](https://github.com/puppetlabs/vmpooler-deployment/pkgs/container/vmpooler-deployment%2Fvmpooler).
 
-Containers are organized using image tags:
+The vmpooler officially released docker image tags use a semantic version, where the version increments correlate to the increments in any of the gems at `docker/Gemfile`.
 
-- `x.y.z-prod-all-providers` represents images built using the Dockerfile in `docker/prod-all-providers`. These images use the Gemfile in the same directory to pull in current versions of the `vmpooler` gem and the gems for all known production-grade providers.
+Image tags starting with `pr<PULL REQUEST NUMBER>-<GIT SHA>` are generated when opening and pushing to a pull request and will periodically be cleaned up.
 
 ## Helm Repository
 
@@ -21,14 +42,74 @@ $ helm repo add vmpooler-deployment https://puppetlabs.github.io/vmpooler-deploy
 
 ### Adding / updating charts
 
-```bash
-cd docs/
-helm package ../helm-charts/*
-helm repo index --url https://puppetlabs.github.io/vmpooler-deployment/ .
-git add .
-cd ..
-git commit -a
-```
+Make the desired changes to the helm chart in helm-charts/vmpooler and run `./update-chart`.
+
+## Development
+
+Prerequisites:
+
+- [Docker](https://docs.docker.com/engine/install/)
+- [Docker Compose](https://docs.docker.com/compose/install/)
+
+1. Become familiar with the configuration file `docker/vmpooler.yaml` as described in [VMPooler](https://github.com/puppetlabs/vmpooler) Core.
+   - The default configuration file only enables the dummy provider built into [VMPooler](https://github.com/puppetlabs/vmpooler) Core. See each project below for documentation on how to use provider specific options:
+      - [vmpooler-provider-ec2](https://github.com/puppetlabs/vmpooler-provider-ec2)
+      - [vmpooler-provider-gce](https://github.com/puppetlabs/vmpooler-provider-gce)
+      - [vmpooler-provider-vsphere](https://github.com/puppetlabs/vmpooler-provider-vsphere)
+2. Chose a Development method:
+   - Develop via local source:
+      1. Clone all of the known vmpooler projects listed at [vmpooler-components](#vmpooler-components) under a common directory, for example:
+
+           ```bash
+           |-- vmpooler-projects
+           |  |--vmpooler-deployment
+           |  |--vmpooler-provider-ec2
+           |  |--vmpooler-provider-gce
+           |  |--vmpooler-provider-vsphere
+           ```
+
+      2. From the `vmpooler-projects` directory run `docker build -t vmpooler-local -f vmpooler-deployment/docker/Dockerfile.local .`
+      3. Run `docker compose -f vmpooler-deployment/docker/docker-compose.local.yml up`
+
+   - Develop via Git source:
+      1. For the component(s) you are developing on, commit and push changes to a branch.
+      2. Change to the `docker` directory and modify the `Gemfile` as needed to pull the gem(s) from your git branch.
+      3. Run `./update-gemfile-lock` to update the `Gemfile.lock`
+      4. Run `docker compose build && docker compose up`.
+
+When a dependency Helm chart is updated, be sure to run `./update-chart-lock` to update the lockfile, otherwise the test and release workflows will fail.
+
+### Docker Compose URLs
+
+These are the default ports used in the docker compose file, to change them edit the `ports` key under the desired service in either `docker/docker-compose.yml` or `docker/docker-compose.local.yml`.
+
+| App/Endpoint       | Path                                                        |
+|--------------------|-------------------------------------------------------------|
+| Redis Server       | `localhost:6379` (Password: `vmpooler`)                     |
+| Redis Commander    | <http://localhost:8080> (Credentials: `admin:admin`)        |
+| Jaeger             | <http://localhost:8081>
+| VMPooler API       | <http://localhost:8082/api/v2>                              |
+| VMPooler Dashboard | <http://localhost:8082/dashboard>                           |
+| Metrics (API)      | <http://localhost:8082/prometheus>                          |
+| Metrics (Manager)  | <http://localhost:8083/prometheus>                          |
+
+### Deploy Chart for Testing
+
+Helm charts are hosted with GitHub Pages since GitHub Packages does not support Helm, so you will need to build the chart locally and push the chart to your own helm repository. Follow these steps to generate a chart to host internally:
+
+1. Update the "appVersion" key in `helm-charts/vmpooler/Chart.yaml` to the docker image tag that was generated by opening a pull request.
+2. Update the "version" key to a pre-release tag, something like "x.y.z-rc.1", then run `./build-chart` to build the chart locally, and upload it to your desired location.
+
+## Releasing
+
+Create a GitHub tag and release, publish a new docker image, and helm chart by opening a release prep pull request and running the release action:
+
+1. Bump the "appVersion" key in `helm-charts/vmpooler/Chart.yaml` appropriately based on changes to `docker/Gemfile` abd `docker/Gemfile.lock` in merged pull requests since the last release.
+2. Bump the "version" key in `helm-charts/vmpooler/Chart.yaml` appropriately based on changes to the chart itself and increments of the "appVersion" in merged pull requests since the last release.
+3. Run `./update-changelog` to update `CHANGELOG.md`.
+4. Commit and push changes to a new branch, then open a pull request against `main` and be sure to add the "maintenance" label.
+5. After the pull request is approved and merged, then navigate to Actions --> Docker and Helm Release --> run workflow --> Branch: main --> Run workflow.
+   - This action will push a tagged docker image to the GitHub container registry and helm chart to GitHub pages.
 
 ## Contributing
 

build-chart.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+docker run --rm -it -v $(pwd):/apps --entrypoint /bin/sh alpine/helm \
+  -c 'helm repo add bitnami https://charts.bitnami.com/bitnami && cd /apps/helm-charts/vmpooler && helm dependency update && cd /apps/docs && helm package ../helm-charts/* && helm repo index --url https://puppetlabs.github.io/vmpooler-deployment/ .'

docker/.dockerignore

@@ -0,0 +1,6 @@
+# Exclude everything by default; explicitly include necessary files
+*
+!Gemfile
+!Gemfile.lock
+!Gemfile.local
+!docker-entrypoint.sh

docker/prod-all-providers/Dockerfile renamed to docker/Dockerfile

@@ -8,7 +8,7 @@
 # RUN:
 #   docker run -e VMPOOLER_CONFIG -p 80:4567 -it vmpooler
 
-FROM jruby:9.3.6-jdk
+FROM amd64/jruby:9.3.6-jdk
 
 LABEL org.opencontainers.image.description "VMPooler plus all known providers"
 
@@ -23,8 +23,7 @@ RUN apt-get update -qq && \
     apt-get autoremove -y && \
     rm -rf /var/lib/apt/lists/*
 
-RUN gem install bundler && \
-    gem update --system 3.2.3
+RUN gem install bundler
 
 COPY ./docker-entrypoint.sh /usr/local/bin/
 

docker/Dockerfile.local

@@ -0,0 +1,43 @@
+# For local development of vmpooler core and provider gems instead of using a
+# git source ensure the following directory structure:
+# |-- vmpooler-projects
+# |  |--vmpooler-deployment
+# |  |--vmpooler-provider-ec2
+# |  |--vmpooler-provider-gce
+# |  |--vmpooler-provider-vsphere
+#
+# Then change directory into vmpooler-projects and build with: 
+
+
+FROM amd64/jruby:9.3.6-jdk
+
+LABEL org.opencontainers.image.description "VMPooler plus all known providers"
+
+ENV DEBIAN_FRONTEND=noninteractive
+ENV LOGFILE=/dev/stdout
+ENV RACK_ENV=production
+
+RUN apt-get update -qq && \
+    apt-get upgrade -y && \
+    apt-get install -y --no-install-recommends make git netbase && \
+    apt-get clean autoclean && \
+    apt-get autoremove -y && \
+    rm -rf /var/lib/apt/lists/*
+
+COPY vmpooler /opt/vmpooler
+COPY vmpooler-provider-ec2 /opt/vmpooler-provider-ec2
+COPY vmpooler-provider-gce /opt/vmpooler-provider-gce
+COPY vmpooler-provider-vsphere /opt/vmpooler-provider-vsphere
+
+RUN gem install bundler
+
+COPY vmpooler-deployment/docker/docker-entrypoint.sh /usr/local/bin/
+
+RUN chmod +x /usr/local/bin/docker-entrypoint.sh
+
+COPY vmpooler-deployment/docker/Gemfile.local ./Gemfile
+
+RUN bundle config set --local jobs 3 && \
+    bundle install
+
+ENTRYPOINT ["docker-entrypoint.sh"]

docker/Gemfile

@@ -0,0 +1,12 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'vmpooler',                    '~> 2.4'
+gem 'vmpooler-provider-ec2',       '~> 0.0.1'
+gem 'vmpooler-provider-gce',       '~> 0.4'
+gem 'vmpooler-provider-vsphere',   '~> 1.6'
+
+# For development install via a git branch use something like:
+# gem 'vmpooler', git: 'https://github.com/puppetlabs/vmpooler.git', branch: 'my-feature'
+# gem 'vmpooler-provider-ec2', git: 'https://github.com/puppetlabs/vmpooler-provider-ec2.git', branch: 'my-feature'
+# gem 'vmpooler-provider-gce', git: 'https://github.com/puppetlabs/vmpooler-provider-gce.git', branch: 'my-feature'
+# gem 'vmpooler-provider-vsphere', git: 'https://github.com/puppetlabs/vmpooler-provider-vsphere.git', branch: 'my-feature'

docker/Gemfile.local

@@ -0,0 +1,6 @@
+source ENV['GEM_SOURCE'] || 'https://rubygems.org'
+
+gem 'vmpooler', path: '/opt/vmpooler'
+gem 'vmpooler-provider-ec2', path: '/opt/vmpooler-provider-ec2'
+gem 'vmpooler-provider-gce', path: '/opt/vmpooler-provider-gce'
+gem 'vmpooler-provider-vsphere', path: '/opt/vmpooler-provider-vsphere'