Docs 菜单
Docs 主页
/ /
Atlas CLI

使用 Atlas CLI 实现流程自动化

在此页面上

  • 使用 Atlas CLI 实现自动化的资源
  • 使用 Atlas CLI 实现自动化的最佳实践
  • 使用 Atlas 私钥
  • 让您的脚本基于您运行的 Atlas CLI 版本
  • 重定向 stderr
  • 定期更新脚本

要在脚本中使用 Atlas CLI 自动执行流程,请使用以下资源和最佳实践作为指导。

要了解如何以编程方式连接到 Atlas CLI,请参阅从 Atlas CLI 连接上的 Programmatic User标签页。

Resource
目标
设置环境变量,您只需定义一次即可将其用于所有脚本。
使用 Go 模板或 JSON路径自定义 Atlas CLI 的输出。 您可以在脚本中包含预期的自定义输出。

使用 Atlas CLI 自动执行流程时,请遵循以下最佳实践:

当您创建脚本以自动化流程时,我们建议您使用 Atlas 私钥来访问 Atlas。 Atlas CLI 登录会话持续 12 小时,之后您必须再次登录才能访问 Atlas。 使用 Atlas私钥继续访问 Atlas。

当您创建用于自动化流程的脚本时,您应基于当前运行的 Atlas CLI 版本创建脚本。 请勿在脚本中构建 Atlas CLI 的自动升级,因为新的 Atlas CLI 版本可能会引入重大更改,从而破坏自动化流程。

相反,在手动升级 Atlas CLI 版本之前,请查看发布说明以了解已弃用的功能和破坏性变更 (breaking change)。

Atlas CLI 会在命令输出中显示错误消息和命令弃用警告。这些意料之外的错误消息和警告可能会给预期特定输出的自动化流程带来问题。为防止出现问题,可将 stderr 重定向到脚本中的输出文件。

例如,以下命令将名为 myScript.sh 的脚本的 stderr 输出重定向到名为 error.txt 的文本文件中:

myScript.sh 2> error.txt

在前面的示例中,所有错误消息和弃用警告都存储在 error.txt 中,并且不会显示在输出中,因此它们不会中断您的自动化流程。

命令弃用消息类似于以下文本:

Command "describe" is deprecated, Please use atlas privateEndpoints aws interfaces describe <atlasPrivateEndpointId> [--privateEndpointId privateEndpointID] [--projectId projected]

您应该定期更新脚本以停止使用已弃用的命令,因为这些命令会从未来的版本中删除。您可以从 Atlas CLI 更新日志中了解哪些命令已被弃用。如果您为 stderr 设置了重定向文件,则还可以检查该文件中是否有弃用警告。

后退

邀请