@continuous-excellence/ze-great-dashboard-aws

中文文档
0.31.63发布于 2026/11/10MITTypeScriptES Module构建来源已验证近 30 天下载 6209

AWS server runtime and CloudFormation deployment tooling for Ze Great Dashboard.

原始使用文档
文档目录6 节
  1. Prerequisites
  2. Choose and bootstrap a compute mode
  3. Package a deployment
  4. Private source credentials
  5. Ownership boundaries
  6. References

Ze Great Dashboard on AWS

@continuous-excellence/ze-great-dashboard-aws validates and packages a board for a private AWS Lambda or ECS deployment. It includes the server runtime, deployment CLI, and CloudFormation templates. The matching immutable browser client is published separately as @continuous-excellence/ze-great-dashboard-client and is selected automatically unless you provide another exact asset URL.

This package is for teams that already operate AWS and can provide a protected entry path:

  • Lambda requires a consumer-owned API Gateway, ALB, or equivalent gateway with private invocation permission.
  • ECS requires consumer-owned subnets, security groups, and protected load balancing or routing for the long-lived Fargate service.

In both modes, a consumer-owned gateway or load balancer defines the public entry and authentication boundary.

The templates create no public endpoint, choose no authentication policy, and manage no secret values. To evaluate the dashboard without AWS, start with the local setup.

Prerequisites

  • Node.js 22 or newer, npm, the AWS CLI, and jq.
  • An AWS administrator for one-time bootstrap.
  • A pre-existing account-level GitHub OIDC provider and protected GitHub Environment when GitHub Actions will deploy the dashboard.
  • Consumer-owned networking, gateway or load balancing, authentication, and runtime health checks.

Choose and bootstrap a compute mode

Lambda is the compatibility default. Select ECS with --mode ecs when running bootstrap init. The choice is stored in dashboard-bootstrap.json and generated application parameters as ComputeMode; older files without the field mean Lambda.

An explicit mode that conflicts with persisted configuration fails. Changing between Lambda and ECS requires regenerated, administrator-reviewed bootstrap and application parameters—it is not a routine package option.

Follow the AWS bootstrap guide, then the Lambda deployment guide.

Package a deployment

Pin the reviewed package version in the repository that owns the deployment:

npm install --save-exact @continuous-excellence/ze-great-dashboard-aws

Append @version when installing a previously reviewed release rather than the current one. After bootstrap, generate and diagnose application parameters, then package the board:

npm exec -- ze-great-dashboard-aws parameters \
  --bootstrap-config dashboard-bootstrap.json \
  --output aws-dashboard-parameters.json

npm exec -- ze-great-dashboard-aws doctor \
  --parameters aws-dashboard-parameters.json \
  --region us-east-1

npm exec -- ze-great-dashboard-aws package \
  --board-config board.yaml \
  --parameters aws-dashboard-parameters.json \
  --output aws-dashboard-release

For ECS, the persisted parameters select the ECS template and package also requires an immutable, digest-pinned image through --image. The generated deployment.json contains structured upload and CloudFormation command arguments for the approved deployment process to invoke.

package writes release-specific parameters.json, deployment.json, and template.yml, plus lambda.zip for Lambda. Changing board.yaml or the pinned package version uses this same path. Run the read-only bootstrap check before every deployment.

Private source credentials

Public GitHub repositories and unauthenticated HTTP sources work without credentials. For private sources, set SecretReference to the ARN of one consumer-owned Secrets Manager JSON value or Parameter Store SecureString, for example:

{ "GITHUB_TOKEN": "github_pat_…" }

The board references GITHUB_TOKEN through token_env; the credential value never belongs in the board, bootstrap manifest, CloudFormation parameters, runtime environment variables, logs, API responses, or browser. The runtime reads only the exact secret or parameter authorized by the application role, resolves configured token_env names only at Lambda cold start, and fails closed when a key is absent.

Ownership boundaries

Package responsibilityConsumer responsibility
Board validation and release packagingBoard content and source permissions
Server runtime and application templatesAWS account and network administration
Restricted bootstrap templatesReviewing and executing AWS changes
Default immutable client asset selectionApproval of alternate asset hosts
Read-only preflight, doctor, and consistency checksGateway, authentication, and health checks
Exact secret-resource integrationSecret values, rotation, and credential-map ARN

Bootstrap commands do not perform mutating AWS operations. They emit plans, parameters, captures, and command arguments for an administrator to review and invoke. bootstrap check is the read-only live diagnostic used before routine deployments; when it fails, use the bootstrap upgrade runbook.

References

版本与发布记录

@continuous-excellence/ze-great-dashboard-aws 共发布 182 个版本,首次发布于 2026/08/19;过去 12 个月发布了 182 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.31.63latest2026/11/10今天
0.31.622026/11/091 天前
0.31.612026/11/082 天前
0.31.602026/11/073 天前
0.31.592026/11/064 天前
0.31.582026/11/055 天前

关于 @continuous-excellence/ze-great-dashboard-aws 的常见问题

@continuous-excellence/ze-great-dashboard-aws 是什么?

AWS server runtime and CloudFormation deployment tooling for Ze Great Dashboard.

如何安装 @continuous-excellence/ze-great-dashboard-aws?

在项目目录运行 npm install @continuous-excellence/ze-great-dashboard-aws,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ze-great-dashboard-aws,可以用 npx ze-great-dashboard-aws 直接运行。

@continuous-excellence/ze-great-dashboard-aws 支持 TypeScript 吗?

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

@continuous-excellence/ze-great-dashboard-aws 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@continuous-excellence/ze-great-dashboard-aws 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@continuous-excellence/ze-great-dashboard-aws 可以商用吗?

@continuous-excellence/ze-great-dashboard-aws 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@continuous-excellence/ze-great-dashboard-aws 的下载量有多少?

根据 npm 官方下载统计,@continuous-excellence/ze-great-dashboard-aws 在 2026/10/11 – 2026/11/09 这 30 天内被下载 6,209 次,日均约 207 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@continuous-excellence/ze-great-dashboard-aws 还在维护吗?

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