Hellgren Heikki
f222a2eab9
depending on the plugin startup order, some distributed actions might not be available when the scaffolder backend starts. this was mentioned in the comment that is now removed. while this might change in the future, this would patch the current way the distributed actions are fetched. related #31213 and #31207 closes #31187 Signed-off-by: Hellgren Heikki <heikki.hellgren@op.fi>
309 lines
10 KiB
YAML
309 lines
10 KiB
YAML
app:
|
|
title: Backstage Example App
|
|
baseUrl: http://localhost:3000
|
|
packages: all # ✨
|
|
|
|
#datadogRum:
|
|
# clientToken: '123456789'
|
|
# applicationId: qwerty
|
|
# site: # datadoghq.eu default = datadoghq.com
|
|
# env: # optional
|
|
# sessionSampleRate: 100
|
|
# sessionReplaySampleRate: 0
|
|
|
|
support:
|
|
url: https://github.com/backstage/backstage/issues # Used by common ErrorPage
|
|
items: # Used by common SupportButton component
|
|
- title: Issues
|
|
icon: github
|
|
links:
|
|
- url: https://github.com/backstage/backstage/issues
|
|
title: GitHub Issues
|
|
- title: Discord Chatroom
|
|
icon: chat
|
|
links:
|
|
- url: https://discord.gg/backstage-687207715902193673
|
|
title: '#backstage'
|
|
|
|
packageName: example-app
|
|
|
|
backend:
|
|
# Used for enabling authentication, secret is shared by all backend plugins
|
|
# See https://backstage.io/docs/auth/service-to-service-auth for
|
|
# information on the format
|
|
# auth:
|
|
# keys:
|
|
# - secret: ${BACKEND_SECRET}
|
|
|
|
# Used for testing rate limiting locally
|
|
# rateLimit:
|
|
# windowMs: 1m
|
|
# incomingRequestLimit: 1
|
|
# ipAllowList: []
|
|
|
|
auth:
|
|
# TODO: once plugins have been migrated we can remove this, but right now it
|
|
# is require for the backend-next to work in this repo
|
|
dangerouslyDisableDefaultAuthPolicy: true
|
|
|
|
baseUrl: http://localhost:7007
|
|
listen:
|
|
port: 7007
|
|
database:
|
|
client: better-sqlite3
|
|
connection: ':memory:'
|
|
cors:
|
|
origin: http://localhost:3000
|
|
methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
|
|
credentials: true
|
|
csp:
|
|
connect-src: ["'self'", 'http:', 'https:']
|
|
# Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
|
|
# Default Helmet Content-Security-Policy values can be removed by setting the key to false
|
|
reading:
|
|
allow:
|
|
- host: example.com
|
|
- host: '*.mozilla.org'
|
|
# workingDirectory: /tmp # Use this to configure a working directory for the scaffolder, defaults to the OS temp-dir
|
|
actions:
|
|
pluginSources:
|
|
- catalog
|
|
# See README.md in the proxy-backend plugin for information on the configuration format
|
|
proxy:
|
|
endpoints:
|
|
'/pagerduty':
|
|
target: https://api.pagerduty.com
|
|
headers:
|
|
Authorization: Token token=${PAGERDUTY_TOKEN}
|
|
|
|
organization:
|
|
name: My Company
|
|
|
|
# Reference documentation http://backstage.io/docs/features/techdocs/configuration
|
|
# Note: After experimenting with basic setup, use CI/CD to generate docs
|
|
# and an external cloud storage when deploying TechDocs for production use-case.
|
|
# https://backstage.io/docs/features/techdocs/how-to-guides#how-to-migrate-from-techdocs-basic-to-recommended-deployment-approach
|
|
techdocs:
|
|
builder: 'local' # Alternatives - 'external'
|
|
generator:
|
|
runIn: 'docker'
|
|
# dockerImage: my-org/techdocs # use a custom docker image
|
|
# pullImage: true # or false to disable automatic pulling of image (e.g. if custom docker login is required)
|
|
publisher:
|
|
type: 'local' # Alternatives - 'googleGcs' or 'awsS3' or 'azureBlobStorage' or 'openStackSwift'. Read documentation for using alternatives.
|
|
|
|
integrations:
|
|
github:
|
|
- host: github.com
|
|
token: ${GITHUB_TOKEN}
|
|
### Example for how to add your GitHub Enterprise instance using the API:
|
|
# - host: ghe.example.net
|
|
# apiBaseUrl: https://ghe.example.net/api/v3
|
|
# token: ${GHE_TOKEN}
|
|
### Example for how to add your GitHub Enterprise instance using raw HTTP fetches (token is optional):
|
|
# - host: ghe.example.net
|
|
# rawBaseUrl: https://ghe.example.net/raw
|
|
# token: ${GHE_TOKEN}
|
|
gitlab:
|
|
- host: gitlab.com
|
|
token: ${GITLAB_TOKEN}
|
|
### Example for how to add a bitbucket cloud integration
|
|
# bitbucketCloud:
|
|
# - username: ${BITBUCKET_USERNAME}
|
|
# appPassword: ${BITBUCKET_APP_PASSWORD}
|
|
### Example for how to add your bitbucket server instance using the API:
|
|
# - host: server.bitbucket.com
|
|
# apiBaseUrl: server.bitbucket.com
|
|
# username: ${BITBUCKET_SERVER_USERNAME}
|
|
# appPassword: ${BITBUCKET_SERVER_APP_PASSWORD}
|
|
|
|
# azureBlobStorage:
|
|
# - accountName: ${ACCOUNT_NAME} # required
|
|
# endpoint: ${CUSTOM_ENDPOINT} # custom endpoint will require either aadCredentials or sasToken
|
|
# sasToken: ${SAS_TOKEN}
|
|
# aadCredential:
|
|
# clientId: ${CLIENT_ID}
|
|
# tenantId: ${TENANT_ID}
|
|
# clientSecret: ${CLIENT_SECRET}
|
|
# accountKey: ${ACCOUNT_KEY}
|
|
|
|
azure:
|
|
- host: dev.azure.com
|
|
token: ${AZURE_TOKEN}
|
|
# googleGcs:
|
|
# clientEmail: 'example@example.com'
|
|
# privateKey: ${GCS_PRIVATE_KEY}
|
|
awsS3:
|
|
- endpoint: ${AWS_S3_ENDPOINT}
|
|
accessKeyId: ${AWS_ACCESS_KEY_ID}
|
|
secretAccessKey: ${AWS_SECRET_ACCESS_KEY}
|
|
|
|
catalog:
|
|
import:
|
|
entityFilename: catalog-info.yaml
|
|
pullRequestBranchName: backstage-integration
|
|
rules:
|
|
- allow:
|
|
- Component
|
|
- API
|
|
- Resource
|
|
- System
|
|
- Domain
|
|
- Location
|
|
providers:
|
|
azureBlob:
|
|
accountName: ${ACCOUNT_NAME}
|
|
containerName: ${CONTAINER_NAME}
|
|
schedule: # same options as in TaskScheduleDefinition
|
|
# supports cron, ISO duration, "human duration" as used in code
|
|
frequency: { minutes: 30 }
|
|
# supports ISO duration, "human duration" as used in code
|
|
timeout: { minutes: 3 }
|
|
backstageOpenapi:
|
|
plugins:
|
|
- catalog
|
|
- search
|
|
locations:
|
|
# Add a location here to ingest it, for example from a URL:
|
|
#
|
|
# - type: url
|
|
# target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all.yaml
|
|
#
|
|
# For local development you can use a file location instead:
|
|
#
|
|
# - type: file
|
|
# target: ../catalog-model/examples/all-components.yaml
|
|
#
|
|
# File locations are relative to the current working directory of the
|
|
# backend, for example packages/backend/.
|
|
|
|
# Backstage example entities
|
|
- type: file
|
|
target: ../catalog-model/examples/all.yaml
|
|
# Backstage example groups and users
|
|
- type: file
|
|
target: ../catalog-model/examples/acme-corp.yaml
|
|
rules:
|
|
- allow: [User, Group]
|
|
# Example component for github-actions and TechDocs
|
|
- type: file
|
|
target: ../../plugins/github-actions/examples/sample.yaml
|
|
# Example component for TechDocs
|
|
- type: file
|
|
target: ../../plugins/techdocs-backend/examples/documented-component/catalog-info.yaml
|
|
# Example component for ADRs
|
|
- type: file
|
|
target: ../../plugins/adr/examples/component/catalog-info.yaml
|
|
# Backstage example templates
|
|
- type: file
|
|
target: ../../plugins/scaffolder-backend/sample-templates/all-templates.yaml
|
|
rules:
|
|
- allow: [Template]
|
|
|
|
scaffolder:
|
|
auditor:
|
|
taskParameterMaxLength: 256
|
|
# Use to customize default commit author info used when new components are created
|
|
defaultAuthor:
|
|
name: Scaffolder
|
|
email: scaffolder@backstage.io
|
|
# Use to customize the default commit message when new components are created
|
|
defaultCommitMessage: 'Initial commit'
|
|
|
|
auth:
|
|
experimentalDynamicClientRegistration:
|
|
enabled: true
|
|
allowedRedirectUriPatterns:
|
|
- cursor://*
|
|
|
|
### Add auth.keyStore.provider to more granularly control how to store JWK data when running
|
|
# the auth-backend.
|
|
#
|
|
# keyStore:
|
|
# provider: firestore
|
|
# firestore:
|
|
# projectId: my-project
|
|
# path: my-sessions
|
|
|
|
environment: development
|
|
### Providing an auth.session.secret will enable session support in the auth-backend
|
|
# session:
|
|
# secret: custom session secret
|
|
providers:
|
|
google:
|
|
development:
|
|
clientId: ${AUTH_GOOGLE_CLIENT_ID}
|
|
clientSecret: ${AUTH_GOOGLE_CLIENT_SECRET}
|
|
github:
|
|
development:
|
|
clientId: ${AUTH_GITHUB_CLIENT_ID}
|
|
clientSecret: ${AUTH_GITHUB_CLIENT_SECRET}
|
|
enterpriseInstanceUrl: ${AUTH_GITHUB_ENTERPRISE_INSTANCE_URL}
|
|
gitlab:
|
|
development:
|
|
clientId: ${AUTH_GITLAB_CLIENT_ID}
|
|
clientSecret: ${AUTH_GITLAB_CLIENT_SECRET}
|
|
audience: ${GITLAB_BASE_URL}
|
|
saml:
|
|
entryPoint: 'http://localhost:7001/'
|
|
issuer: 'passport-saml'
|
|
cert: 'fake-cert-base64'
|
|
okta:
|
|
development:
|
|
clientId: ${AUTH_OKTA_CLIENT_ID}
|
|
clientSecret: ${AUTH_OKTA_CLIENT_SECRET}
|
|
audience: ${AUTH_OKTA_AUDIENCE}
|
|
oauth2:
|
|
development:
|
|
clientId: ${AUTH_OAUTH2_CLIENT_ID}
|
|
clientSecret: ${AUTH_OAUTH2_CLIENT_SECRET}
|
|
authorizationUrl: ${AUTH_OAUTH2_AUTH_URL}
|
|
tokenUrl: ${AUTH_OAUTH2_TOKEN_URL}
|
|
###
|
|
# provide a list of scopes as needed for your OAuth2 Server:
|
|
#
|
|
# scope: saml-login-selector openid profile email
|
|
oidc:
|
|
# Note that you must define a session secret (see above) since the oidc provider requires session support.
|
|
# Note that by default, this provider will use the 'none' prompt which assumes that your are already logged on in the IDP.
|
|
# You should set prompt to:
|
|
# - auto: will let the IDP decide if you need to log on or if you can skip login when you have an active SSO session
|
|
# - login: will force the IDP to always present a login form to the user
|
|
development:
|
|
metadataUrl: ${AUTH_OIDC_METADATA_URL}
|
|
clientId: ${AUTH_OIDC_CLIENT_ID}
|
|
clientSecret: ${AUTH_OIDC_CLIENT_SECRET}
|
|
tokenEndpointAuthMethod: ${AUTH_OIDC_TOKEN_ENDPOINT_AUTH_METHOD} # default='client_secret_basic'
|
|
tokenSignedResponseAlg: ${AUTH_OIDC_TOKEN_SIGNED_RESPONSE_ALG} # default='RS256'
|
|
scope: ${AUTH_OIDC_SCOPE} # default='openid profile email'
|
|
prompt: ${AUTH_OIDC_PROMPT} # default=none (allowed values: auto, none, consent, login)
|
|
auth0:
|
|
development:
|
|
clientId: ${AUTH_AUTH0_CLIENT_ID}
|
|
clientSecret: ${AUTH_AUTH0_CLIENT_SECRET}
|
|
domain: ${AUTH_AUTH0_DOMAIN}
|
|
microsoft:
|
|
development:
|
|
clientId: ${AUTH_MICROSOFT_CLIENT_ID}
|
|
clientSecret: ${AUTH_MICROSOFT_CLIENT_SECRET}
|
|
tenantId: ${AUTH_MICROSOFT_TENANT_ID}
|
|
onelogin:
|
|
development:
|
|
clientId: ${AUTH_ONELOGIN_CLIENT_ID}
|
|
clientSecret: ${AUTH_ONELOGIN_CLIENT_SECRET}
|
|
issuer: ${AUTH_ONELOGIN_ISSUER}
|
|
bitbucket:
|
|
development:
|
|
clientId: ${AUTH_BITBUCKET_CLIENT_ID}
|
|
clientSecret: ${AUTH_BITBUCKET_CLIENT_SECRET}
|
|
atlassian:
|
|
development:
|
|
clientId: ${AUTH_ATLASSIAN_CLIENT_ID}
|
|
clientSecret: ${AUTH_ATLASSIAN_CLIENT_SECRET}
|
|
scope: ${AUTH_ATLASSIAN_SCOPES}
|
|
myproxy: {}
|
|
guest: {}
|
|
|
|
permission:
|
|
enabled: true
|