铁道云
此包提供了代理工具,用于创建或重新部署服务,列出项目和服务,提供数据库插件,并通过铁路GraphQL API检索部署或构建日志.
安装
npm install @framers/agentos-ext-cloud-railway
同伴依赖 : @framers/agentos >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-cloud-railway',
options: {
token: process.env.RAILWAY_TOKEN,
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
token | railway.token | RAILWAY_TOKEN | 对 | 空字符串 |
secrets | railway.token | 无 | 没有 | A. 背景情况 secrets空对象 |
符号解析自 options.token,然后是环境变量. options.secrets 优先于上下文 secrets。 。 。 .
工具
| 工具 | 它会做什么 |
|---|---|
railwayDeployService | 从 GitHub 寄存器创建服务,或用可选的环境变量来重新部署现有的服务. |
railwayListServices | 列出项目及其环境和服务,可选择通过项目ID过滤. |
railwayAddDatabase | 在工程中提供 PostgreSQL, Redis, MySQL, 或MongoDB 数据库插件 . |
railwayGetLogs | 检索有时间标记的部署或建立有严重程度的日志条目. |
railwayDeployService
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
projectId | 字符串 | 没有 | 要部署的项目ID; 如果省略, 创建一个新项目 projectName 给出. |
projectName | 字符串 | 没有 | 新项目的名称, 仅在 projectId 省略. |
repo | 字符串 | 没有 | GitHub 仓库, 例如 user/repo;新服务需要说明. |
serviceName | 字符串 | 没有 | 服务名称. |
serviceId | 字符串 | 没有 | 现有服务ID用于重新部署并重建最新承诺. |
environmentId | 字符串 | 没有 | 用于重新部署的环境ID; 计划按需要描述 serviceId 和不生产. |
variables | 对象 | 没有 | 环境变量作为键值对. |
railwayListServices
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
projectId | 字符串 | 没有 | 过滤到工程 ID; 省略时列出所有工程 . |
railwayAddDatabase
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
projectId | 字符串 | 对 | 铁路项目ID将数据库添加到. |
plugin | 字符串 | 对 | 数据库类型 : postgresql, (中文(简体) ), redis, (中文(简体) ), mysql,或 mongodb。 。 。 . |
railwayGetLogs
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
deploymentId | 字符串 | 对 | 调取日志. |
type | 字符串 | 没有 | deploy 用于运行时间日志或 build 用于构建日志; 默认值 : deploy。 。 。 . |
页:1
活化需要有铁路API标志. 它询问当前用户,如果缺少了该令牌,请求失败,或者没有返回用户ID,则失败.
服务创建,项目创建,重新部署,数据库提供,可变更新都会修改远程资源.
调动需要两者 serviceId 财务报告和审定财务报表 environmentId 在处决中。 这条道路没有生产环境倒退。 没有这两个字段,工具创建服务,即使 serviceId 提供。 若为 projectId 不存在, 它使用 projectName 或生成基于时间戳的名称。 计划没有需要的字段,执行许可创建服务没有 repo。 。 。 .
对于新服务,变量在服务创建后被写入第一个非电流项目环境,或者第一个环境如果没有非电流环境. 如果没有环境, 变量写入会被跳过 。 对于重新部署,在启动重新部署之前先写出变量.
调动在不等待完成的情况下获得最新部署。 如果没有返回,则其身份是空的,其状态是 unknown。日志检索从 GraphQL 查询中返回一个数组.
许可证
阿帕奇 - 2.0