From 8d9344b03770bd21b0a7b5f956bdc64e1ce8df9d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=AD=99=E6=8C=AF=E5=AE=87?= <>
Date: Wed, 15 Jan 2025 03:35:20 +0800
Subject: [PATCH] fix(k8s): update help message to clarify environment options
 as optional
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: 孙振宇 <>
---
 bin/freeleaps-cluster-authenticator | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/bin/freeleaps-cluster-authenticator b/bin/freeleaps-cluster-authenticator
index 72bd85d2..cd5b7fdb 100755
--- a/bin/freeleaps-cluster-authenticator
+++ b/bin/freeleaps-cluster-authenticator
@@ -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() {