Help me understand what a production deployment looks like, especially docker image build step

cbecker333 · May 4, 2023, 9:25pm

Hi, I’m new here.

Background:
I’m trying to help get a custom domain deployment of an openremote-based custom project off the ground. I have a good understanding of the runtime components and how to execute them on my local host: i.e. successfully ran docker containers for postgres, manager, keycloak and was able to load the project in the browser.

Problem:
I’ve been browsing the wiki and it’s unclear to me what steps I should now use to build the docker image for a production deployment of the full stack, including the proxy with SSL. Can anyone help?

Thanks!

EDIT
nvm I think i found it here:

github.com

openremote/custom-project/blob/main/docker-compose.yml#L17


      
          #    OR_ADMIN_PASSWORD - Initial admin user password
          #    OR_HOSTNAME - FQDN hostname of where this instance will be exposed (localhost, IP address or public domain)
          #    DEPLOYMENT_VERSION - Tag to use for deployment image (must match the tag used when building the deployment image)
          #
          # Please see openremote/profile/deploy.yml for configuration details for each service.
          #
          # To perform updates, build code and prepare Docker images:
          #
          #   ./gradlew clean installDist
          #
          # Then recreate deployment image:
          #
          #  DEPLOYMENT_VERSION=$(git rev-parse --short HEAD)
          #  MANAGER_VERSION=$(cd openremote; git rev-parse --short HEAD; cd ..)
          #  docker build -t openremote/manager:$MANAGER_VERSION ./openremote/manager/build/install/manager/
          #  docker build -t openremote/custom-deployment:$DEPLOYMENT_VERSION ./deployment/build/
          #  docker-compose -p custom down
          #  docker volume rm custom_deployment-data
          #  Do the following volume rm command if you want a clean install (wipe all existing data)
          #  docker volume rm custom_postgresql-data
          #  OR_ADMIN_PASSWORD=secret OR_HOSTNAME=my.domain.com docker-compose -p custom up -d

Rich · June 5, 2023, 8:33pm

The proxy container will figure out if it needs to request a certificate or not based on the value supplied to OR_HOSTNAME; the server will need port 80 as well as port 443 exposed for SSL generation.

Customisation is done using an overlay technique using docker volume mappings; we build a docker volume called deployment-data which is populated by the deployment docker image (if the volume is empty i.e. when it is first created). This deployment-data is then volume mapped into the manager service at /deployment and the manager will load jars and static web content from this location automatically.

cbecker333 · June 6, 2023, 4:23pm

Thanks! I found a solution for the kubernetes-based deployment that emulates the way docker-compose handled deployment-data, so we can push customization into the stack using an initContainer:

github.com

FreeSK8/openremote-custom-deployment-digitalocean-k8s/blob/main/.ci_cd/digital_ocean/modules/cluster/web_statefulset.tf#L36


      
          name = "customize-openremote-deployment"
          image = "${var.container_registry}/openremote/custom-deployment:${var.custom_deployment_hash}"
          volume_mount {
            mount_path = "/deployment"
            name = "deployment-data"
          }
          volume_mount {
            mount_path = "/manager"
            name = "manager-data"
          }
          command = [
            "/bin/sh",
            "-c",
            <<-EOT
              cp -r /deployment-source/* /deployment/ && \
              /bin/chmod -R 700 /deployment && \
              /bin/chown -R 185 /deployment && \
              /bin/chmod -R 700 /manager && \
              /bin/chown -R 185 /manager
            EOT
          ]