@globallogicuki/backstage-plugin-terraform-backend

中文文档
0.12.0发布于 2026/08/25Apache-2.0TypeScriptCommonJS近 30 天下载 5858

后台后端插件代理 Terraform Cloud/ Enterprise API 用于地铁前端插件

中文使用文档
文档目录6 节
  1. 安装
  2. 设置
  3. 新建后台后端系统
  4. 后台后端系统
  5. 状态检查
  6. 更新 OpenAPI 光谱

后台的平面后端插件

此插件是三角形前端插件所使用的后端 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

版本与发布记录

@globallogicuki/backstage-plugin-terraform-backend 共发布 28 个版本,首次发布于 2024/02/16;过去 12 个月发布了 7 个版本。

版本发布日期距今
0.12.0latest2026/08/252 个月前
0.10.62026/08/252 个月前
0.10.52026/06/234 个月前
0.10.42025/12/1011 个月前
0.10.32025/12/0511 个月前
0.10.22025/12/0311 个月前

关于 @globallogicuki/backstage-plugin-terraform-backend 的常见问题

@globallogicuki/backstage-plugin-terraform-backend 是什么?

后台后端插件代理 Terraform Cloud/ Enterprise API 用于地铁前端插件

如何安装 @globallogicuki/backstage-plugin-terraform-backend?

在项目目录运行 npm install @globallogicuki/backstage-plugin-terraform-backend,或使用 pnpm add / yarn add / bun add。

@globallogicuki/backstage-plugin-terraform-backend 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@globallogicuki/backstage-plugin-terraform-backend 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

@globallogicuki/backstage-plugin-terraform-backend 可以商用吗?

@globallogicuki/backstage-plugin-terraform-backend 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@globallogicuki/backstage-plugin-terraform-backend 的下载量有多少?

根据 npm 官方下载统计,@globallogicuki/backstage-plugin-terraform-backend 在 2026/10/17 – 2026/11/15 这 30 天内被下载 5,858 次,日均约 195 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@globallogicuki/backstage-plugin-terraform-backend 还在维护吗?

最新版本 0.12.0 发布于 2026/08/25(2 个月前);至今共发布 28 个版本,其中过去 12 个月发布了 7 个;首次发布于 2024/02/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。