Atlas CLI によるプロセスの自動化
項目一覧
スクリプト内で Atlas CLI を使用してプロセスを自動化するには、次のリソースとベストプラクティスをガイダンスとして使用します。
Atlas CLI にプログラムで接続する方法については、「 Atlas CLI からの接続 」の Programmatic Userタブを参照してください。
Atlas CLI によるオートメーションに関するリソース
Resource | 目的 |
|---|---|
一度定義してすべてのスクリプトで使用できる環境変数を設定します。 | |
Go テンプレートまたは JSONパスを使用して、Atlas CLI からの出力をカスタマイズします。 予想されるカスタム出力をスクリプトに含めることができます。 |
Atlas CLI によるオートメーションのベストプラクティス
Atlas CLI を使用してプロセスを自動化する場合は、次のベストプラクティスに従ってください。
Atlas 秘密キーの使用
プロセスを自動化するスクリプトを作成する場合は、Atlas 秘密キーを使用して Atlas にアクセスすることをお勧めします。 Atlas CLI ログイン セッションは 12 時間継続され、その後 Atlas にアクセスするには再度ログインする必要があります。 Atlas への継続的なアクセスには Atlas秘密キーを使用します。
実行する Atlas CLI のバージョンに基づくスクリプトのベースとなる
プロセスを自動化するためのスクリプトを作成する場合は、現在実行している Atlas CLI のバージョンに基づいてスクリプトを作成する必要があります。 新しい Atlas CLI のリリースにより重大な変更が導入され、自動プロセスが中断される可能性があるため、Atlas CLI の自動アップグレードをスクリプトにビルドしないでください。
代わりに、Atlas CLI のバージョンを手動でアップグレードする前に、非推奨機能や重大な変更のリリースノートを確認してください。
リダイレクト stderr
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 のリダイレクト ファイルを設定する場合は、そのファイルで非推奨警告を確認することもできます。