Full configuration examples

Review complete configuration examples for Ansible plug-ins for Red Hat Developer Hub deployments.

Full app-config-rhdh ConfigMap example for Ansible plug-ins entries
Copy link

This example details necessary settings like the creatorService URL, optional integrations for Ansible Automation Platform and OpenShift Dev Spaces, and the addition of Ansible software templates to the catalog.

kind: ConfigMap
...
metadata:
  name: app-config-rhdh
  ...
data:
  app-config-rhdh.yaml: |-
    ansible:
      creatorService:
        baseUrl: 127.0.0.1
        port: '8000'
      # Optional integrations
      rhaap:
        baseUrl: '<https://your-controller-url>'
        token: '<AAP Personal Access Token>'
        checkSSL: true
      devSpaces:
        baseUrl: '<https://MyDevSpacesURL>'
      automationHub:
        baseUrl: '<https://MyPrivateAutomationHubURL>'

    ...
    catalog:
      locations:
        - type: url
          target: https://github.com/ansible/ansible-rhdh-templates/blob/main/all.yaml
          rules:
            - allow: [Template]
    ...

Full Operator Backstage CR example for Ansible plug-ins
Copy link

This example shows the full Backstage custom resource configuration for an Operator-based deployment, including the ADT sidecar container and imagePullSecrets.

apiVersion: rhdh.redhat.com/v1alpha5
kind: Backstage
metadata:
  name: developer-hub
  namespace: <your_rhdh_namespace>
spec:
  application:
    appConfig:
      configMaps:
      - name: app-config-rhdh
      mountPath: /opt/app-root/src
    dynamicPluginsConfigMapName: dynamic-plugins-rhdh
    extraEnvs:
      secrets:
      - name: <your_scm_credentials_secret>
      - name: <your_rhaap_credentials_secret>
    extraFiles:
      mountPath: /opt/app-root/src
      secrets:
      - key: private-key.pem
        name: <your_scm_credentials_secret>
    route:
      enabled: true
  database:
    enableLocalDb: true
  deployment:
    patch:
      spec:
        template:
          spec:
            imagePullSecrets:
              - name: rhdh-registry-pull-secret
            containers:
              - name: ansible-devtools-server
                command:
                  - adt
                  - server
                image: registry.redhat.io/ansible-automation-platform-2.6/ansible-dev-tools-rhel9:latest
                imagePullPolicy: Always
                ports:
                  - containerPort: 8000
                    protocol: TCP

Full Helm chart config example for Ansible plug-ins
Copy link

This example provides a full YAML configuration for the Helm chart using OCI container delivery.

global:
  # ...
  dynamic:
    # ...
    plugins:
      - disabled: false
        package: >-
          oci://registry.redhat.io/ansible-automation-platform/automation-portal:<tag>!ansible-plugin-backstage-rhaap
        pluginConfig:
          dynamicPlugins:
            frontend:
              ansible.plugin-backstage-rhaap:
                appIcons:
                  - importName: AnsibleLogo
                    name: AnsibleLogo
                dynamicRoutes:
                  - importName: AnsiblePage
                    menuItem:
                      icon: AnsibleLogo
                      text: Ansible
                    path: /ansible
      - disabled: false
        package: >-
          oci://registry.redhat.io/ansible-automation-platform/automation-portal:<tag>!ansible-plugin-backstage-self-service
        pluginConfig:
          dynamicPlugins:
            frontend:
              ansible.plugin-backstage-self-service:
                scaffolderFieldExtensions:
                  - importName: AAPTokenFieldExtension
                  - importName: AAPResourcePickerExtension
      - disabled: false
        package: >-
          oci://registry.redhat.io/ansible-automation-platform/automation-portal:<tag>!ansible-backstage-plugin-catalog-backend-module-rhaap
        pluginConfig: {}
      - disabled: false
        package: >-
          oci://registry.redhat.io/ansible-automation-platform/automation-portal:<tag>!ansible-plugin-scaffolder-backend-module-backstage-rhaap
        pluginConfig:
          dynamicPlugins:
            backend:
              ansible.plugin-scaffolder-backend-module-backstage-rhaap:
upstream:
  backstage:
    # ...
    extraAppConfig:
      - configMapRef: app-config-rhdh
        filename: app-config-rhdh.yaml
    extraContainers:
      - command:
          - adt
          - server
        image: >-
          registry.redhat.io/ansible-automation-platform-2.6/ansible-dev-tools-rhel9:latest
        imagePullPolicy: IfNotPresent
        name: ansible-devtools-server
        ports:
          - containerPort: 8000