贺龙云
这个包提供了代理工具,用于创建Heroku apps,部署源入的tarball,提供附加,检索最近日志,并缩放dynos. 它使用有无记名签名认证的Heroku平台API.
安装
npm install @framers/agentos-ext-cloud-heroku
同伴依赖 : @framers/agentos 有范围 >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-cloud-heroku',
options: {
apiKey: process.env.HEROKU_API_KEY,
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
apiKey | heroku.apiKey | HEROKU_API_KEY | 对 | 空字符串 |
secrets | 没有 | context.secrets,则 {} |
明确选项优先于秘密,然后是环境变量. options.secrets 优先于 context.secrets。 。 。 .
工具
| 工具 | 它会做什么 |
|---|---|
herokuCreateApp | 创建可选名称、区域、堆栈和初始配置变量的应用程序. |
herokuDeployApp | 部署源 tarball URL,并选择先更新配置变量. |
herokuAddAddon | 从计划标识中添加一个附加. |
herokuGetLogs | 使用可选的断层和源过滤器获取最近的日志输出 . |
herokuScaleDynos | 调整进程类型的干燥量和大小. |
herokuCreateApp
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
name | 字符串 | 没有 | App名称,如果省略则自动生成;小写字母和连字符. |
region | 字符串 : us, (中文(简体) ), eu | 没有 | 部署区域, 计划描述默认 us。 。 。 . |
stack | 字符串 | 没有 | 堆栈名, 描述为默认到最近 . |
configVars | 对象 | 没有 | 初始环境或配置变量作为密钥值对. |
herokuDeployApp
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | 调用用户名. |
sourceUrl | 字符串 | 对 | 来源焦油球的URL, .tar.gz准备部署. |
version | 字符串 | 没有 | 构建版本标签,例如Git SHA或semver标签. |
configVars | 对象 | 没有 | 配置变量在部署前设置为密钥值对 . |
herokuAddAddon
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | App来添加加词. |
plan | 字符串 | 对 | Addon计划标识符. |
addonName | 字符串 | 没有 | 自定义添加实例的名称 . |
config | 对象 | 没有 | 添加特性配置作为键值对. |
herokuGetLogs
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | 获取日志的应用程序 . |
lines | 编号 | 没有 | 近期取回的日志行,默认为100,计划描述最多为1500. |
dyno | 字符串 | 没有 | 过滤到特定的阴道 . |
source | 字符串 | 没有 | 日志来源, app 申请或申请 heroku 为平台日志. |
herokuScaleDynos
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | 应用到规模. |
type | 字符串 | 对 | 进程类型,例如 web, (中文(简体) ), worker,或 clock。 。 。 . |
quantity | 编号 | 对 | Dynos 要运行此进程类型, 0 要停止 . |
size | 字符串 | 没有 | Dyno 大小, 例如 : eco, (中文(简体) ), basic, (中文(简体) ), standard-1x, (中文(简体) ), standard-2x, (中文(简体) ), performance-m,或 performance-l。 。 。 . |
页:1
API 密钥缺失时激活失败, 通过获取账户信息验证所提供的密钥 .
创建远程资源应用程序并设定非空置 configVars 创建后。 请求中忽略了名称,区域,或堆栈;区域和堆栈默认出现在计划描述中,而不是由服务指定.
部署需要一个已有的应用软件和一个源头柏油球的URL. 它更新非空的 configVars 在提交远程建设和返回建设状态之前,无需等待完成.
添加提供请求选中的计划并返回计划的价格元数据 。 Dyno缩放改变远程阵型. 缩放工具不验证 quantity 作为非负整数或限制 size 到一个矿井.
日志检索创建日志会话 tail 设置为 false,获取其 URL,并返回日志文本和 logplexUrl。该工具不强制执行图解描述 lines 上限。 失败的日志获取返回一个错误 .
导出时可使用 App 删除 HerokuService,但包不注册应用程序删除工具.
许可证
阿帕奇 - 2.0