后台的平面后端插件
此插件是三角形前端插件所使用的后端 api .
安装
yarn add @globallogicuki/backstage-plugin-terraform-backend
设置
要使用三角形后端, 您需要在您的 app-config.yaml 文件 :
integrations:
terraform:
token: tokenGoesHere
baseUrl: https://tfe.enterprise.com # Optional, for self-hosted TFE. Defaults to https://app.terraform.io
pageSize: 20 # Optional, override default TF API page size
baseUrl 是您的 Terraform 实例的网络来源(它也被前端插件用来构建与 Terraform UI 的链接)。 后端通过附加获取 API 根 /api/v2。对于后向兼容性, a baseUrl 已经结束于 /api/v2 被后端作为-is使用.
新建后台后端系统
如果您正在使用新的后台后端系统, 您必须使用 v. 3. 0 或更多的后端和前端插件 . 看这里 需要更多信息.
添加以下内容到 packages/backend/src/index.ts数字 :
backend.add(import('@globallogicuki/backstage-plugin-terraform-backend'));
后台后端系统
创建名为新文件 packages/backend/src/plugins/terraform.ts,并添加以下内容:
import { createRouter } from '@globallogicuki/backstage-plugin-terraform-backend';
import { Router } from 'express';
import { PluginEnvironment } from '../types';
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
return await createRouter({
logger: env.logger,
config: env.config,
});
}
最后,把这个接入整个后端路由器。 编辑 packages/backend/src/index.ts数字 :
import terraform from './plugins/terraform';
// ...
async function main() {
// ...
const terraformEnv = useHotMemoize(module, () => createEnv('terraform'));
apiRouter.use('/terraform', await terraform(terraformEnv));
状态检查
在启动后端(例如使用从 repo root 开始后端)后,您应该能够从中获取数据.
curl localhost:7007/api/terraform/health
这个应该还给你 {"status":"ok"}。 。 。 .
更新 OpenAPI 光谱
OpenAPI 规格可见于 src/schema/openapi.yaml
此文件修改后, 您应该运行以下程序以生成更新 src/schema/openapi.generated.yaml
yarn generate-openapi-schema