Uploaded image for project: 'Red Hat Developer Hub Bugs'
  1. Red Hat Developer Hub Bugs
  2. RHDHBUGS-2226

GitHub Authentication docs issues

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Undefined Undefined
    • 1.8.1
    • 1.8.0
    • Documentation
    • None
    • RHDH Documentation 3283, RHDH Documentation 3284
    • Moderate

      Description of problem:

      In https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.7/html/authentication_in_red_hat_developer_hub/enabling-user-authentication-with-github

      in step 3, it has me configure the plugin with:

      plugins:
        - package: './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org'
          disabled: false
      

      but there is no such plugin. The proper name should be

      './dynamic-plugins/dist/backstage-plugin-catalog-backend-module-github-org-dynamic'

      (that is, the -dynamic suffix is needed as that's the name of the plugin)


      in step 2, it has me set AUTHENTICATION_GITHUB_HOST_DOMAIN to github.com - which caused a startup fail:

      ForwardedError: Module 'github-org-entity-provider' for plugin 'catalog' startup failed; caused by Error: There is no GitHub integration that matches github.com. Please add a configuration entry for it under integrations.github.

      Setting this to https://github.com (adding the https:// prefix) worked (not sure why - but followed this example https://backstage.io/docs/integrations/github/org )

      Prerequisites (if any, like setup, operators/versions):

      RHDH 1.8.0 RC1
      OpenShift 4.17

      Steps to Reproduce

      Follow the docs to setup github authentication (including catalog sync with github orgs/users)

      Actual results:

      See above failures

      Expected results:

      No failures, github users/orgs imported, able to login as github user.

      Reproducibility (Always/Intermittent/Only Once):

      Always

      Build Details:

      RHDH 1.8.0 RC1

              jvrbkova@redhat.com Jana Vrbkova
              jfalkner1@redhat.com James Falkner
              RHDH Documentation
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: