Skip to content

README-github.md

Latest commit

 

History

History
201 lines (162 loc) · 4.04 KB

README-github.md

File metadata and controls

201 lines (162 loc) · 4.04 KB

rhdh-exercises

Installation

oc apply -f rhdh-installation/operator.yaml
oc apply -f rhdh-installation/rhdh-instance.yaml

Start customizing

oc apply -f ./custom-app-config/rhdh-app-configmap.yaml -n rhdh
oc apply -f ./custom-app-config/rhdh-instance.yaml -n rhdh

apply the needed mandaroy backend auth key secret

oc apply -f ./custom-app-config/rhdh-secrets.yaml -n rhdh
export basedomain=$(oc get ingresscontroller -n openshift-ingress-operator default -o jsonpath='{.status.domain}' | base64 -w0)
oc patch secret rhdh-secrets -n rhdh -p '{"data":{"basedomain":"'"${basedomain}"'"}}'

add this configmap to the rhdh manifest:

spec:
  application:
    appConfig:
      configMaps:
      - name: app-config-rhdh

Enable github authentication

create a new organization create a new oauth application create a secret with a client id and secret

kind: Secret
apiVersion: v1
metadata:
  name: github-secrets
  namespace: rhdh
data:
  GITHUB_APP_CLIENT_ID: xxx
  GITHUB_APP_CLIENT_SECRET: xxx
type: Opaque

modify app config with the new secret

    app:
      title: My Red Hat Developer Hub Instance
    auth:
      # see https://backstage.io/docs/auth/ to learn about auth providers
      environment: development
      providers:
        github:
          development:
            clientId: ${GITHUB_APP_CLIENT_ID}
            clientSecret: ${GITHUB_APP_CLIENT_SECRET}

or execute

oc apply -f ./custom-app-config/rhdh-app-configmap-1.yaml -n rhdh
oc apply -f ./custom-app-config/rhdh-instance-1.yaml -n rhdh

add the new secret to the backstage manifests

spec:
  application:
    ...
    extraEnvs:
      secrets:
        - name: github-secrets

Enable github plugin integration

create new github application install the application in the organization add the following to the previously created github-secrets secret

kind: Secret
apiVersion: v1
metadata:
  name: github-secrets
  namespace: rhdh
data:
  GITHUB_APP_CLIENT_ID: xxx
  GITHUB_APP_CLIENT_SECRET: xxx
  GITHUB_APP_APP_ID: xxx
  GITHUB_APP_WEBHOOK_URL: none
  GITHUB_APP_WEBHOOK_SECRET: none
  GITHUB_APP_PRIVATE_KEY: xxx
type: Opaque

add the following to the appconfig configmap

kind: ConfigMap
apiVersion: v1
metadata:
  name: app-config-rhdh
data:
  app-config-rhdh.yaml: |
    app:
      title: My Red Hat Developer Hub Instance
    integrations:
      github:
        - host: github.com
          apps:
            - appId: ${GITHUB_APP_APP_ID}
              clientId: ${GITHUB_APP_CLIENT_ID}
              clientSecret: ${GITHUB_APP_CLIENT_SECRET}
              webhookUrl: ${GITHUB_APP_WEBHOOK_URL}
              webhookSecret: ${GITHUB_APP_WEBHOOK_SECRET}
              privateKey: |
                ${GITHUB_APP_PRIVATE_KEY}

or execute

oc apply -f ./custom-app-config/rhdh-app-configmap-2.yaml -n rhdh

add github autodiscovery

create a new configmap with the plugins

oc apply -f ./custom-app-config/dynamic-plugins-3.yaml -n rhdh

add this to the configmap:

      catalog:
        providers:
          github:
            providerId:
              organization: '${GITHUB_ORG}'
            schedule:
              frequency:
                minutes: 30
              initialDelay:
                seconds: 15
              timeout:
                minutes: 3
oc apply -f ./custom-app-config/rhdh-app-configmap-3.yaml -n rhdh

update the backstage manifest to use the new configmap for plugins

spec:
  application:
  ...
    dynamicPluginsConfigMapName: dynamic-plugins-rhdh
oc apply -f ./custom-app-config/rhdh-instance-3.yaml -n rhdh

enable users/teams autodiscovery

update the dynamic plugin configmap

oc apply -f ./custom-app-config/dynamic-plugins-4.yaml -n rhdh

add this to the configmap:

    catalog:
      providers:
        githubOrg:
          id: production
          githubUrl: "${GITHUB_URL}"
          orgs: [ "${GITHUB_ORG}" ]
oc apply -f ./custom-app-config/rhdh-app-configmap-4.yaml -n rhdh