Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Bug Report: Github Org Data does not have option to import github team under default namespace #24684

Closed
2 tasks done
prasoon-pxc opened this issue May 8, 2024 · 3 comments
Labels
area:catalog Related to the Catalog Project Area bug Something isn't working

Comments

@prasoon-pxc
Copy link

📜 Description

I had already setup existing backstage with old backend system and I was using Github org data to ingest user&teams into Bakctage, it was working fine and user&teams are ingesting under default namespace, and after that when I need to reference owner field in catalog-info.yaml file I just have to mention the team name without using full reference of namespace.

In New Backend System, Now github teams are ingesting under namespace which is name of your github org.

👍 Expected behavior

I want to have an option where I can ingest github teams under default namespace or make my org as a default namespace so that I do not need to change all my catalog-info.yaml file to include full reference of namespaces in owner field.

👎 Actual Behavior with Screenshots

image

👟 Reproduction steps

Use Github org data to ingest Github user and teams into backstage and then reference one team in catalog.info.yaml file under owner field:

spec:
  type: service
  lifecycle: development
  owner: "platform" #here full namespace path is not mention

📃 Provide the context for the Bug.

No response

🖥️ Your Environment

OS:   Linux 5.15.0-105-generic - linux/x64
node: v18.18.2
yarn: 1.22.21
cli:  0.26.4 (installed)
backstage:  1.26.0

Dependencies:
  @backstage/app-defaults                                          1.5.4
  @backstage/backend-app-api                                       0.7.1
  @backstage/backend-common                                        0.21.7
  @backstage/backend-defaults                                      0.2.17
  @backstage/backend-dev-utils                                     0.1.4
  @backstage/backend-openapi-utils                                 0.1.10
  @backstage/backend-plugin-api                                    0.6.17
  @backstage/backend-tasks                                         0.5.22
  @backstage/catalog-client                                        1.6.4
  @backstage/catalog-model                                         1.4.5
  @backstage/cli-common                                            0.1.13
  @backstage/cli-node                                              0.2.5
  @backstage/cli                                                   0.26.4
  @backstage/config-loader                                         1.8.0
  @backstage/config                                                1.2.0
  @backstage/core-app-api                                          1.12.4
  @backstage/core-compat-api                                       0.2.4
  @backstage/core-components                                       0.14.5
  @backstage/core-plugin-api                                       1.9.2
  @backstage/e2e-test-utils                                        0.1.1
  @backstage/errors                                                1.2.4
  @backstage/eslint-plugin                                         0.1.7
  @backstage/frontend-plugin-api                                   0.6.4
  @backstage/integration-aws-node                                  0.1.12
  @backstage/integration-react                                     1.1.26
  @backstage/integration                                           1.10.0
  @backstage/plugin-api-docs                                       0.11.4
  @backstage/plugin-app-backend                                    0.3.65
  @backstage/plugin-app-node                                       0.1.17
  @backstage/plugin-auth-backend-module-atlassian-provider         0.1.9
  @backstage/plugin-auth-backend-module-aws-alb-provider           0.1.9
  @backstage/plugin-auth-backend-module-azure-easyauth-provider    0.1.0
  @backstage/plugin-auth-backend-module-bitbucket-provider         0.1.0
  @backstage/plugin-auth-backend-module-cloudflare-access-provider 0.1.0
  @backstage/plugin-auth-backend-module-gcp-iap-provider           0.2.12
  @backstage/plugin-auth-backend-module-github-provider            0.1.14
  @backstage/plugin-auth-backend-module-gitlab-provider            0.1.14
  @backstage/plugin-auth-backend-module-google-provider            0.1.14
  @backstage/plugin-auth-backend-module-guest-provider             0.1.3
  @backstage/plugin-auth-backend-module-microsoft-provider         0.1.12
  @backstage/plugin-auth-backend-module-oauth2-provider            0.1.14
  @backstage/plugin-auth-backend-module-oauth2-proxy-provider      0.1.10
  @backstage/plugin-auth-backend-module-oidc-provider              0.1.8
  @backstage/plugin-auth-backend-module-okta-provider              0.0.10
  @backstage/plugin-auth-backend                                   0.22.4
  @backstage/plugin-auth-node                                      0.4.12
  @backstage/plugin-auth-react                                     0.1.1
  @backstage/plugin-catalog-backend-module-github-org              0.1.12
  @backstage/plugin-catalog-backend-module-github                  0.6.0
  @backstage/plugin-catalog-backend-module-scaffolder-entity-model 0.1.15
  @backstage/plugin-catalog-backend                                1.21.1
  @backstage/plugin-catalog-common                                 1.0.22
  @backstage/plugin-catalog-graph                                  0.4.4
  @backstage/plugin-catalog-import                                 0.10.10
  @backstage/plugin-catalog-node                                   1.11.1
  @backstage/plugin-catalog-react                                  1.11.3
  @backstage/plugin-catalog                                        1.19.0
  @backstage/plugin-events-node                                    0.3.3
  @backstage/plugin-github-actions                                 0.6.16
  @backstage/plugin-org                                            0.6.24
  @backstage/plugin-permission-backend-module-allow-all-policy     0.1.14
  @backstage/plugin-permission-backend                             0.5.41
  @backstage/plugin-permission-common                              0.7.13
  @backstage/plugin-permission-node                                0.7.28
  @backstage/plugin-permission-react                               0.4.22
  @backstage/plugin-proxy-backend                                  0.4.15
  @backstage/plugin-scaffolder-backend-module-azure                0.1.9
  @backstage/plugin-scaffolder-backend-module-bitbucket-cloud      0.1.7
  @backstage/plugin-scaffolder-backend-module-bitbucket-server     0.1.7
  @backstage/plugin-scaffolder-backend-module-bitbucket            0.2.7
  @backstage/plugin-scaffolder-backend-module-gerrit               0.1.9
  @backstage/plugin-scaffolder-backend-module-gitea                0.1.7
  @backstage/plugin-scaffolder-backend-module-github               0.2.7
  @backstage/plugin-scaffolder-backend-module-gitlab               0.3.3
  @backstage/plugin-scaffolder-backend                             1.22.4
  @backstage/plugin-scaffolder-common                              1.5.1
  @backstage/plugin-scaffolder-node                                0.4.3
  @backstage/plugin-scaffolder-react                               1.8.4
  @backstage/plugin-scaffolder                                     1.19.3
  @backstage/plugin-search-backend-module-catalog                  0.1.23
  @backstage/plugin-search-backend-module-techdocs                 0.1.22
  @backstage/plugin-search-backend-node                            1.2.21
  @backstage/plugin-search-backend                                 1.5.7
  @backstage/plugin-search-common                                  1.2.11
  @backstage/plugin-search-react                                   1.7.10
  @backstage/plugin-search                                         1.4.10
  @backstage/plugin-tech-radar                                     0.7.4
  @backstage/plugin-techdocs-backend                               1.10.4
  @backstage/plugin-techdocs-module-addons-contrib                 1.1.9
  @backstage/plugin-techdocs-node                                  1.12.3
  @backstage/plugin-techdocs-react                                 1.2.3
  @backstage/plugin-techdocs                                       1.10.4
  @backstage/plugin-user-settings                                  0.8.5
  @backstage/release-manifests                                     0.0.11
  @backstage/repo-tools                                            0.8.0
  @backstage/test-utils                                            1.5.4
  @backstage/theme                                                 0.5.3
  @backstage/types                                                 1.1.1
  @backstage/version-bridge                                        1.0.8
Done in 0.95s.

👀 Have you spent some time to check if this bug has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

None

@prasoon-pxc prasoon-pxc added the bug Something isn't working label May 8, 2024
@vinzscam vinzscam added the area:catalog Related to the Catalog Project Area label May 10, 2024
@vinzscam
Copy link
Member

vinzscam commented May 10, 2024

Thank you for reporting this. We are working on a fix in #24700

In the meantime I can give you a workaround to apply in your packages/backend/src/index.ts

+ import {
+   coreServices,
+   createBackendModule,
+ } from '@backstage/backend-plugin-api';
+ import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
+ import { GithubOrgEntityProvider } from '@backstage/plugin-catalog-backend-module-github';

...

- backend.add(import('@backstage/plugin-catalog-backend-module-github-org'));
+ backend.add(
+   createBackendModule({
+     pluginId: 'catalog',
+     moduleId: 'example-custom-processor',
+     register(env) {
+       env.registerInit({
+         deps: {
+           catalog: catalogProcessingExtensionPoint,
+           config: coreServices.rootConfig,
+           logger: coreServices.logger,
+         },
+         async init({ catalog, config, logger }) {
+           catalog.addEntityProvider(
+             GithubOrgEntityProvider.fromConfig(config, {
+               // same options as before
+             }),
+           );
+         },
+       });
+     },
+   }),
+ );

Let me know if this works!

@prasoon-pxc
Copy link
Author

@vinzscam --> Thanks for your reply, I have upgraded my backstage version to 1.27.0 and right now groups are ingesting under default namespace.
and sorry I have not got the time to test your above code on old version.
Again Thanks

@vinzscam
Copy link
Member

@vinzscam --> Thanks for your reply, I have upgraded my backstage version to 1.27.0 and right now groups are ingesting under default namespace. and sorry I have not got the time to test your above code on old version. Again Thanks

ah no problem, glad everything is working as expected 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:catalog Related to the Catalog Project Area bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants