Running the service as a container

You can run the DevOps service Catalogor the Orchestrator we provide as a docker image. This allows you to quickly spin up the service without having to install any dependencies.

While this allows for most of the same functionality as running it as a binary, it does have some limitations. Because this works as a container, it will not be able to interact with the host machine, so you will not be able to manage the host machine or the virtual machines running on it. You will however be able to manage the Orchestrator and Catalog services making this perfect for running in a cluster environment.

Prerequisites

Running the DevOps Service

for a quick start the DevOps service you can run:

docker run -d --name pd-devops-service -p 5570:80 -e ROOT_PASSWORD=VeryStr0ngPassw0rd -e API_PORT=8080 -e MODE=orchestrator cjlapao/prl-devops-service:latest

This will start the service and you will be able to access the swagger ui at http://localhost:5570/swagger/index.html

You can pass any of the configuration options as environment variables to the docker container.

for example:

docker run -d -p 8008:80 --name pd-devops-service -e API_PORT=8008 -e LOG_LEVEL=DEBUG cjlapao/prl-devops-service:latest

This will start the service on port 8008 and with the log level set to DEBUG.

Docker Compose

We also provide supoort for docker-compose to make it easier to manage the service. you can create a docker-compose.yaml file with the following content:

version: '3.9'
name: api
services:
  api:
    build: .
    ports:
      - "8008:80"
    environment:
      HMAC_SECRET: ''
      LOG_LEVEL: 'info'
      SECURITY_PRIVATE_KEY: ''
      TLS_ENABLED: 'false'
      TLS_PORT: '447'
      TLS_CERTIFICATE: ''
      TLS_PRIVATE_KEY: ''
      API_PORT: '80'
      API_PREFIX: '/api'
      ROOT_PASSWORD: ''
      DISABLE_CATALOG_CACHING: 'false'
      TOKEN_DURATION_MINUTES: 60
      MODE: api
      USE_ORCHESTRATOR_RESOURCES: 'false'

Once you have the docker-compose.yaml file you can start the service by running:

docker-compose up -d

This will start the service and you will be able to access the swagger ui at http://localhost:8080/swagger/index.html