Deploying the DRP Docker image - Adaptive Applications - BlueCat Gateway - 3.0.0

Device Registration Portal

prodname
BlueCat Gateway
version_custom
3.0.0

Before you start

When you first install DRP v3.0.0, BlueCat recommends performing the following:

  • Mount logs and config volume
    • When running the docker run command, you can:
      • Mount the logs directory of the container into a Docker volume (recommended) or in a directory in your host machine.
    • Give appropriate permission:
      • To set permissions to external volumes, run the following command:
        chmod -R o=rwx <mapped volume>
    • Mount the portal/bluecat_portal/workflows/drp_workflow/configs/ directory of the container into a Docker volume.
      docker volume create <config_volume>
      docker volume ls 
Tip: BlueCat advises all customers to map a Docker data volume and a Docker logs volume to save data from BlueCat Gateway. This is the recommended best practice for the Docker container. However, if you prefer to mount data and log directories to your local machine, you must manually set rwx (read, write, execute) permissions to those directories before running the container. If you do not map data or logs directories to your local machine during installation, BlueCat Gateway will write all the data to the container by default. If you then stop or restart the container, all this data will be lost.
Note:
  • You can name the logs directory to anything.
  • BlueCat Gateway saves all execution and session logs to the mapped logs directory. If you do not map a logs directory, all the logging data is written to the container by default.

The custom BlueCat Gateway Docker image is delivered as a tar file (.tar), and it must be obtained from BlueCat Customer Care. Once obtained, copy the tar file to your host machine and use the ‘docker load’ command to install the image.

To install custom BlueCat Gateway from Customer Care:

  1. Download the drp_build.zip file from BlueCat Customer Care.
  2. Copy the file to the BlueCat Gateway host machine.
  3. From the Linux console of the BlueCat Gateway host machine, run the following command:
    docker load -i <path_to_image_tar_file>
  4. Starting the container:
    1. Run the following command to set passcode:
      docker run -d \
      -p 80:8000 \
      -p 443:44300 \
      -v <path_to_mapped_log_directory>:/logs/ \
      -v <configs_volume>:/portal/bluecat_portal/workflows/drp_workflow/configs \
      -e BAM_IP=<your_bam_ip_address> \
      -e DRP_PASSCODE=<your_passcode> \
      --name <your_container_name> <image_name>:<tag_name>
      Note: In case you don't provide DRP_PASSCODE or provide an empty string, the passcode falls back to default one `passcode`.
    2. Access to DRP Gateway configuration page:
      1. Open a browser.
      2. In the address bar, enter the DRP address with the passcode as a query parameter. Example: http://172.0.0.10?code=<your_passcode>
      3. Enter your credentials (Username: drp_admin, Password: ) and click Login.
      Note:
      • A passcode is configured to access the DRP Workflow for configuration and Gateway administration.
      • Accessing the URL without a passcode always takes you to the DRP client Authentication page.
    3. Run the “docker container ls” command to see the currently running Docker containers. Make sure the DRP container is on the list.
      Note: You'll be redirected to the DRP client page if you don't provide or provide a wrong passcode.

Passcode usage

  • BlueCat highly recommends changing the passcode and not leave it as default.