GitOps CLI (argocd) リファレンス
GitOps CLI を設定し、デフォルトモードで Argo CD サーバーにログインする
概要
第1章 GitOps CLI の設定 リンクのコピーリンクがクリップボードにコピーされました!
Red Hat OpenShift GitOps argocd CLI ツールはテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品サポートのサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではない場合があります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
GitOps argocd CLI を設定してタブ補完を有効にできます。
1.1. タブ補完の有効化 リンクのコピーリンクがクリップボードにコピーされました!
GitOps argocd CLI をインストールした後、タブ補完を有効にして、Tab キーを押したときに argocd コマンドを自動的に補完したり、オプションを提案したりすることができます。
タブ補完は Bash シェルにのみ存在します。
前提条件
-
GitOps
argocdCLI ツールがインストールされている。 -
ローカルシステムに
bash-completionがインストールされている。
手順
次の手順では、Bash シェルのタブ補完を有効にします。
Bash 補完コードをファイルに保存します。
argocd completion bash > argocd_bash_completion
$ argocd completion bash > argocd_bash_completionCopy to Clipboard Copied! Toggle word wrap Toggle overflow ファイルを
/etc/bash_completion.d/にコピーします。sudo cp argocd_bash_completion /etc/bash_completion.d/
$ sudo cp argocd_bash_completion /etc/bash_completion.d/Copy to Clipboard Copied! Toggle word wrap Toggle overflow または、ファイルをローカルディレクトリーに保存した後に、これを
.bash_profileファイルから取得できるようにすることができます。
タブ補完は、新規ターミナルを開くと有効にされます。
第2章 デフォルトモードで Argo CD サーバーへのログイン リンクのコピーリンクがクリップボードにコピーされました!
Red Hat OpenShift GitOps argocd CLI ツールはテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品サポートのサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではない場合があります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
GitOps argocd CLI と Argo CD 認証情報を使用してデフォルトモードで Argo CD サーバーにログインし、コマンドを実行できます。
2.1. Argo CD サーバーへのログイン リンクのコピーリンクがクリップボードにコピーされました!
GitOps argocd CLI をインストールして設定した後、Argo CD サーバーにログインして、デフォルトモードでコマンドを実行する必要があります。
前提条件
-
GitOps
argocdCLI ツールをインストールして設定している。
手順
ログインするには認証情報を使用し、セッション中はログインしたままにする必要があります。
If the login session times out, you can use the `relogin` command to log in again. When done using the `argocd` commands, you can log out using the `logout` command.
If the login session times out, you can use the `relogin` command to log in again. When done using the `argocd` commands, you can log out using the `logout` command.
Argo CD サーバーの
adminアカウントのパスワードを取得します。ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster -n openshift-gitops -o jsonpath='{.data.admin\.password}' | base64 -d)$ ADMIN_PASSWD=$(oc get secret openshift-gitops-cluster -n openshift-gitops -o jsonpath='{.data.admin\.password}' | base64 -d)Copy to Clipboard Copied! Toggle word wrap Toggle overflow Argo CD サーバーの URL を取得します。
SERVER_URL=$(oc get routes openshift-gitops-server -n openshift-gitops -o jsonpath='{.status.ingress[0].host}')$ SERVER_URL=$(oc get routes openshift-gitops-server -n openshift-gitops -o jsonpath='{.status.ingress[0].host}')Copy to Clipboard Copied! Toggle word wrap Toggle overflow adminアカウントのパスワードを使用して Argo CD サーバーにログインし、一重引用符で囲みます。重要パスワードを一重引用符で囲むと、
$などの特殊文字がシェルによって誤って解釈されなくなります。パスワードのリテラル値を囲むには常に一重引用符を使用してください。argocd login --username admin --password ${ADMIN_PASSWD} ${SERVER_URL}$ argocd login --username admin --password ${ADMIN_PASSWD} ${SERVER_URL}Copy to Clipboard Copied! Toggle word wrap Toggle overflow 例
argocd login --username admin --password '<password>' openshift-gitops.openshift-gitops.apps-crc.testing
$ argocd login --username admin --password '<password>' openshift-gitops.openshift-gitops.apps-crc.testingCopy to Clipboard Copied! Toggle word wrap Toggle overflow ログインが成功すると、セッションコンテキストが次のように表示されます。
出力例
'admin:login' logged in successfully Context '<server_url>' updated
'admin:login' logged in successfully Context '<server_url>' updatedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
第3章 GitOps argocd CLI リファレンス リンクのコピーリンクがクリップボードにコピーされました!
Red Hat OpenShift GitOps argocd CLI ツールはテクノロジープレビュー機能のみです。テクノロジープレビュー機能は、Red Hat 製品サポートのサービスレベルアグリーメント (SLA) の対象外であり、機能的に完全ではない場合があります。Red Hat は、実稼働環境でこれらを使用することを推奨していません。テクノロジープレビュー機能は、最新の製品機能をいち早く提供して、開発段階で機能のテストを行いフィードバックを提供していただくことを目的としています。
Red Hat のテクノロジープレビュー機能のサポート範囲に関する詳細は、テクノロジープレビュー機能のサポート範囲 を参照してください。
このセクションでは、基本的な GitOps argocd CLI コマンドをリストします。
3.1. 基本的な構文 リンクのコピーリンクがクリップボードにコピーされました!
GitOps argocd CLI は、コマンドラインから Red Hat OpenShift GitOps と Argo CD リソースを設定および管理するためのツールです。
3.1.1. デフォルトモード リンクのコピーリンクがクリップボードにコピーされました!
デフォルトモードでは、argocd CLI クライアントは API 要求を通じて Argo CD サーバーコンポーネントと通信します。コマンドを実行するには、Argo CD の認証情報を使用して Argo CD サーバーにログインし、セッション中はログインしたままにする必要があります。ログインセッションがタイムアウトした場合は、relogin コマンドを使用して再度ログインできます。argocd コマンドの使用が完了したら、logout コマンドを使用してログアウトできます。
コマンド構文
argocd [command or options] [arguments…]
3.1.2. コアモード リンクのコピーリンクがクリップボードにコピーされました!
このモードでは、CLI は kubeconfig ファイルに設定された認証情報を通じて Kubernetes API サーバーと直接通信します。デフォルトの kubeconfig ファイルは、$HOME/.kube/config にあります。KUBECONFIG 環境変数を使用してこのファイルをカスタマイズできます。core モードでコマンドを実行するには、--core 引数を使用でき、ユーザー認証のために Argo CD サーバーにログインする必要はありません。
<argocd-instance-name>-repo-server 形式で Repo サーバーコンポーネント名を指定するには、--repo-server-name コマンドラインオプションを使用するか、ARGOCD_REPO_SERVER_NAME 環境変数を設定します。
コマンド構文
KUBECONFIG=~/.kube/config argocd --core [command or options] [arguments…]
core モードで argocd コマンドを実行するには、次のいずれかのオプションを選択できます。
複数の Argo CD インスタンスが使用されている場合は、現在のコンテキストのデフォルトの namespace を、対話する ArgoCD インスタンスの namespace に設定します。
デフォルトのコンテキストを持つデフォルトの
kubeconfigファイル:argocd --core [command or options] [arguments…]例 1: アプリケーションのリストを表示する
argocd --core app list --repo-server-name openshift-gitops-repo-server
$ argocd --core app list --repo-server-name openshift-gitops-repo-serverCopy to Clipboard Copied! Toggle word wrap Toggle overflow 例 2: アプリケーションのリストを表示する
ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server argocd --core app list
$ ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server argocd --core app listCopy to Clipboard Copied! Toggle word wrap Toggle overflow カスタムコンテキストを持つデフォルトの
kubeconfigファイル:argocd --core --kube-context [context] [command or options] [arguments…]例 1: アプリケーションのリストを表示する
argocd --core --kube-context kubeadmin-local app list --repo-server-name openshift-gitops-repo-server
$ argocd --core --kube-context kubeadmin-local app list --repo-server-name openshift-gitops-repo-serverCopy to Clipboard Copied! Toggle word wrap Toggle overflow 例 2: アプリケーションのリストを表示する
ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server argocd --core --kube-context kubeadmin-local app list
$ ARGOCD_REPO_SERVER_NAME=openshift-gitops-repo-server argocd --core --kube-context kubeadmin-local app listCopy to Clipboard Copied! Toggle word wrap Toggle overflow デフォルトのコンテキストを持つカスタム
kubeconfigファイル:KUBECONFIG=~/.kube/custom_config argocd --core [command or options] [arguments…]例: アプリケーションのリストを表示する
KUBECONFIG=~/.kube/custom_config argocd --core app list --repo-server-name openshift-gitops-repo-server
$ KUBECONFIG=~/.kube/custom_config argocd --core app list --repo-server-name openshift-gitops-repo-serverCopy to Clipboard Copied! Toggle word wrap Toggle overflow カスタムコンテキストを持つカスタム
kubeconfigファイル:KUBECONFIG=~/.kube/custom_config argocd --core --kube-context [context] [command or options] [arguments…]例: アプリケーションのリストを表示する
KUBECONFIG=~/.kube/custom_config argocd --kube-context kubeadmin-local --core app list --repo-server-name openshift-gitops-repo-server
$ KUBECONFIG=~/.kube/custom_config argocd --kube-context kubeadmin-local --core app list --repo-server-name openshift-gitops-repo-serverCopy to Clipboard Copied! Toggle word wrap Toggle overflow
3.2. グローバルオプション リンクのコピーリンクがクリップボードにコピーされました!
グローバルオプションは、argocd のすべてのサブコマンドに適用できます。
| オプション | 引数のタイプ | 説明 |
|---|---|---|
|
|
| 認証トークン。 |
|
|
| クライアント証明書ファイル。 |
|
|
| クライアント証明書キーファイル。 |
|
|
|
Argo CD 設定ファイルへのパス。デフォルトは |
|
|
|
デフォルトのラベルとして
このコンポーネントの名前のラベルがデフォルトと異なる場合 (たとえば、Helm チャートを通じてインストールする場合)、 |
|
| 該当なし |
|
|
| 該当なし | Argo CD サーバーの gRPC-Web プロトコルを有効にします。これは、たとえば、サーバーが HTTP/2 プロトコルをサポートしていないプロキシーの背後にある場合に便利です。 |
|
|
| Argo CD サーバーの gRPC-Web プロトコルを有効にします。これは、たとえば、サーバーが HTTP/2 プロトコルをサポートしていないプロキシーの背後にある場合に便利です。Web ルートを設定します。 |
|
|
|
GitOps |
|
| 該当なし |
GitOps |
|
|
| Argo CD サーバーへの HTTP 接続を確立するための最大再試行回数を設定します。 |
|
| 該当なし | サーバー証明書とドメイン検証をスキップします。 |
|
|
| 指定された kube コンテキストにコマンドを送信します。 |
|
|
|
ログ形式をテキストまたは JSON に設定します。デフォルトは |
|
|
|
ログレベルを設定します。デフォルトは |
|
| 該当なし | Transport Layer Security (TLS) プロトコルを無効にします。 |
|
| 該当なし | ポート転送を使用してランダムな Argo CD サーバーポートに接続します。 |
|
|
| ポート転送に使用する namespace の名前。 |
|
|
|
このデプロイメントの名前のラベルがデフォルトと異なる場合 (たとえば、Helm チャートを通じて HAProxy をインストールする場合) は、 |
|
|
|
デフォルトのラベルとして
このデプロイメントの名前のラベルがデフォルトと異なる場合 (たとえば、Helm チャートを通じてインストールする場合) は、 |
|
|
|
デフォルトのラベルとして
この Repo サーバーの名前のラベルがデフォルトと異なる場合 (たとえば、Helm チャートを通じてインストールする場合)は、 |
|
|
| Argo CD サーバーのアドレス。 |
|
|
| サーバーの証明書ファイル。 |
|
|
|
デフォルトのラベルとして
この Argo CD API サーバーの名前のラベルがデフォルトと異なる場合 (たとえば、Helm チャートを通じてインストールする場合) は、 |
3.3. ユーティリティーコマンド リンクのコピーリンクがクリップボードにコピーされました!
3.3.1. argocd リンクのコピーリンクがクリップボードにコピーされました!
GitOps argocd CLI の親コマンド。
例: すべてのオプションの表示
argocd
$ argocd
3.3.2. version リンクのコピーリンクがクリップボードにコピーされました!
CLI のバージョン情報を出力します。
コマンド構文
argocd version [flags]
例: クライアントとサーバーの完全なバージョンを標準出力に出力する
argocd version
$ argocd version
例: クライアントのフルバージョンのみを出力し、サーバーへの接続は行われない
argocd version --client
$ argocd version --client
例: サーバーのフルバージョンのみを出力する
argocd version --server <server_url>
$ argocd version --server <server_url>
例: クライアントとサーバーの完全なバージョンを JSON 形式で出力する
argocd version -o json
$ argocd version -o json
例: クライアントとサーバーのコアバージョン文字列のみを YAML 形式で出力する
argocd version --short -o yaml
$ argocd version --short -o yaml
3.3.3. help リンクのコピーリンクがクリップボードにコピーされました!
アプリケーション内の任意のコマンドに関するヘルプメッセージを出力します。
コマンド構文
argocd help [command] [flags]
例: 利用可能なすべてのコマンドのヘルプテキストを取得する
argocd help
$ argocd help
例: admin サブコマンドのヘルプテキストを取得する
argocd help admin
$ argocd help admin
3.3.4. completion リンクのコピーリンクがクリップボードにコピーされました!
bash または zsh シェルの補完コードを標準出力に書き込みます。
コマンド構文
argocd completion SHELL [flags]
bash の場合は、Bash 補完がインストールされ、有効になっていることを確認してください。または、ファイルに書き込んで、.bash_profile でソース化します。
例: 現在のシェルでのアクセス補完
source <(argocd completion bash)
# source <(argocd completion bash)
zsh の場合は、Bash 補完がインストールされ、有効になっていることを確認してください。
例: ~/.zshrc ファイルに追加し、現在のシェルで補完にアクセスする
source <(argocd completion zsh) compdef _argocd argocd
source <(argocd completion zsh)
compdef _argocd argocd