Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Catalog rules only apply to base definition, not applied to urls in catalog

See original GitHub issue

When a rule is applied to a URL, than any catalog components defined in that url should be allowed. Currently it seems the rule is only applying directly to the component.

catalog: 
  locations: 
    - type: url 
      target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/all-templates.yaml 
      rules: 
        - allow: [Template]

Currently, templates are not allowed to be applied when found via a url

2021-04-26T19:28:49.532Z catalog warn Failed item in location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh
2021-04-26T19:28:49.533Z catalog warn Failed item in location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/docs-template/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/docs-template/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh
2021-04-26T19:28:49.533Z catalog warn Failed item in location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/react-ssr-template/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh
2021-04-26T19:28:49.534Z catalog warn Failed item in location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/springboot-grpc-template/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh
2021-04-26T19:28:49.534Z catalog warn Failed item in location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/v1beta2-demo/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/v1beta2-demo/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh
2021-04-26T19:28:49.535Z catalog warn Failed item in location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/pull-request/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/backstage/backstage/tree/master/plugins/scaffolder-backend/sample-templates/pull-request/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh
2021-04-26T19:28:49.535Z catalog warn Failed item in location url:https://github.com/spotify/cookiecutter-golang/tree/master/template.yaml, NotAllowedError: Entity of kind Template is not allowed from location url:https://github.com/spotify/cookiecutter-golang/tree/master/template.yaml
    at LocationReaders.read (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:1034:22)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
    at async HigherOrderOperations.refreshSingleLocation (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:936:26)
    at async HigherOrderOperations.refreshAllLocations (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:924:9)
    at async startRefresh (/app/node_modules/@backstage/plugin-catalog-backend/dist/index.cjs.js:865:9) type=plugin component=catalog-all-locations-refresh

As a temporary workaround, you’d have to define all templates at the base catalog definition.

catalog:
  locations:
    - type: url
      target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/all-templates.yaml
      rules:
        - allow: [Template]
    - type: url
      target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/create-react-app/template.yaml
      rules:
        - allow: [Template]