huawei-cloud-kubectl-cce-installer

Huawei Cloud CCE Kubectl リソースクエリ

このスキルを使用すると、kubectl cce を通じて特定の CCE Kubernetes リソースを取得できます。主なタスクはリソースへのアクセスです。ローカルへのインストールは、kubectl または kubectl-cce プラグインが利用できない場合に限り、前提条件を復旧するための手順です。

概要と安全性

• kubectl cce を使用してください。Kubernetes API クライアントを直接使用しないでください。
• 読み取り専用コマンドのみを使用してください：get、describe、logs。
• -A、--all-namespaces、またはクラスター全体を対象とするその他のリソースクエリを実行しないでください。
• 名前空間スコープのリソースでは、--namespace <namespace> を必須とし、可能であれば特定のリソース名も指定してください。
• node、namespace、persistentvolume、storageclass などのクラスター スコープのリソースでは、正確なリソース名を必須としてください。すべてのインスタンスを一覧表示しないでください。
• apply、create、delete、edit、patch、replace、scale、rollout、cordon、drain、exec は実行しないでください。
• 認証情報、トークン、kubeconfig の内容、Secret データを出力しないでください。

前提条件と必要なコンテキスト

入力	要件
cluster_id	標準 UUID が必須です。正確な名前は hcloud CCE ListClusters で解決できますが、UUID が 1 つに確定するまでは kubectl cce を実行しないでください。
region	必須です。リクエストまたは現在のコンテキストから取得し、次に HW_REGION_NAME を確認してください。どちらからも取得できない場合は、ユーザーに確認してください。
リソース種別	必須です。例：pod、deployment、service、configmap、node。
名前空間または正確な名前	どちらか一方が必須です。名前空間スコープのリソースには名前空間が必要です。クラスター スコープのリソースには正確な名前が必要です。

認証情報には plugin-usage.md のプラグインルールを適用してください。呼び出し元から提供された場合に限り、明示的な --cli-access-key、--cli-secret-key、および任意の --cli-security-token を使用してください。その場合、他の認証情報にフォールバックしないでください。

ワークフロー

1. リソースをクエリする前に、対象のリージョンとクラスター ID を検証してください。どちらかが不足している場合、またはクラスター ID をそのリージョンに存在する単一の UUID に解決できない場合は、kubectl cce を実行せず、正しいリージョンとクラスター ID をユーザーに確認してください。

2. リソース種別、名前空間、および必要な場合は正確なリソース名を確認してください。

3. ローカルの前提条件を確認してください。

   bash scripts/install_kubectl_cce.sh --check
   

4. kubectl と kubectl-cce の両方が利用可能な場合は、要求されたリソースをクエリしてください。

5. どちらかの実行ファイルが不足している場合は、installation.md を読み、インストーラーの計画を提示してください。インストールまたは置き換えは R1 のローカル変更にあたり、明示的な確認が必要です。

   bash scripts/install_kubectl_cce.sh --bin-dir <directory>
   sudo bash scripts/install_kubectl_cce.sh --execute --bin-dir <directory>
   

6. kubectl version --client と kubectl plugin list でインストールを確認してから、要求された読み取り専用のリソースクエリのみを実行してください。

基本コマンド

名前空間スコープのクエリでは、明示的な名前空間を 1 つ指定してください。

kubectl cce --cluster-id <cluster-id> --region <region> \
  get pod <pod-name> --namespace <namespace> -o yaml

kubectl cce --cluster-id <cluster-id> --region <region> \
  describe deployment <deployment-name> --namespace <namespace>

kubectl cce --cluster-id <cluster-id> --region <region> \
  get service <service-name> --namespace <namespace> -o yaml

クラスター スコープのリソースでは、正確な名前を指定してください。

kubectl cce --cluster-id <cluster-id> --region <region> \
  get node <node-name> -o yaml

認証情報のモード、コマンド形式、x509 の再試行動作については、plugin-usage.md を読んでください。Windows での使用方法とインストールの代替手段については、installation.md を読んでください。コマンドが x509 によるアップストリーム TLS 検証エラーで失敗した場合は、同じコマンドを cce の直後に --cce-insecure-upstream-tls=true を付けて 1 回だけ再試行してください。

リスクレベル

操作	レベル	ガイダンス
リソースクエリとローカルの前提条件チェック	R3	自動で実行できます。
ローカルバイナリのインストール、ソースからのビルド、プラグインの置き換え	R1	事前に内容を提示し、--execute の前に明示的な確認を得てください。

出力形式

クラスター ID、リージョン、リソース種別、該当する場合は名前空間、リソース名、および要求されたステータスまたはフィールドを返してください。リソースが見つからない、アクセスが拒否された、前提条件が不足している、またはインストールの確認が必要である場合は、明確に伝えてください。

パラメーターと確認

クエリを実行する前に、cluster_id、region、リソースの種類、名前空間、正確なリソース名を確認してください。cluster_id が指定されていない場合や、指定されたリージョンで解決できない場合は、処理を中止し、正しいリージョンとクラスター ID をユーザーに尋ねてください。--execute アクションを実行する前に、インストール先ディレクトリを確認してください。

検証

インストール後に kubectl version --client と kubectl plugin list を実行してください。クエリ後は、返されたリソースの識別情報が、指定されたクラスター、名前空間、名前と一致することを確認してください。

ベストプラクティス

要求された範囲に最も限定したリソースクエリを使用し、呼び出し元がクラスター全体にアクセスできる場合でも、広範な一覧表示操作は避けてください。

注意事項

要求されたリソースを名前空間または正確な名前で絞り込めない場合は、クラスター全体を対象とするクエリに範囲を広げるのではなく、対象を絞り込むようユーザーに尋ねてください。

参考資料

ドキュメント	用途
プラグインの使用方法	認証情報、コマンド形式、x509 の再試行。
インストール	ローカルの前提条件、インストーラーパラメーター、Windows での使用方法、ソースへのフォールバック、確認、トラブルシューティング。
受け入れ基準	リソースクエリとインストールの受け入れ確認。