如果您初次使用saectl工具,請參考本文完成工具的安裝與配置。
前提條件
已開通Serverless應用引擎並授權,詳見準備工作。
安裝saectl工具
請根據您的作業系統類型選擇相關的安裝包和安裝方式。
|
作業系統 |
安裝包 |
安裝方式 |
|
macOS |
|
|
|
Linux |
|
|
|
Windows |
|
|
Release Notes
驗證安裝成功
在命令列中運行saectl version,返回saectl工具的相關版本資訊,表明已成功安裝saectl工具。
查看協助資訊
運行命令的過程中,可以通過--help參數查詢協助資訊,例如:
-
saectl --help返回saectl後面可以跟隨的命令,例如get、describe、apply。 -
saectl apply --help返回saectl apply後面可以跟隨的參數,例如-f、-o。
配置saectl工具
saectl工具需要擷取在SAE部署應用和管理資源的許可權,因此需要在環境變數中配置阿里雲帳號的AccessKey ID、AccessKey Secret、應用部署地區等資訊。
擷取AccessKey ID和AccessKey Secret
您需要建立AccessKey,並記錄AccessKey ID和AccessKey Secret。
配置環境變數
請根據您的作業系統選擇配置方式。
Linux系統或macOS系統
在終端中執行echo $SHELL命令,查看預設Shell類型。根據預設Shell類型選擇配置方式。
Zsh
-
執行以下命令來將環境變數設定追加到
~/.zshrc檔案中。# 用您的 AccessKey ID 代替 YOUR_ACCESS_KEY_ID echo "export ALICLOUD_ACCESS_KEY='YOUR_ACCESS_KEY_ID'" >> ~/.zshrc # 用您的 AccessKey Secret 代替 YOUR_ACCESS_KEY_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檔案中。# 用您的 AccessKey ID 代替 YOUR_ACCESS_KEY_ID echo "export ALICLOUD_ACCESS_KEY='YOUR_ACCESS_KEY_ID'" >> ~/.bashrc # 用您的 AccessKey Secret 代替 YOUR_ACCESS_KEY_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命令列為例。
-
在CMD中運行以下命令。
# 用您的 AccessKey ID 代替 YOUR_ACCESS_KEY_ID setx ALICLOUD_ACCESS_KEY "YOUR_ACCESS_KEY_ID" # 用您的 AccessKey Secret 代替 YOUR_ACCESS_KEY_SECRET setx ALICLOUD_SECRET_KEY "YOUR_ACCESS_KEY_SECRET" # 用您的 應用部署地區 代替 cn-beijing setx ALICLOUD_REGION "cn-beijing" -
重新開啟一個CMD視窗,運行以下命令檢查環境變數是否生效。
echo %ALICLOUD_ACCESS_KEY%, %ALICLOUD_SECRET_KEY%, %ALICLOUD_REGION%
驗證配置成功
在命令列中運行saectl get ns,返回帳號中指定應用部署地區的命名空間資訊,表明已成功配置saectl工具。
命令列自動補全
saectl 支援 Bash、Zsh、Fish 和 PowerShell 的命令列自動補全功能,可以協助您快速輸入命令和參數。
安裝自動補全
請根據您使用的 Shell 類型選擇對應的安裝方式。
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
# 添加到 Profile(永久生效)
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
卸載自動補全
如需卸載自動補全,請根據您使用的 Shell 類型執行對應的卸載操作。
-
Bash:刪除
~/.saectl-completion.bash檔案,並從~/.bashrc中刪除相關的 source 行。 -
Zsh:刪除
~/.saectl-completion.bash檔案,並從~/.zshrc中刪除相關行。 -
Fish:刪除
~/.config/fish/completions/saectl.fish檔案。