Updating Docker Trusted Registry (DTR) registry


Prepare for installation by updating the env file with install config parameters and the Docker Trusted Registry (DTR) registry details.

Related topics

Before you begin

Align with the software or environment requirements. See System-requirements.

Updating the Docker Trusted Registry (DTR) registry

Before you begin

  • Make sure you download the installer script from EPDimage-2023-9-4_19-46-55.png.
  • Download the images from containers.com and set up the local DTR hub.

    Click here to view the list of images

    containers.bmc.com.bmc.com/iot/hedge-admin:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-auth-proxy:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-data-enrichment:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-device-extensions:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-device-rest:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-event-publisher:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-event:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-export:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-import-biz-data:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-kong-auth-plugin:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-meta-sync:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-ml-anomaly-inferencing:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-ml-broker:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-ml-edge-agent:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-ml-management:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-remediate:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-ui-server:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedge-user-app-mgmt:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-consul:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-core-command:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-core-metadata:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-ekuiper:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-mosquitto:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-node-red:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-postgres:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-redis:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-security-bootstrapper:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-security-secretstore-setup:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-support-notifications:25.1.00_GA
    containers.bmc.com.bmc.com/iot/hedgext-vault:25.1.00_GA

Updating DTR registry details

Update the DTR registry details to make sure accuracy and alignment with installation requirements.

  1. To update the DTR registry, log in to the installer host
     The system fetches the DTR registry connection details from the secrets input file _hedge_secrets_inp.yaml. 
  2. To update DTR registry details  _hedge_secrets_inp.yaml,, modify the existing secret block or add a new one.
    Make sure to give a unique secret name, for example, bmcregcreds, pubregcreds, or myregcreds.
    The installer uses these details to create the secret.
    Make sure to set the above secret name that holds your DTR registry credentials under the 
    PULL_SECRET parameter of the env file. For example: export PULL_SECRET=myregcreds
  1. To open the scripts, navigate to /opt/bmc/hedge/hedge-core/_hedge_secrets_inp.yaml.
    The following is an example script:

    dockerhub:

     secret_name: regcred
      secret_type: kubernetes.io/dockerconfigjson
      registry_server: https://index.docker.io/v1/
     registry_username: myUser
      registry_password: 'myPassword'
      registry_email: test@bmc.com

    harborhub:
      secret_name: harborhub
      secret_type: kubernetes.io/dockerconfigjson
      registry_server: https://aus-harbor-reg1.bmc.com/
     registry_username: myuser
      registry_password: 'mypassword'
      registry_email: test@bmc.com

    The installer creates the secret by using the above details to import the images.

  2. Click Edit.
  3. In the script, update each of the following lines. 
    The following is an example script:

    TODO_enter_REGISTRY_SECRETNAME:
      secret_name: TODO_enter_REGISTRY_SECRETNAME
      secret_type: kubernetes.io/dockerconfigjson
      registry_server:TODO_enter_BMC_Registry_user_URL
      registry_username: TODO_enter_BMC_Registry_user_name
      registry_password: TODO_enter_BMC_Registry_password
      registry_email: TODO_enter_BMC_Registry_email

    The following table provides a clearer and more organized view of the variables and their descriptions.

    Variable Name

    Description

    Example Value

    TODO_enter_REGISTRY_SECRETNAME

    Placeholder for the actual secret name.

    my-docker-credentials

    secret_name

    Name of the secret.

    my-docker-credentials

    secret_type

    Type of the secret (DockerConfigJson).

    kubernetes.io/dockerconfigjson

    registry_server

    URL of the Docker registry.

    https://my-registry.com

    registry_username

    Username for the Docker registry.

    john.doe

    registry_password

    Password for the Docker registry.

    secret123 (Not recommended!)

    registry_email

    The email address associated with the Docker registry.

    john.doe@example.com

    • The example values are for illustrative purposes only and should be replaced with your actual values.
    • Storing passwords directly in code is not recommended. Consider using a secure secrets management solution.
    The Kubernetes secret specified in secret_name and secret_type is essential in managing and storing Docker registry authentication credentials. The system uses this configuration when deploying and managing Docker containers and images in a Kubernetes cluster.

  4. Click Propose changes to commit the update.

Updating the env file for the environment variable that drives the deployment

After you update the registry, you must modify the env file script to accommodate the environment variables to drive the deployment process. These variables are crucial in configuring and customizing the installation to suit your needs.

Before you begin

Make sure the env file has the appropriate DTR registry info referenced from the _hedge_secrets_inp.yaml file. 

  • The registry_server parameter in _hedge_secrets_inp.yaml must match the DTR registry mentioned under the REGISTRY_HOST parameter in env.
  • The secret_name parameter value and TODO_enter_REGISTRY_SECRETNAME in _hedge_secrets_inp.yaml must be the same as the PULL_SECRET parameter in env.

The following steps show example values.

  1. To update the DTR registry, log in as a root
  2. To open the script, go to /opt/bmc/hedge/hedge-core/env.

    export REGISTRY_HOST=containers.bmc.com/bmc
    export SECRETS_FILE=$INSTALL_DIRECTORY/_hedge_secrets_inp.yaml
    export PULL_SECRET=bmcregcreds
  3. Validate the environment variables manually to confirm their accuracy and correctness. 
    This step is essential to prevent potential issues during installation.
  4. Click Propose changes to save the update.

Where to go from here

Deploying the Helix core on-premises

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*