Skip to main content

Backstage静态配置

摘要

Backstage 随附一个灵活的配置系统,为本地开发和生产部署提供了一种配置 Backstage 应用程序和插件的简单方法。 它可以帮助您快速启动和运行,同时使 Backstage 适应您的特定环境。 它还可以作为插件作者的工具,使其能够简单地选取和安装插件,同时仍允许自定义。

提供配置

配置存储在 YAML 文件中,默认值为app-config.yamlapp-config.local.yaml来加载其他文件集。--config <path>配置文件本身包含纯 YAML,但支持从不同来源加载数据和Secret,例如使用$env$file钥匙

也可以通过环境变量提供配置,例如APP_CONFIG_app_baseUrl=https://staging.example.com不过,应尽量少用,通常只用于开发过程中的临时覆盖或小调整,以便在不同环境中重复使用部署工件。

配置在前端和后端之间共享,这意味着两者之间通用的值只需定义一次。 如backend.baseUrl.

更多详情,请参阅书写配置.

配置模式

配置使用 JSON 模式定义进行验证。 每个插件和软件包都可以提供配置模式的片段,这些片段在验证过程中拼接在一起,形成一个完整的模式。 配置模式还可用于使用自定义的visibility关键字,因为默认情况下配置只能在后端进行。

您可以使用backstage-cli config:check更多信息,请参见定义配置.

读取配置

作为插件开发人员,您可能最终希望定义您希望插件用户提供的配置,并在前端和后端插件中读取这些配置。 更多详情,请参阅阅读配置定义配置.

进一步阅读

更多详情,请参阅文档中的专门章节。