kubectl を使用してバックエンドを作成します
バックエンドは、Tridentとストレージシステムの間の関係を定義します。Tridentは、そのストレージシステムとの通信方法や、Tridentがそのシステムからボリュームをプロビジョニングする方法を解説します。Tridentをインストールしたら、次の手順でバックエンドを作成します。 TridentBackendConfig`Custom Resource Definition(CRD)を使用すると、Kubernetesインターフェイスから直接Tridentバックエンドを作成および管理できます。これは、またはKubernetesディストリビューション用の同等のCLIツールを使用して実行できます `kubectl
。
TridentBackendConfig
TridentBackendConfig
(tbc
, tbconfig
, tbackendconfig
)は、を使用してTridentバックエンドを管理できるフロントエンドの名前空間CRDです。 `kubectl`Kubernetes管理者やストレージ管理者は、Kubernetes CLIを使用して直接バックエンドを作成、管理できるようになりまし(`tridentctl`た。専用のコマンドラインユーティリティは必要ありません)。
「 TridentBackendConfig 」オブジェクトを作成すると、次のようになります。
-
バックエンドは、指定した設定に基づいてTridentによって自動的に作成されます。これは内部的には (
tbe
、tridentbackend
)CRとして表され `TridentBackend`ます。 -
は
TridentBackendConfig
、Tridentによって作成されたに一意にバインドされますTridentBackend
。
各「 TridentBackendConfig 」は、「 TridentBackend 」を使用して 1 対 1 のマッピングを維持します。前者はバックエンドの設計と構成をユーザに提供するインターフェイスで、後者は Trident が実際のバックエンドオブジェクトを表す方法です。
`TridentBackend`CRSはTridentによって自動的に作成されます。これらは * 変更しないでください。バックエンドを更新するには、オブジェクトを変更し `TridentBackendConfig`ます。 |
「 TridentBackendConfig 」 CR の形式については、次の例を参照してください。
apiVersion: trident.netapp.io/v1 kind: TridentBackendConfig metadata: name: backend-tbc-ontap-san spec: version: 1 backendName: ontap-san-backend storageDriverName: ontap-san managementLIF: 10.0.0.1 dataLIF: 10.0.0.2 svm: trident_svm credentials: name: backend-tbc-ontap-san-secret
の例を確認することもできます "Trident インストーラ" 目的のストレージプラットフォーム / サービスの設定例を示すディレクトリ。
。 spec
バックエンド固有の設定パラメータを使用します。この例では、バックエンドはを使用します ontap-san
storage driverおよびでは、に示す構成パラメータを使用します。ご使用のストレージドライバの設定オプションのリストについては、 "ストレージドライバのバックエンド設定情報"。
「 PEC 」セクションには、「 credentials 」フィールドと「 eleetionPolicy 」フィールドも含まれています。これらのフィールドは、「 TridentBackendConfig 」 CR に新しく導入されました。
-
credentials
:このパラメータは必須フィールドで、ストレージシステム / サービスとの認証に使用されるクレデンシャルが含まれています。ユーザが作成した Kubernetes Secret に設定されます。クレデンシャルをプレーンテキストで渡すことはできないため、エラーになります。 -
DeleetionPolicy
: 「 TridentBackendConfig 」が削除されたときに何が起こるかを定義します。次の 2 つの値のいずれかを指定できます。-
「削除」 : これにより、「 TridentBackendConfig 」 CR とそれに関連付けられたバックエンドの両方が削除されます。これがデフォルト値です。
-
「管理」:「 TridentBackendConfig 」 CR を削除しても、バックエンド定義は引き続き表示され、「 tridentctl 」で管理できます。削除ポリシーを「 retain 」に設定すると、ユーザは以前のリリース (21.04 より前 ) にダウングレードし、作成されたバックエンドを保持できます。このフィールドの値は、「 TridentBackendConfig 」が作成された後で更新できます。
-
バックエンドの名前は 'PEC.backendName' を使用して設定されます指定しない場合、バックエンドの名前は「 TridentBackendConfig 」オブジェクト( metadata.name )の名前に設定されます。'PEC.backendName' を使用してバックエンド名を明示的に設定することをお勧めします |
で作成されたバックエンドに tridentctl`は、関連付けられたオブジェクトはありません `TridentBackendConfig 。このようなバックエンドをで管理するには、 kubectl`CRを作成し `TridentBackendConfig`ます。同一の設定パラメータ(、、 `spec.storagePrefix spec.storageDriverName`など)を指定するように注意する必要があります `spec.backendName 。Tridentは、新しく作成されたを既存のバックエンドに自動的にバインドし `TridentBackendConfig`ます。
|
手順の概要
kubectl' を使用して新しいバックエンドを作成するには ' 次の手順を実行する必要があります
-
を作成し "Kubernetes Secret"ます。シークレットには、Tridentがストレージクラスタ/サービスと通信するために必要なクレデンシャルが含まれています。
-
「 TridentBackendConfig 」オブジェクトを作成します。ストレージクラスタ / サービスの詳細を指定し、前の手順で作成したシークレットを参照します。
バックエンドを作成したら、「 kubectl get tbc <tbc-name> -n <trident-namespac>` 」を使用してバックエンドのステータスを確認し、詳細を収集できます。
手順 1 : Kubernetes Secret を作成します
バックエンドのアクセスクレデンシャルを含むシークレットを作成します。ストレージサービス / プラットフォームごとに異なる固有の機能です。次に例を示します。
kubectl -n trident create -f backend-tbc-ontap-san-secret.yaml apiVersion: v1 kind: Secret metadata: name: backend-tbc-ontap-san-secret type: Opaque stringData: username: cluster-admin password: t@Ax@7q(>
次の表に、各ストレージプラットフォームの Secret に含める必要があるフィールドをまとめます。
ストレージプラットフォームのシークレットフィールド概要 | 秘密 | Field 概要の略 |
---|---|---|
Azure NetApp Files の特長 |
ClientID |
アプリケーション登録からのクライアント ID |
Cloud Volumes Service for GCP |
private_key_id です |
秘密鍵の ID 。CVS 管理者ロールを持つ GCP サービスアカウントの API キーの一部 |
Cloud Volumes Service for GCP |
private_key を使用します |
秘密鍵CVS 管理者ロールを持つ GCP サービスアカウントの API キーの一部 |
Element ( NetApp HCI / SolidFire ) |
エンドポイント |
テナントのクレデンシャルを使用する SolidFire クラスタの MVIP |
ONTAP |
ユーザ名 |
クラスタ / SVM に接続するためのユーザ名。クレデンシャルベースの認証に使用されます |
ONTAP |
パスワード |
クラスタ / SVM に接続するためのパスワード。クレデンシャルベースの認証に使用されます |
ONTAP |
clientPrivateKey |
クライアント秘密鍵の Base64 エンコード値。証明書ベースの認証に使用されます |
ONTAP |
chapUsername のコマンド |
インバウンドユーザ名。useCHAP = true の場合は必須。「 ONTAP-SAN' 」と「 ONTAP-SAN-エコノミー 」の場合 |
ONTAP |
chapInitiatorSecret |
CHAP イニシエータシークレット。useCHAP = true の場合は必須。「 ONTAP-SAN' 」と「 ONTAP-SAN-エコノミー 」の場合 |
ONTAP |
chapTargetUsername のコマンド |
ターゲットユーザ名。useCHAP = true の場合は必須。「 ONTAP-SAN' 」と「 ONTAP-SAN-エコノミー 」の場合 |
ONTAP |
chapTargetInitiatorSecret |
CHAP ターゲットイニシエータシークレット。useCHAP = true の場合は必須。「 ONTAP-SAN' 」と「 ONTAP-SAN-エコノミー 」の場合 |
このステップで作成されたシークレットは、次のステップで作成された「 TridentBackendConfig 」オブジェクトの「 PEC.credentials 」フィールドで参照されます。
手順2:を作成します TridentBackendConfig
CR
これで「 TridentBackendConfig 」 CR を作成する準備ができました。この例では 'ONTAP-SAN' ドライバを使用するバックエンドは ' 次に示す TridentBackendConfig オブジェクトを使用して作成されます
kubectl -n trident create -f backend-tbc-ontap-san.yaml
apiVersion: trident.netapp.io/v1 kind: TridentBackendConfig metadata: name: backend-tbc-ontap-san spec: version: 1 backendName: ontap-san-backend storageDriverName: ontap-san managementLIF: 10.0.0.1 dataLIF: 10.0.0.2 svm: trident_svm credentials: name: backend-tbc-ontap-san-secret
手順3:のステータスを確認します TridentBackendConfig
CR
これで「 TridentBackendConfig 」 CR が作成され、ステータスを確認できるようになりました。次の例を参照してください。
kubectl -n trident get tbc backend-tbc-ontap-san NAME BACKEND NAME BACKEND UUID PHASE STATUS backend-tbc-ontap-san ontap-san-backend 8d24fce7-6f60-4d4a-8ef6-bab2699e6ab8 Bound Success
バックエンドが正常に作成され、「 TridentBackendConfig 」 CR にバインドされました。
フェーズには次のいずれかの値を指定できます。
-
Bound
:TridentBackendConfig
CRはバックエンドに関連付けられており、そのバックエンドにはが含まれていますconfigRef
をに設定しますTridentBackendConfig
crのuid -
Unbound : "" を使用して表現されています「 TridentBackendConfig 」オブジェクトはバックエンドにバインドされません。新しく作成されたすべての TridentBackendConfig ’ CRS は、デフォルトでこのフェーズに入ります。フェーズが変更された後、再度 Unbound に戻すことはできません。
-
Deleting
:TridentBackendConfig
CRdeletionPolicy
が削除対象に設定されました。をクリックしますTridentBackendConfig
CRが削除され、削除状態に移行します。-
バックエンドに永続的ボリューム要求(PVC)が存在しない場合、を削除する
TridentBackendConfig`と、TridentはバックエンドとCRを削除します `TridentBackendConfig
。 -
バックエンドに 1 つ以上の PVC が存在する場合は、削除状態になります。次に 'TridentBackendConfig'CR が削除フェーズに入りますバックエンドおよび TridentBackendConfig は、すべての PVC が削除された後にのみ削除されます。
-
-
lost
:「 TridentBackendConfig 」 CR に関連付けられているバックエンドが誤って削除されたか、意図的に削除されました。「 TridentBackendConfig 」 CR には削除されたバックエンドへの参照があります。「 TridentBackendConfig 」 CR は、「 $eleetionPolicy 」の値に関係なく削除できます。 -
Unknown
:TridentはCRに関連付けられたバックエンドの状態または存在を特定できませんTridentBackendConfig
。たとえば、APIサーバが応答していない場合やCRDが見つからない場合 `tridentbackends.trident.netapp.io`などです。これには介入が必要な場合があります
この段階では、バックエンドが正常に作成されます。など、いくつかの操作を追加で処理することができます "バックエンドの更新とバックエンドの削除"。
(オプション)手順 4 :詳細を確認します
バックエンドに関する詳細情報を確認するには、次のコマンドを実行します。
kubectl -n trident get tbc backend-tbc-ontap-san -o wide
NAME BACKEND NAME BACKEND UUID PHASE STATUS STORAGE DRIVER DELETION POLICY backend-tbc-ontap-san ontap-san-backend 8d24fce7-6f60-4d4a-8ef6-bab2699e6ab8 Bound Success ontap-san delete
さらに、「 TridentBackendConfig 」の YAML / JSON ダンプを取得することもできます。
kubectl -n trident get tbc backend-tbc-ontap-san -o yaml
apiVersion: trident.netapp.io/v1 kind: TridentBackendConfig metadata: creationTimestamp: "2021-04-21T20:45:11Z" finalizers: - trident.netapp.io generation: 1 name: backend-tbc-ontap-san namespace: trident resourceVersion: "947143" uid: 35b9d777-109f-43d5-8077-c74a4559d09c spec: backendName: ontap-san-backend credentials: name: backend-tbc-ontap-san-secret managementLIF: 10.0.0.1 dataLIF: 10.0.0.2 storageDriverName: ontap-san svm: trident_svm version: 1 status: backendInfo: backendName: ontap-san-backend backendUUID: 8d24fce7-6f60-4d4a-8ef6-bab2699e6ab8 deletionPolicy: delete lastOperationStatus: Success message: Backend 'ontap-san-backend' created phase: Bound
backendInfo`CRに応答して作成されたバックエンドの `TridentBackendConfig`とが `backendUUID`格納され `backendName`ます。この `lastOperationStatus`フィールドには、CRの最後の操作のステータスが表示されます。このステータス `TridentBackendConfig`は、ユーザーがトリガーした場合(ユーザーがで何かを変更した場合など)、またはTridentによってトリガーされた場合 `spec
(Tridentの再起動中など)です。成功または失敗のいずれかです。 phase`CRとバックエンド間の関係のステータスを表します `TridentBackendConfig
。上の例では、の phase`値がバインドされています。つまり、CRがバックエンドに関連付けられていることを意味します `TridentBackendConfig
。
イベントログの詳細を取得するには、「 kubectl -n trident describe describe tbc <tbc -cr-name> 」コマンドを実行します。
tridentctl を使用して ' 関連付けられた TridentBackendConfig' オブジェクトを含むバックエンドを更新または削除することはできません「 tridentctl 」と「 TridentBackendConfig 」の切り替えに関連する手順を理解するには、次の手順に従います。 "こちらを参照してください"。 |