# @globallogicuki/backstage-plugin-terraform-backend 中文文档

规范地址：https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform-backend/

版本：0\.12\.0
npm 元数据更新时间：2026-08-25T14:09:28.384Z
中文译文更新时间：2026-11-16T16:14:42.076Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40globallogicuki/backstage-plugin-terraform-backend
原文对照：https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform-backend/?lang=original
项目主页：https://github.com/globallogicuki/globallogic-backstage-plugins/tree/main/plugins/terraform-backend
源码仓库：https://github.com/globallogicuki/globallogic-backstage-plugins

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：71.1 kB，18 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：6 个
- 首次发布：2024-02-16T13:06:09.339Z
- 最新版本发布：2026-08-25T14:09:28.243Z
- 近 30 天下载量：5858（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：28（近 12 个月 7 个）

## 中文简介

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

## 安装

```sh
npm install @globallogicuki/backstage-plugin-terraform-backend
```

也可以使用：`pnpm add @globallogicuki/backstage-plugin-terraform-backend`、`yarn add @globallogicuki/backstage-plugin-terraform-backend`、`bun add @globallogicuki/backstage-plugin-terraform-backend`

## README

# 后台的平面后端插件

此插件是三角形前端插件所使用的后端 api .

## 安装

```shell
yarn add @globallogicuki/backstage-plugin-terraform-backend
```

## 设置

要使用三角形后端, 您需要在您的 `app-config.yaml` 文件 :

```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 或更多的后端和前端插件 . [看这里](https://backstage.io/docs/backend-system/) 需要更多信息.

添加以下内容到 `packages/backend/src/index.ts`数字 :

```typescript
backend.add(import('@globallogicuki/backstage-plugin-terraform-backend'));
```

### 后台后端系统

创建名为新文件 `packages/backend/src/plugins/terraform.ts`,并添加以下内容:

```typescript
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`数字 :

```typescript
import terraform from './plugins/terraform';
// ...
async function main() {
  // ...
  const terraformEnv = useHotMemoize(module, () => createEnv('terraform'));
  apiRouter.use('/terraform', await terraform(terraformEnv));
```

### 状态检查

在启动后端(例如使用从 repo root 开始后端)后,您应该能够从中获取数据.

```shell
curl localhost:7007/api/terraform/health
```

这个应该还给你 `{"status":"ok"}`。 。 。 .

## 更新 OpenAPI 光谱

OpenAPI 规格可见于 `src/schema/openapi.yaml`

此文件修改后, 您应该运行以下程序以生成更新 `src/schema/openapi.generated.yaml`

```shell
yarn generate-openapi-schema
```

## 常见问题

### @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 和提交记录判断。

