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

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

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

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

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

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

- 包体积（解压后）：119 kB，77 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：12 个
- peer 依赖：react ^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0
- 首次发布：2024-02-16T13:06:09.307Z
- 最新版本发布：2026-08-25T14:09:28.795Z
- 近 30 天下载量：5019（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：25（近 12 个月 5 个）

## 中文简介

后台前端插件显示 Terraform 运行、 健康评估和目录实体验证检查

## 安装

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

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

## README

# 后台前端插件

您可以使用此插件来显示一个或多个工作空间的轨道运行列表 .

![Terraform Runs - Single Workspace](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-content.png)

![Terraform Runs - Multiple Workspaces](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-content-multiple.png)

## 安装

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

## 设置

此插件被设计为在一个实体内的自己的标签中工作 。 您需要添加 `<EntityTerraformContent />` 前端应用程序中实体页面的组件.

有一个 `isTerraformAvailable` 帮助函数和 a `<EntityTerraformCard />` 如果您想在已有的标签中使用此选项,则可用组件.

编辑 `packages/app/src/components/catalog/EntityPage.tsx` 并添加进口:

```typescript
import { EntityTerraformContent } from '@globallogicuki/backstage-plugin-terraform';
```

然后在想要的实体页面上添加以下路线和组件:

```typescript
<EntityLayout.Route path="/terraform" title="Terraform">
  <EntityTerraformContent />
</EntityLayout.Route>
```

有两个说明,你应该加入你的 `catalog-info.yaml` 文件 :

```yaml
annotations:
  terraform/organization: orgName
  terraform/workspaces: workspaceName1,workspaceName2,workspaceName3
```

您还需要拥有 [三角形后端插件](https://www.npmjs.com/package/@globallogicuki/backstage-plugin-terraform-backend) 安装和运行.

## 配置

插件读取可选内容 `integrations.terraform.baseUrl` 从您的值 `app-config.yaml` 创建链接到 Terraform 网络用户界面 :

```yaml
integrations:
  terraform:
    baseUrl: https://tfe.enterprise.com # Optional, the web origin of your Terraform instance. Defaults to https://app.terraform.io
```

此值与后端插件使用值相同, 后端插件通过附件获取 Terraform API 根 `/api/v2`。 。 。 .

## 最新运行卡

![Latest Run card - Single Workspace](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-latest-run-content.png)

![Latest Run card - Multiple Workspaces](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-latest-run-content-multiple.png)

这是一个额外的组件,可以用 `<EntityTerraformLatestRunCard>` 进口和添加到 `EntityPage.tsx` 用于路由的文件.

## Terraform 工作空间健康卡

![Workspace Health card - Light mode](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-workspace-health.png)

这是一个额外的组件,可以用 `<EntityTerraformWorkspaceHealthAssessmentsCard>` 进口和添加到 `EntityPage.tsx` 用于插件根的路由文件.

或者,可以从其他部分中参考,使用 `<TerraformWorkspaceHealthAssessments>` 标签.

这将为您定义的每个工作区制作健康卡 `catalog-info.yaml` 文档中,每个健康卡中都包含用于特定工作空间的漂流计量和验证检查的儿童卡.

### 地形漂移度量表

![Workspace Health card - Drift Only](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-workspace-health-drift-only.png)

漂流卡默认在工作空间健康组件内可见,但可选用 `showDrift` 财产 `<TerraformWorkspaceHealthAssessments>` 标记,例如:

```
<TerraformWorkspaceHealthAssessments showDrift={false}>
```

漂流卡还包含导航要素,如果需要更分解的话,可直接链接到您Terraform部署内的工作空间专用漂流视图.

### 地形验证检查

![Workspace Health card - Validation Checks Only](https://npmcn.com/package/%40globallogicuki/backstage-plugin-terraform/docs/terraform-plugin-workspace-health-checks-only.png)

验证检查卡默认也在工作空间健康组件中可见,但可选用 `showValidationChecks` 财产 `<TerraformWorkspaceHealthAssessments>` 标记,例如:

```
<TerraformWorkspaceHealthAssessments showValidationChecks={false}>
```

验证检查卡还包含一个直接链接,即如果需要更详细分类,则与您在Terraform部署中的工作空间持续验证视图直接连接.

## 常见问题

### @globallogicuki/backstage-plugin-terraform 是什么？

后台前端插件显示 Terraform 运行、 健康评估和目录实体验证检查

### 如何安装 @globallogicuki/backstage-plugin-terraform？

在项目目录运行 npm install @globallogicuki/backstage-plugin-terraform，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：react（^16\.13\.1 \|\| ^17\.0\.0 \|\| ^18\.0\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @globallogicuki/backstage-plugin-terraform 支持 TypeScript 吗？

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

### @globallogicuki/backstage-plugin-terraform 支持 ESM 还是 CommonJS？

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

### @globallogicuki/backstage-plugin-terraform 可以商用吗？

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

### @globallogicuki/backstage-plugin-terraform 的下载量有多少？

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

### @globallogicuki/backstage-plugin-terraform 还在维护吗？

最新版本 0\.12\.0 发布于 2026/08/25（2 个月前）；至今共发布 25 个版本，其中过去 12 个月发布了 5 个；首次发布于 2024/02/16。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

