fix(k8s): update help message to clarify environment options as optional

Signed-off-by: 孙振宇 <>
This commit is contained in:
孙振宇 2025-01-15 03:35:20 +08:00
parent 3a6e22c7ef
commit 8d9344b037

View File

@ -22,7 +22,7 @@ AUTO_INSTALL_KUBELOGIN=${AUTO_INSTALL_KUBELOGIN:-true}
help() {
echo "Freeleaps Cluster Authenticator (Version: ${VERSION})"
echo ""
echo "Usage: [environment-variable=value] freeleaps-cluster-authenticator <sub-command>"
echo "Usage: [environment-option=value] freeleaps-cluster-authenticator <sub-command>"
echo ""
echo "Sub Commands:"
echo " auth,-a,--auth Setup kubectl for freeleaps cluster with Mathmast account."
@ -32,18 +32,18 @@ help() {
echo " help,-h,--help Show this help message."
echo ""
echo "Environment Options:"
echo " CLUSTER_API_LB_IP: IP address of the cluster API load balancer."
echo " CLUSTER_API_LB_PORT: Port of the cluster API load balancer."
echo " MICROSOFT_ENTRA_ID_TENANT: Microsoft Entra ID tenant."
echo " MICROSOFT_ENTRA_ID_CLIENT_ID: Microsoft Entra ID client ID."
echo " MICROSOFT_ENTRA_ID_CLIENT_SECRET: Microsoft Entra ID client secret."
echo " MICROSOFT_ENTRA_ID_ISSUER: Microsoft Entra ID issuer URL."
echo " OS: Operating system (linux or darwin). Default: auto"
echo " ARCH: Architecture (amd64 or arm64). Default: auto"
echo " KUBECTL_VERSION: Version of kubectl to install. Default: v1.30.3"
echo " KUBELOGIN_VERSION: Version of kubelogin to install. Default: v1.31.1"
echo " AUTO_INSTALL_KUBECTL: Automatically install kubectl if not found. Default: true"
echo " AUTO_INSTALL_KUBELOGIN: Automatically install kubelogin if not found. Default: true"
echo " [Optional] CLUSTER_API_LB_IP: IP address of the cluster API load balancer."
echo " [Optional] CLUSTER_API_LB_PORT: Port of the cluster API load balancer."
echo " [Optional] MICROSOFT_ENTRA_ID_TENANT: Microsoft Entra ID tenant."
echo " [Optional] MICROSOFT_ENTRA_ID_CLIENT_ID: Microsoft Entra ID client ID."
echo " [Optional] MICROSOFT_ENTRA_ID_CLIENT_SECRET: Microsoft Entra ID client secret."
echo " [Optional] MICROSOFT_ENTRA_ID_ISSUER: Microsoft Entra ID issuer URL."
echo " [Optional] OS: Operating system (linux or darwin). Default: auto"
echo " [Optional] ARCH: Architecture (amd64 or arm64). Default: auto"
echo " [Optional] KUBECTL_VERSION: Version of kubectl to install. Default: v1.30.3"
echo " [Optional] KUBELOGIN_VERSION: Version of kubelogin to install. Default: v1.31.1"
echo " [Optional] AUTO_INSTALL_KUBECTL: Automatically install kubectl if not found. Default: true"
echo " [Optional] AUTO_INSTALL_KUBELOGIN: Automatically install kubelogin if not found. Default: true"
}
gather_os_environment() {