更新时间:2025-04-18 GMT+08:00

ccictl edit

操作背景

用默认编辑器编辑资源。

  • edit 命令允许您直接编辑可通过命令行工具检索的任何 API 资源。 它将打开由 EDITOR 环境变量定义的编辑器,或者回退到使用 Linux 的 "vi" 或 Windows 的 "notepad"。 当尝试打开编辑器时,它将首先尝试使用 "SHELL" 环境变量中定义的 shell。 如果未定义,将使用默认的 shell,在 Linux 中为 "/bin/bash",在 Windows 中为 "cmd"。
  • 您可以编辑多个对象,但一次只会应用一个更改。该命令接受文件名和命令行参数,尽管您指向的文件必须是以前保存的资源版本。
  • edit 是通过用于获取资源的 API 版本完成的。要编辑特定 API 版本的资源,请完全限定资源、版本和组。
  • 默认格式为 YAML。要以 JSON 格式进行编辑,请指定 "-o json"。
  • --windows-line-endings 标志可用于强制 Windows 行结束,否则将使用操作系统的默认值。
  • 如果更新时发生错误,将在磁盘上创建一个临时文件,其中包含未应用的更改。 更新资源时最常见的错误是另一个编辑器更改了服务器上的资源。发生这种情况时, 您必须在应用到较新版本的资源进行更新,或更新临时保存的副本以包含最新的资源版本。
ccictl edit (RESOURCE/NAME | -f FILENAME)

示例

# 编辑名为 "registry" 的 Service
ccictl edit svc/registry

# 使用替代编辑器
EDITOR="nano" ccictl edit svc/registry

# 使用 cci/v2 API 格式编辑 JSON 中的 Deployment "mydeploy"
ccictl edit deployment.v2.cci/mydeploy -o json

# 在 YAML 中编辑 Deployment "mydeployment" 并将修改后的配置保存在其注解中
ccictl edit deployment/mydeployment -o yaml --save-config

选项

-f, --filename strings

用于编辑资源的文件名、目录或文件 URL 的列表。

-h, --help

关于 edit 的帮助信息。

-o, --output string

输出格式。可选值为: json、yaml。

--output-patch

如果资源被编辑,则输出补丁。

-R, --recursive

递归处理在 -f、--filename 中给出的目录。当您想要管理位于同一目录中的相关清单时很有用。

--save-config

如果为 true,则当前对象的配置将被保存在其注解中。否则,注解将保持不变。 当您希望后续对此对象执行 `ccictl apply` 操作时,此标志很有用。

--validate string[="strict"]     默认值:"strict"

必须是以下选项之一:strict(或 true)、warn、ignore(或 false)。 "true" 或 "strict" 将使用模式定义来验证输入,如果无效,则请求失败。 "false" 或 "ignore" 将不会执行任何模式定义检查,而是静默删除所有未知或重复的字段。

--windows-line-endings

默认为您所用平台原生的行结尾格式。

ccictl选项亦可在子命令中生效,列表如下:

父命令ccictl选项列表