From 5c994462b377308a5329116eba6a5430656e413f Mon Sep 17 00:00:00 2001 From: Anthony Chu Date: Tue, 15 Mar 2022 14:33:36 -0700 Subject: [PATCH] Update managed identities and Dapr help text (#25) * Update managed identities and Dapr help text * Update Dapr flags * Add secretref note --- src/containerapp/azext_containerapp/_help.py | 43 +++++++++++-------- .../azext_containerapp/_params.py | 12 +++--- 2 files changed, 30 insertions(+), 25 deletions(-) diff --git a/src/containerapp/azext_containerapp/_help.py b/src/containerapp/azext_containerapp/_help.py index 228343f5dee..3a5fa25e5dc 100644 --- a/src/containerapp/azext_containerapp/_help.py +++ b/src/containerapp/azext_containerapp/_help.py @@ -241,13 +241,13 @@ # Identity Commands helps['containerapp identity'] = """ type: group - short-summary: Manage service (managed) identities for a containerapp + short-summary: Commands to manage managed identities. """ helps['containerapp identity assign'] = """ type: command - short-summary: Assign a managed identity to a containerapp - long-summary: Managed identities can be user-assigned or system-assigned + short-summary: Assign managed identity to a container app. + long-summary: Managed identities can be user-assigned or system-assigned. examples: - name: Assign system identity. text: | @@ -259,7 +259,7 @@ helps['containerapp identity remove'] = """ type: command - short-summary: Remove a managed identity from a containerapp + short-summary: Remove a managed identity from a container app. examples: - name: Remove system identity. text: | @@ -271,7 +271,7 @@ helps['containerapp identity show'] = """ type: command - short-summary: Show the containerapp's identity details + short-summary: Show managed identities of a container app. """ # Ingress Commands @@ -428,6 +428,11 @@ az containerapp secret set -n MyContainerapp -g MyResourceGroup --secrets MyExistingSecretName=MyNewSecretValue """ +helps['containerapp github-action'] = """ + type: group + short-summary: Commands to manage GitHub Actions. +""" + helps['containerapp github-action add'] = """ type: command short-summary: Add a Github Actions workflow to a repository to deploy a container app. @@ -479,59 +484,59 @@ # Dapr Commands helps['containerapp dapr'] = """ type: group - short-summary: Commands to manage dapr. + short-summary: Commands to manage Dapr. """ helps['containerapp dapr enable'] = """ type: command - short-summary: Enable dapr for a Containerapp. + short-summary: Enable Dapr for a container app. examples: - - name: Enable dapr for a Containerapp. + - name: Enable Dapr for a container app. text: | az containerapp dapr enable -n MyContainerapp -g MyResourceGroup --dapr-app-id my-app-id --dapr-app-port 8080 """ helps['containerapp dapr disable'] = """ type: command - short-summary: Disable dapr for a Containerapp. + short-summary: Disable Dapr for a container app. examples: - - name: Disable dapr for a Containerapp. + - name: Disable Dapr for a container app. text: | az containerapp dapr disable -n MyContainerapp -g MyResourceGroup """ helps['containerapp dapr list'] = """ type: command - short-summary: List dapr components for a Containerapp environment. + short-summary: List Dapr components. examples: - - name: List dapr components for a Containerapp environment. + - name: List Dapr components for a Container Apps environment. text: | az containerapp dapr list -g MyResourceGroup --environment-name MyEnvironment """ helps['containerapp dapr show'] = """ type: command - short-summary: Show the details of a dapr component. + short-summary: Show the details of a Dapr component. examples: - - name: Show the details of a dapr component. + - name: Show the details of a Dapr component. text: | az containerapp dapr show -g MyResourceGroup --dapr-component-name MyDaprComponenetName --environment-name MyEnvironment """ helps['containerapp dapr set'] = """ type: command - short-summary: Create or update a dapr component. + short-summary: Create or update a Dapr component. examples: - - name: Create a dapr component. + - name: Create a Dapr component. text: | - az containerapp dapr set -g MyResourceGroup --environment-name MyEnv --yaml MyYAMLPath --name MyDaprName + az containerapp dapr set -g MyResourceGroup --environment-name MyEnv --yaml my-component.yaml --name MyDaprName """ helps['containerapp dapr remove'] = """ type: command - short-summary: Remove a dapr componenet from a Containerapp environment. + short-summary: Remove a Dapr component. examples: - - name: Remove a dapr componenet from a Containerapp environment. + - name: Remove a Dapr component. text: | az containerapp dapr delete -g MyResourceGroup --dapr-component-name MyDaprComponenetName --environment-name MyEnvironment """ \ No newline at end of file diff --git a/src/containerapp/azext_containerapp/_params.py b/src/containerapp/azext_containerapp/_params.py index c592ed5363d..85ee7f4239e 100644 --- a/src/containerapp/azext_containerapp/_params.py +++ b/src/containerapp/azext_containerapp/_params.py @@ -35,7 +35,7 @@ def load_arguments(self, _): c.argument('container_name', type=str, options_list=['--container-name'], help="Name of the container.") c.argument('cpu', type=float, validator=validate_cpu, options_list=['--cpu'], help="Required CPU in cores, e.g. 0.5") c.argument('memory', type=str, validator=validate_memory, options_list=['--memory'], help="Required memory, e.g. 1.0Gi") - c.argument('env_vars', nargs='*', options_list=['--env-vars'], help="A list of environment variable(s) for the container. Space-separated values in 'key=value' format. Empty string to clear existing values") + c.argument('env_vars', nargs='*', options_list=['--env-vars'], help="A list of environment variable(s) for the container. Space-separated values in 'key=value' format. Empty string to clear existing values. Prefix value with 'secretref:' to reference a secret.") c.argument('startup_command', nargs='*', options_list=['--command'], help="A list of supported commands on the container that will executed during startup. Space-separated values e.g. \"/bin/queue\" \"mycommand\". Empty string to clear existing values") c.argument('args', nargs='*', options_list=['--args'], help="A list of container startup command argument(s). Space-separated values e.g. \"-c\" \"mycommand\". Empty string to clear existing values") c.argument('revision_suffix', type=str, options_list=['--revision-suffix'], help='User friendly suffix that is appended to the revision name') @@ -151,8 +151,8 @@ def load_arguments(self, _): c.argument('secret_names', nargs='+', help="A list of secret(s) for the container app. Space-separated secret values names.") with self.argument_context('containerapp dapr') as c: - c.argument('dapr_app_id', help="The dapr app id.") - c.argument('dapr_app_port', help="The port of your app.") - c.argument('dapr_app_protocol', help="Tells Dapr which protocol your application is using. Allowed values: grpc, http.") - c.argument('dapr_component_name', help="The dapr component name.") - c.argument('environment_name', help="The dapr component environment name.") + c.argument('dapr_app_id', help="The Dapr app id.") + c.argument('dapr_app_port', help="The port Dapr uses to talk to the application.") + c.argument('dapr_app_protocol', help="The protocol Dapr uses to talk to the application. Allowed values: grpc, http.") + c.argument('dapr_component_name', help="The Dapr component name.") + c.argument('environment_name', help="The Container Apps environment name.")