diff --git a/src/aks-preview/azext_aks_preview/_help.py b/src/aks-preview/azext_aks_preview/_help.py index 9d5200d939c..da908283d14 100644 --- a/src/aks-preview/azext_aks_preview/_help.py +++ b/src/aks-preview/azext_aks_preview/_help.py @@ -1798,7 +1798,7 @@ helps['aks draft setup-gh'] = """ type: command - short-summary: Set up Github OIDC for your application + short-summary: Set up GitHub OIDC for your application parameters: - name: --app type: string @@ -1814,25 +1814,25 @@ short-summary: Specify the cloud provider (default is azure). - name: --gh-repo type: string - short-summary: Specify the the github repository (organization/repo_name). + short-summary: Specify the the GitHub repository (organization/repo_name). - name: --path type: string short-summary: Automatically download and use the Draft binary at the specified location. examples: - - name: Prompt to setup the Github OIDC for a repository. + - name: Prompt to setup the GitHub OIDC for a repository. text: az aks draft setup-gh - - name: Setup the github OIDC on Azure for a specific repository. + - name: Setup the GitHub OIDC on Azure for a specific repository. text: az aks draft setup-gh --provider=azure --gh-repo=some_organization/some_repo - - name: Setup the github OIDC on Azure with subscription ID and resource group. + - name: Setup the GitHub OIDC on Azure with subscription ID and resource group. text: az aks draft setup-gh --provider=azure --subscription-id=some_subscription --resource-group=some_rg - - name: Setup the github OIDC with an application name on Azure with subscription ID and resource group for a specific repository. + - name: Setup the GitHub OIDC with an application name on Azure with subscription ID and resource group for a specific repository. text: az aks draft setup-gh --app=some_app --provider=azure --subscription-id=some_subscription --resource-group=some_rg --gh-repo=some_organization/some_repo """ helps['aks draft generate-workflow'] = """ type: command - short-summary: Generate a Github workflow for automatic build and deploy to AKS - long-summary: Before running this command, Make sure you have set up Github OIDC for your application. + short-summary: Generate a GitHub workflow for automatic build and deploy to AKS + long-summary: Before running this command, Make sure you have set up GitHub OIDC for your application. You also need to create a resource group, a container registry and a Kubernetes cluster on Azure and link the three resources using `az aks update -n -g --attach-acr `. parameters: @@ -1853,24 +1853,24 @@ short-summary: Specify the name of the container image. - name: --branch type: string - short-summary: Specify the Github branch to automatically deploy from. + short-summary: Specify the GitHub branch to automatically deploy from. - name: --path type: string short-summary: Automatically download and use the Draft binary at the specified location. examples: - - name: Prompt to generate a Github workflow in the current directory. + - name: Prompt to generate a GitHub workflow in the current directory. text: az aks draft generate-workflow - - name: Prompt to generate a Github workflow in a specific project directory. + - name: Prompt to generate a GitHub workflow in a specific project directory. text: az aks draft generate-workflow --destination=/projects/some_project - - name: Generate a Github workflow with a resource group, an AKS cluster name, a container registry name in a specific project directory. + - name: Generate a GitHub workflow with a resource group, an AKS cluster name, a container registry name in a specific project directory. text: az aks draft generate-workflow --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --destination=/projects/some_project - - name: Generate a Github workflow that deploys from the main branch with a resource group, an AKS cluster name, a container registry name, and a container image name in a specific project directory. + - name: Generate a GitHub workflow that deploys from the main branch with a resource group, an AKS cluster name, a container registry name, and a container image name in a specific project directory. text: az aks draft generate-workflow --branch=main --resource-group=some_rg --cluster-name=some_cluster --registry-name=some_registry --container-name=some_image --destination=/projects/some_project """ helps['aks draft up'] = """ type: command - short-summary: Set up Github OIDC and generate a Github workflow for automatic build and deploy to AKS + short-summary: Set up GitHub OIDC and generate a GitHub workflow for automatic build and deploy to AKS long-summary: This command combines `az aks draft setup-gh` and `az aks draft generate-workflow`. Before running this command, create a resource group, a container registry and a Kubernetes cluster on Azure and link the three resources using `az aks update -n -g --attach-acr `. @@ -1889,7 +1889,7 @@ short-summary: Specify the cloud provider (default is azure). - name: --gh-repo type: string - short-summary: Specify the the github repository (organization/repo_name). + short-summary: Specify the the GitHub repository (organization/repo_name). - name: --cluster-name type: string short-summary: Specify the AKS cluster name. @@ -1904,16 +1904,16 @@ short-summary: Specify the path to the project directory (default is .). - name: --branch type: string - short-summary: Specify the Github branch to automatically deploy from. + short-summary: Specify the GitHub branch to automatically deploy from. - name: --path type: string short-summary: Automatically download and use the Draft binary at the specified location. examples: - - name: Prompt to setup the Github OIDC then generate a Github workflow in the current directory. + - name: Prompt to setup the GitHub OIDC then generate a GitHub workflow in the current directory. text: az aks draft up - - name: Prompt to setup the Github OIDC then generate a Github workflow in a specific project directory. + - name: Prompt to setup the GitHub OIDC then generate a GitHub workflow in a specific project directory. text: az aks draft up --destination=/projects/some_project - - name: Prompt to setup the Github OIDC for a specific repository then generate a Github workflow in a specific project directory. + - name: Prompt to setup the GitHub OIDC for a specific repository then generate a GitHub workflow in a specific project directory. text: az aks draft up --gh-repo=some_organization/some_repo --destination=/projects/some_project """