飞.io云
这个包提供了代理工具,可以部署多克图像,列出应用程序和机器,缩放机器,并在Fly.io上创建持续卷. 它使用机器 REST API 和 Fly.io GraphQL API 并带有无记名卡通认证.
安装
npm install @framers/agentos-ext-cloud-flyio
同伴依赖 : @framers/agentos 有范围 >=0.10.40。 。 。 .
使用量
import { AgentOS } from '@framers/agentos';
const agentos = await AgentOS.create({
extensionManifest: {
packs: [
{
package: '@framers/agentos-ext-cloud-flyio',
options: {
token: process.env.FLY_API_TOKEN,
},
},
],
},
});
配置
| 选项 | 秘密编号 | 环境变量 | 需求 | 默认 |
|---|---|---|---|---|
token | fly.token | FLY_API_TOKEN | 对 | 空字符串 |
secrets | 没有 | context.secrets,则 {} |
明确选项优先于秘密,然后是环境变量. options.secrets 优先于 context.secrets。 。 。 .
工具
| 工具 | 它会做什么 |
|---|---|
flyDeployApp | 通过创建机器来部署 Docker 图像, 并在需要时创建应用程序 . |
flyListApps | 列出应用程序或检索一个命名的应用程序,并附有可选的机器细节. |
flyScaleApp | 创建、销毁或调整机器的大小,以达到理想的规模. |
flyCreateVolume | 创建默认加密的持续音量. |
flyDeployApp
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | 飞应用名. |
image | 字符串 | 对 | 要部署多克图像 . |
region | 字符串 | 没有 | Fly区域代码,被描述为默认到最接近. |
cpus | 编号 | 没有 | CPU,默认 1. |
cpuKind | 字符串 : shared, (中文(简体) ), performance | 没有 | CPU 类型, 默认 shared。 。 。 . |
memoryMb | 编号 | 没有 | MB中的内存,默认为256. |
env | 对象 | 没有 | 环境变量作为键值对. |
internalPort | 编号 | 没有 | 内部应用端口,默认为8080. |
autoDestroy | 布尔 | 没有 | 机器退出时销毁, 默认 false。 。 。 . |
createApp | 布尔 | 没有 | 如果应用程序不存在, 则创建默认 true。 。 。 . |
org | 字符串 | 没有 | 飞行组织 swit, 默认 personal。 。 。 . |
flyListApps
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 没有 | 过滤到一个命名的应用程序;省略它列出的应用程序. |
includeMachines | 布尔 | 没有 | 包含每个应用程序的机器细节, 默认 true。 。 。 . |
flyScaleApp
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | 应用名称缩放 . |
count | 编号 | 对 | 渴望的机器, 零被称为停止一切. |
cpus | 编号 | 没有 | 每台新机或更大小机的CPU. |
cpuKind | 字符串 : shared, (中文(简体) ), performance | 没有 | 用于新机或改型机的CPU类型. |
memoryMb | 编号 | 没有 | 每台新机或改型机的内存为MB. |
region | 字符串 | 没有 | 新机器的区域. |
flyCreateVolume
| 参数 | 类型 | 需求 | 说明 |
|---|---|---|---|
appName | 字符串 | 对 | 用于创建音量的 App . |
name | 字符串 | 对 | 挂载配置中使用的卷名 . |
region | 字符串 | 对 | 量区,必须同机区相匹配. |
sizeGb | 编号 | 对 | GB中的音量大小,描述为最小 1. |
encrypted | 布尔 | 没有 | 加密音量, 默认值 true。 。 。 . |
页:1
缺少指针时激活失败, 通过 GraphQL 验证所提供的指针 currentUser 查询。 没有用户ID的响应失败激活 .
部署从现有的 Docker 图像创建远程应用程序和机器 。 它暴露出HTTP和HTTPS,使HTTP能够自动起站停站,并重定向到HTTPS. 省略一个 region 不包括在请求中。 与 createApp 设置为 false,一个失败的应用程序查找返回一个错误.
缩小停止和摧毁多余的机器,包括所有机器 count 为零。 缩放已存在的第一台机器的配置;如果没有一台已存在的机器,它就会发出一幅空图像. 调整大小发送来宾配置更新. 该工具不验证 count 作为非负整数.
音量创建提供远程存储而不将其附加在机器上. 所描述的最小尺寸在当地没有执行.
当没有应用程序上市时 appName机器搜索失败 成为该应用程序的空机器列表 。 一个命名的应用程序的机器搜索失败返回一个错误 .
许可证
阿帕奇 - 2.0