Workspace Client で Teradata AI Unlimited を使用する
| この製品はプレビュー版であり、変更される可能性があります。このサービスの詳細について興味がある場合は、Teradata サポートにお問い合わせください。 |
概要
Workspace Client (workspacectl) は、Teradata AI Unlimited のコマンド ライン インターフェース (CLI) です。このドキュメントでは、workspacectlをインストールするための手順を説明します。このドキュメントには、CLI コマンドに関する必要な情報とガイダンスがすべて記載されており、コマンド ラインを迅速かつ効率的に操作できるようになります。現在のリリースでは、workspacectl を使用してワークスペース サービスに接続し、エンジンを管理することのみが可能です。Teradata では、データ探索用の Teradata AI Unlimited インターフェースとして JupyterLab を使用することを推奨しています。
始める前に
以下を確認します。
-
Dockerを使用した Teradata AI Unlimited Workspaceサービスのデプロイとセットアップで説明されている手順を使用して、ワークスペースサービスをインストール、設定、およびセットアップしている。
-
AWS環境変数とAPIキーをコピーして保持している。
workspacectlのインストール
https://downloads.teradata.com/download/tools/ai-unlimited-ctlからworkspacectlの実行可能ファイルをダウンロードします。
| Workspacectlはすべての主要なオペレーティングシステムをサポートしています。 |
workspacectlを使用する
-
ターミナルウィンドウを開き、workspacectlファイルを実行します。
-
API キーを使用してワークスペース サービスを構成します。
workspacesctl workspaces config -
新しいプロジェクトを作成します。
workspacesctl project create <Project_Name> -e <CSP> --no-tls -
プロジェクトのエンジンをデプロイします。
workspacesctl project engine deploy <Project_Name> -t <Size_of_Engine> --no-tls -
サンプルワークロードを実行します。
-
プロジェクトとエンジンを管理します。
-
プロジェクトをバックアップする。
workspacesctl project backup <Project_Name> --no-tls -
エンジンを停止します。
workspacesctl project engine suspend <Project_Name> --no-tls
サポートされているコマンドのリストについては、 ワークスペースクライアントのリファレンス を参照してください。
ワークスペースクライアントのリファレンス
workspaces config
説明: CLI をワークスペース サービスにバインドするための 1 回限りの構成。ワークスペースサービスのプロファイルページに移動し、APIキーをコピーします。
使用方法:
workspacesctl workspaces configフラグ:
-h、--help: コマンドの詳細をリストします。
出力:
プロンプトに従って、ワークスペースサービスのエンドポイントとAPIキーを選択します。
workspaces user list
説明: GitHub で Teradata AI Unlimited 用に設定されたユーザーのリストを表示します。
使用方法:
workspacesctl workspaces user list --no-tls| 設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。 |
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
project create
説明: Teradata AI Unlimitedでプロジェクトを作成します。このコマンドは、プロジェクトに対応する GitHub リポジトリも作成します。
使用方法:
workspacesctl project create <Project_Name> -e <CSP> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
| フラグ | 型 | 説明 | 必須? |
|---|---|---|---|
|
文字列 |
プロジェクト エンジンがホストされる環境。値:aws、azure、またはgcloud。現在、Teradata AI Unlimited は aws と azure をサポートしています。 |
はい |
|
文字列 |
入力に使用されるyamlファイルをマニフェストするためのパス。 |
いいえ |
|
文字列 |
プロジェクトに割り当てられたチーム。 |
いいえ |
|
コマンドの詳細をリストします。 |
いいえ |
出力:
project list
説明: Teradata AI Unlimited で設定されているすべてのプロジェクトの一覧表示します。
使用方法:
workspacesctl project list --no-tlsまたは
workspacesctl project list <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
project delete
説明: Teradata AI Unlimited でプロジェクトを削除します。
使用方法:
workspacesctl project delete <Project_Name> --no-tls| 設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。 |
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
| 出力は YAML 形式です。 |
project user list
説明: GitHub でプロジェクトに割り当てられた共同作業者をリストします。
使用方法:
workspacesctl project user list <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
project backup
説明: エンジン オブジェクト定義を、プロジェクトに割り当てられた GitHub リポジトリにバックアップします。
使用方法:
workspacesctl project backup <Project_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
| 出力はYAML形式です。 |
project restore
説明: プロジェクトの GitHub リポジトリからすべてのエンジン オブジェクト定義を復元します。
使用方法:
workspacesctl project restore <Project_Name> --no-tlsまたは
workspacesctl project restore <Project_Name> --gitref <git_reference> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
| フラグ | 型 | 説明 | 必須? |
|---|---|---|---|
|
文字列 |
タグ、SHA、またはブランチ名。 |
いいえ |
|
コマンドの詳細をリストします。 |
いいえ |
出力:
| 出力はYAML形式です。 |
project engine deploy
説明: プロジェクトのエンジンをデプロイします。
使用方法:
workspacesctl project engine deploy <Project_Name> -t small --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
| フラグ | 型 | 説明 | 必須? |
|---|---|---|---|
|
Int |
エンジン ノードの数。デフォルト値は1です。 |
いいえ |
|
文字列 |
エンジンのインスタンス サイズ。 |
いいえ |
|
文字列 |
入力に使用する yaml ファイルをマニフェストするパス。 |
いいえ |
|
文字列 |
デプロイメントのリージョン。 |
いいえ |
|
文字列 |
デプロイメントのサブネット ID。 |
いいえ |
|
コマンドの詳細をリストします。 |
いいえ |
project engine suspend
説明: デプロイされたエンジンを破棄し、セッション中に作成されたオブジェクト定義をバックアップします。
使用方法:
workspacesctl project engine suspend <Project_Name> --no-tls| 設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。 |
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
| 出力はYAML形式です。 |
project engine list
説明: プロジェクトのエンジンに関する詳細情報を表示します。このコマンドは、エンジンの最後の状態を表示します。
使用方法:
workspacesctl project engine list <Project_Name> --no-tls| 設定にTLS設定が含まれている場合は、`-no-tls`パラメータを追加する必要はありません。 |
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
| 出力はYAML形式です。 |
project auth create
説明: オブジェクト ストアの認証を作成します。
使用方法:
workspacesctl project auth create <Project_Name> -n <Auth_Name> -a <Auth_Key> -s <Auth_Secret> -r <ObjectStore_Region> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
| フラグ | 型 | 説明 | 必須? |
|---|---|---|---|
|
文字列 |
認証アクセスキーまたはID。 |
はい ( |
|
文字列 |
オブジェクトストアの認証名。 |
はい ( |
|
文字列 |
入力に使用する yaml ファイルをマニフェストするパス。 |
いいえ |
|
文字列 |
オブジェクトストアのリージョン。 |
はい |
-s, --secret string |
文字列 |
オブジェクト ストアの認証シークレット アクセス キー。 |
はい ( |
|
コマンドの詳細をリストします。 |
いいえ |
出力:
| 出力はYAML形式です。 |
project auth list
説明: プロジェクトに対して作成されたオブジェクト ストアの認証をリストします。
使用方法:
workspacesctl project auth list <Project_Name> --no-tls| 設定にTLS設定が含まれている場合は、 `-no-tls`パラメータを追加する必要はありません。 |
フラグ:
-h、--help: コマンドの詳細をリストします。
出力:
| 出力はYAML形式です。 |
project auth delete
説明: プロジェクトに対して作成されたオブジェクト ストアの認証を削除します。
使用方法:
workspacesctl project auth delete <Project_Name> -n <Auth_Name> --no-tls
設定にTLS設定が含まれている場合は、-no-tls パラメータを追加する必要はありません。
|
フラグ:
| フラグ | 型 | 説明 | 必須? |
|---|---|---|---|
|
文字列 |
削除するオブジェクト ストアの認証の名前。 |
はい |
|
コマンドの詳細をリストします。 |
いいえ |
出力:
| 出力はYAML形式です。 |
| ご質問がある場合、またはさらにサポートが必要な場合は、コミュニティ フォーラムにアクセスしてサポートを受け、他のコミュニティ メンバーと交流してください。 |