Skip to content

Commit a26df8c

Browse files
anthonychucalvinsID
authored andcommitted
Update managed identities and Dapr help text (Azure#25)
* Update managed identities and Dapr help text * Update Dapr flags * Add secretref note
1 parent ef031f4 commit a26df8c

File tree

2 files changed

+30
-25
lines changed

2 files changed

+30
-25
lines changed

src/containerapp/azext_containerapp/_help.py

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -241,13 +241,13 @@
241241
# Identity Commands
242242
helps['containerapp identity'] = """
243243
type: group
244-
short-summary: Manage service (managed) identities for a containerapp
244+
short-summary: Commands to manage managed identities.
245245
"""
246246

247247
helps['containerapp identity assign'] = """
248248
type: command
249-
short-summary: Assign a managed identity to a containerapp
250-
long-summary: Managed identities can be user-assigned or system-assigned
249+
short-summary: Assign managed identity to a container app.
250+
long-summary: Managed identities can be user-assigned or system-assigned.
251251
examples:
252252
- name: Assign system identity.
253253
text: |
@@ -259,7 +259,7 @@
259259

260260
helps['containerapp identity remove'] = """
261261
type: command
262-
short-summary: Remove a managed identity from a containerapp
262+
short-summary: Remove a managed identity from a container app.
263263
examples:
264264
- name: Remove system identity.
265265
text: |
@@ -271,7 +271,7 @@
271271

272272
helps['containerapp identity show'] = """
273273
type: command
274-
short-summary: Show the containerapp's identity details
274+
short-summary: Show managed identities of a container app.
275275
"""
276276

277277
# Ingress Commands
@@ -428,6 +428,11 @@
428428
az containerapp secret set -n MyContainerapp -g MyResourceGroup --secrets MyExistingSecretName=MyNewSecretValue
429429
"""
430430

431+
helps['containerapp github-action'] = """
432+
type: group
433+
short-summary: Commands to manage GitHub Actions.
434+
"""
435+
431436
helps['containerapp github-action add'] = """
432437
type: command
433438
short-summary: Add a Github Actions workflow to a repository to deploy a container app.
@@ -479,59 +484,59 @@
479484
# Dapr Commands
480485
helps['containerapp dapr'] = """
481486
type: group
482-
short-summary: Commands to manage dapr.
487+
short-summary: Commands to manage Dapr.
483488
"""
484489

485490
helps['containerapp dapr enable'] = """
486491
type: command
487-
short-summary: Enable dapr for a Containerapp.
492+
short-summary: Enable Dapr for a container app.
488493
examples:
489-
- name: Enable dapr for a Containerapp.
494+
- name: Enable Dapr for a container app.
490495
text: |
491496
az containerapp dapr enable -n MyContainerapp -g MyResourceGroup --dapr-app-id my-app-id --dapr-app-port 8080
492497
"""
493498

494499
helps['containerapp dapr disable'] = """
495500
type: command
496-
short-summary: Disable dapr for a Containerapp.
501+
short-summary: Disable Dapr for a container app.
497502
examples:
498-
- name: Disable dapr for a Containerapp.
503+
- name: Disable Dapr for a container app.
499504
text: |
500505
az containerapp dapr disable -n MyContainerapp -g MyResourceGroup
501506
"""
502507

503508
helps['containerapp dapr list'] = """
504509
type: command
505-
short-summary: List dapr components for a Containerapp environment.
510+
short-summary: List Dapr components.
506511
examples:
507-
- name: List dapr components for a Containerapp environment.
512+
- name: List Dapr components for a Container Apps environment.
508513
text: |
509514
az containerapp dapr list -g MyResourceGroup --environment-name MyEnvironment
510515
"""
511516

512517
helps['containerapp dapr show'] = """
513518
type: command
514-
short-summary: Show the details of a dapr component.
519+
short-summary: Show the details of a Dapr component.
515520
examples:
516-
- name: Show the details of a dapr component.
521+
- name: Show the details of a Dapr component.
517522
text: |
518523
az containerapp dapr show -g MyResourceGroup --dapr-component-name MyDaprComponenetName --environment-name MyEnvironment
519524
"""
520525

521526
helps['containerapp dapr set'] = """
522527
type: command
523-
short-summary: Create or update a dapr component.
528+
short-summary: Create or update a Dapr component.
524529
examples:
525-
- name: Create a dapr component.
530+
- name: Create a Dapr component.
526531
text: |
527-
az containerapp dapr set -g MyResourceGroup --environment-name MyEnv --yaml MyYAMLPath --name MyDaprName
532+
az containerapp dapr set -g MyResourceGroup --environment-name MyEnv --yaml my-component.yaml --name MyDaprName
528533
"""
529534

530535
helps['containerapp dapr remove'] = """
531536
type: command
532-
short-summary: Remove a dapr componenet from a Containerapp environment.
537+
short-summary: Remove a Dapr component.
533538
examples:
534-
- name: Remove a dapr componenet from a Containerapp environment.
539+
- name: Remove a Dapr component.
535540
text: |
536541
az containerapp dapr delete -g MyResourceGroup --dapr-component-name MyDaprComponenetName --environment-name MyEnvironment
537542
"""

src/containerapp/azext_containerapp/_params.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def load_arguments(self, _):
3535
c.argument('container_name', type=str, options_list=['--container-name'], help="Name of the container.")
3636
c.argument('cpu', type=float, validator=validate_cpu, options_list=['--cpu'], help="Required CPU in cores, e.g. 0.5")
3737
c.argument('memory', type=str, validator=validate_memory, options_list=['--memory'], help="Required memory, e.g. 1.0Gi")
38-
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")
38+
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.")
3939
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")
4040
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")
4141
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, _):
151151
c.argument('secret_names', nargs='+', help="A list of secret(s) for the container app. Space-separated secret values names.")
152152

153153
with self.argument_context('containerapp dapr') as c:
154-
c.argument('dapr_app_id', help="The dapr app id.")
155-
c.argument('dapr_app_port', help="The port of your app.")
156-
c.argument('dapr_app_protocol', help="Tells Dapr which protocol your application is using. Allowed values: grpc, http.")
157-
c.argument('dapr_component_name', help="The dapr component name.")
158-
c.argument('environment_name', help="The dapr component environment name.")
154+
c.argument('dapr_app_id', help="The Dapr app id.")
155+
c.argument('dapr_app_port', help="The port Dapr uses to talk to the application.")
156+
c.argument('dapr_app_protocol', help="The protocol Dapr uses to talk to the application. Allowed values: grpc, http.")
157+
c.argument('dapr_component_name', help="The Dapr component name.")
158+
c.argument('environment_name', help="The Container Apps environment name.")

0 commit comments

Comments
 (0)