saectl のインストールと設定 - SAE

saectl ツールを初めて使用する場合は、このトピックでインストールと設定の方法について説明します。

前提条件

Serverless Application Engine (SAE) を有効化し、必要な権限を付与済みであること。詳細については、「事前準備」をご参照ください。

saectl ツールのインストール

ご利用のオペレーティングシステムに基づいて、インストールパッケージとインストール方法を選択します。

オペレーティングシステム	インストールパッケージ	インストール方法
macOS	saectl-v0.1.10-darwin-amd64.tar.gz (x86-64 システム用) saectl-v0.1.10-darwin-arm64.tar.gz (ARM64 システム用)	圧縮パッケージをコンピューターにダウンロードして解凍します。解凍後のパスには `saectl` が含まれています。コマンドラインで、`saectl` があるパスに移動し、`mv ./saectl /usr/local/bin` を実行してシステムツールパスに移動します。
Linux	saectl-v0.1.10-linux-amd64.tar.gz (x86-64 システム用) saectl-v0.1.10-linux-arm64.tar.gz (ARM64 システム用)	圧縮パッケージをコンピューターにダウンロードします。コマンドラインで、コマンド `tar -zxvf ${package_file_name}` を実行してパッケージを解凍します。解凍後のパスには `saectl` が含まれています。コマンドラインで、`saectl` があるパスに移動し、`mv ./saectl /usr/local/bin` を実行してシステムツールパスに移動します。
Windows	saectl-v0.1.10-windows-amd64.zip (x86-64 システム用) saectl-v0.1.10-windows-arm64.zip (ARM64 システム用)	圧縮パッケージをコンピューターにダウンロードして解凍します。解凍後のパスには `saectl.exe` が含まれています。解凍後のパスを `PATH` システム環境変数に追加します。

リリースノート

バージョン	リリース日	変更内容
v0.1.10	2026/01/27	コマンド自動補完機能を追加しました。
v0.1.9	2025/12/25	Alibaba Cloud 国際サイトの exec コマンドのバグを修正しました。
v0.1.8	2025/11/17	convert コマンドのバグを修正しました。
v0.1.7	2025/07/11	convert コマンドを使用したバッチ変換機能を追加しました。いくつかのバグを修正しました。
v0.1.6	2025/06/30	convert 機能を追加しました。 `saectl convert -f input.yaml -o output.yaml` コマンドを実行して、Kubernetes YAML ファイルを SAE YAML ファイルに変換します。
v0.1.5	2025/05/23	cred 関連のコマンドのサポートを追加しました。
v0.1.4	2024/02/07	`kubectl-sae` コマンドを `saectl` コマンドに変更しました。
v0.1.3	2024/12/24	クライアントのタイムアウトを 60 秒に調整して、タイムアウトエラーを解決しました。
v0.1.2	2024/11/20	`saectl upload` コマンドを使用したコードパッケージのアップロードをサポートしました。 `saectl version` コマンドの出力を最適化しました。
v0.1.1	2024/11/11	クライアントに `-n` が指定されている場合、クライアントは指定された名前空間が YAML ファイル内の名前空間と一致することを確認します。クライアントに `-n` が指定されていない場合、YAML ファイル内の名前空間が使用されます。

インストールの確認

コマンドラインで saectl version を実行します。コマンドが saectl ツールのバージョン情報を返した場合、ツールは正常にインストールされています。

ヘルプ情報の表示

コマンドの実行中に、--help パラメーターを使用してヘルプ情報を表示できます。例：

saectl --help は、get、describe、apply など、saectl で使用できるコマンドを返します。
saectl apply --help は、-f や -o など、saectl apply で使用できるパラメーターを返します。

saectl ツールの設定

saectl ツールには、SAE でアプリケーションをデプロイし、リソースを管理するための権限が必要です。これらの権限を付与するには、Alibaba Cloud アカウントの AccessKey ID と AccessKey Secret、およびアプリケーションのデプロイリージョンを環境変数として設定する必要があります。

AccessKey ID と AccessKey Secret の取得

AccessKey を作成し、AccessKey ID と AccessKey Secret を記録します。

環境変数の設定

ご利用のオペレーティングシステムに基づいて設定方法を選択します。

Linux または macOS

ターミナルで echo $SHELL コマンドを実行して、デフォルトのシェルタイプを表示します。デフォルトのシェルタイプに基づいて設定方法を選択します。

Zsh

次のコマンドを実行して、環境変数を ~/.zshrc ファイルに追加します。

# YOUR_ACCESS_KEY_ID をご利用の AccessKey ID に置き換えます
echo "export ALICLOUD_ACCESS_KEY='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc
# YOUR_ACCESS_KEY_SECRET をご利用の AccessKey Secret に置き換えます
echo "export ALICLOUD_SECRET_KEY='YOUR_ACCESS_KEY_SECRET'" >> ~/.zshrc
# cn-beijing をご利用のアプリケーションのデプロイリージョンに置き換えます
echo "export ALICLOUD_REGION='cn-beijing'" >> ~/.zshrc

次のコマンドを実行して変更を有効にします。
```
source ~/.zshrc
```
新しいターミナルウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
```
echo $ALICLOUD_ACCESS_KEY, $ALICLOUD_SECRET_KEY, $ALICLOUD_REGION
```

Bash

次のコマンドを実行して、環境変数を ~/.bashrc ファイルに追加します。

# YOUR_ACCESS_KEY_ID をご利用の AccessKey ID に置き換えます
echo "export ALICLOUD_ACCESS_KEY='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc
# YOUR_ACCESS_KEY_SECRET をご利用の AccessKey Secret に置き換えます
echo "export ALICLOUD_SECRET_KEY='YOUR_ACCESS_KEY_SECRET'" >> ~/.bashrc
# cn-beijing をご利用のアプリケーションのデプロイリージョンに置き換えます
echo "export ALICLOUD_REGION='cn-beijing'" >> ~/.bashrc

次のコマンドを実行して変更を有効にします。
```
source ~/.bashrc
```
新しいターミナルウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
```
echo $ALICLOUD_ACCESS_KEY, $ALICLOUD_SECRET_KEY, $ALICLOUD_REGION
```

Windows

このセクションでは、コマンドプロンプト (CMD) を例として使用します。

コマンドプロンプトで、次のコマンドを実行します。

# YOUR_ACCESS_KEY_ID をご利用の AccessKey ID に置き換えます
setx ALICLOUD_ACCESS_KEY "YOUR_ACCESS_KEY_ID"
# YOUR_ACCESS_KEY_SECRET をご利用の AccessKey Secret に置き換えます
setx ALICLOUD_SECRET_KEY "YOUR_ACCESS_KEY_SECRET"
# cn-beijing をご利用のアプリケーションのデプロイリージョンに置き換えます
setx ALICLOUD_REGION "cn-beijing"

新しいコマンドプロンプトウィンドウを開き、次のコマンドを実行して環境変数が設定されていることを確認します。
```
echo %ALICLOUD_ACCESS_KEY%, %ALICLOUD_SECRET_KEY%, %ALICLOUD_REGION%
```

設定の確認

コマンドラインで saectl get ns を実行します。コマンドがアカウント内の指定されたアプリケーションデプロイリージョンの名前空間情報を返した場合、saectl ツールは正常に設定されています。

コマンドライン自動補完

saectl は、Bash、Zsh、Fish、PowerShell のコマンドライン自動補完をサポートしています。この機能により、コマンドとパラメーターを素早く入力できます。

自動補完のインストール

ご利用のシェルタイプに応じてインストール方法を選択してください。

Bash

次のコマンドを実行して、Bash の自動補完をインストールします。

# 補完スクリプトを生成します
saectl completion bash > ~/.saectl-completion.bash

# .bashrc に追加します
echo 'source ~/.saectl-completion.bash' >> ~/.bashrc

# 変更をすぐに適用します
source ~/.bashrc

macOS ユーザー向け：macOS のデフォルトの Bash バージョンは古いため、Zsh を使用するか、Bash をアップグレードしてください：

brew install bash-completion@2
saectl completion bash > $(brew --prefix)/etc/bash_completion.d/saectl

Zsh

次のコマンドを実行して、Zsh の自動補完をインストールします。

# 補完スクリプトを生成します
saectl completion bash > ~/.saectl-completion.bash

# .zshrc に追加します (bashcompinit 互換モードを使用)
cat >> ~/.zshrc << 'EOF'
autoload -U +X bashcompinit && bashcompinit
source ~/.saectl-completion.bash
EOF

# 変更をすぐに適用します
source ~/.zshrc

Fish

次のコマンドを実行して、Fish の自動補完をインストールします。

# 補完スクリプトを生成します (自動的に有効になります)
saectl completion fish > ~/.config/fish/completions/saectl.fish

PowerShell

次のコマンドを実行して、PowerShell の自動補完をインストールします。

# 補完スクリプトを生成します
saectl completion powershell | Out-String | Invoke-Expression

# 永続化するためにプロファイルに追加します
saectl completion powershell >> $PROFILE

自動補完の使用

インストールが完了したら、コマンドラインで saectl と入力し、Tab キーを押して自動補完をトリガーします。

コマンド補完：saectl と入力して Tab キーを押すと、get、create、delete、apply、describe、logs、exec などの利用可能なコマンドが表示されます。
リソースタイプ補完：saectl get と入力して Tab キーを押すと、namespaces、deployments、pods、services、configmaps、secrets、ingresses などの利用可能なリソースタイプが表示されます。
リソース名補完：リソースタイプを入力した後、Tab キーを押すと、現在の名前空間内の特定のリソース名が補完されます。
パラメーター補完：-- と入力して Tab キーを押すと、--namespace、--output、--all-namespaces、--selector などの利用可能なパラメーターが表示されます。
コンテナー名補完：logs または exec コマンドを使用する際、Tab キーを押すと Pod 内のコンテナー名が補完されます。

補完キャッシュの消去：自動補完が正しく機能しない場合は、次のコマンドを実行してキャッシュを消去してください。

# Zsh の場合
rm -f ~/.zcompdump*
exec zsh

# Bash の場合
hash -r

自動補完のアンインストール

自動補完をアンインストールするには、ご利用のシェルに応じたアンインストール手順に従ってください。

Bash：~/.saectl-completion.bash ファイルを削除し、~/.bashrc から関連する source 行を削除します。
Zsh：~/.saectl-completion.bash ファイルを削除し、~/.zshrc から関連する行を削除します。
Fish：~/.config/fish/completions/saectl.fish ファイルを削除します。