mirror of https://github.com/dapr/docs.git
Add namespace flag option to "components", "configurations" and "list" CLI commands (#1749)
* add dapr cli namesapce flag docs * add examples Signed-off-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com> * Update daprdocs/content/en/reference/cli/dapr-list.md * Update daprdocs/content/en/reference/cli/dapr-configurations.md * Update daprdocs/content/en/reference/cli/dapr-components.md Co-authored-by: Yaron Schneider <yaronsc@microsoft.com> Co-authored-by: Mukundan Sundararajan <65565396+mukundansundar@users.noreply.github.com> Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
parent
48b63b2310
commit
c13b148a06
|
@ -21,14 +21,28 @@ dapr components [flags]
|
|||
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ------------------------------------------------ |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster |
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster (required) |
|
||||
| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr components in all namespaces |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--name`, `-n` | | | The components name to be printed (optional) |
|
||||
| `--namespace` | | | List all components in the specified namespace |
|
||||
| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List Kubernetes components
|
||||
# List Dapr components in all namespaces in Kubernetes mode
|
||||
dapr components -k
|
||||
```
|
||||
|
||||
# List Dapr components in specific namespace in Kubernetes mode
|
||||
dapr components -k --namespace default
|
||||
|
||||
# Print specific Dapr component in Kubernetes mode
|
||||
dapr components -k -n mycomponent
|
||||
|
||||
# List Dapr components in all namespaces in Kubernetes mode
|
||||
dapr components -k --all-namespaces
|
||||
```
|
|
@ -21,16 +21,28 @@ dapr configurations [flags]
|
|||
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | ---------------------------------------------------- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in a Kubernetes cluster |
|
||||
| `--name`, `-n` | | | The configuration name to be printed (optional) |
|
||||
| `--output`, `-o` | | `list` | Output format (options: json or yaml or list) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr configurations in Kubernetes cluster (required).
|
||||
| `--all-namespaces`, `-A` | | `true` | If true, list all Dapr configurations in all namespaces (optional)
|
||||
| `--namespace` | | | List Dapr configurations in specific namespace.
|
||||
| `--name`, `-n` | | | Print specific Dapr configuration. (optional)
|
||||
| `--output`, `-o` | | `list`| Output format (options: json or yaml or list)
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
### Examples
|
||||
|
||||
```bash
|
||||
# List Kubernetes Dapr configurations
|
||||
# List Dapr configurations in all namespaces in Kubernetes mode
|
||||
dapr configurations -k
|
||||
```
|
||||
|
||||
# List Dapr configurations in specific namespace in Kubernetes mode
|
||||
dapr configurations -k --namespace default
|
||||
|
||||
# Print specific Dapr configuration in Kubernetes mode
|
||||
dapr configurations -k -n appconfig
|
||||
|
||||
# List Dapr configurations in all namespaces in Kubernetes mode
|
||||
dapr configurations -k --all-namespaces
|
||||
```
|
|
@ -22,11 +22,14 @@ dapr list [flags]
|
|||
|
||||
### Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
| -------------------- | -------------------- | ------- | --------------------------------------------------------------------------- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster |
|
||||
| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table` |
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--all-namespaces`, `-A` | | `false` | List all Dapr pods in all namespaces (optional) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster (optional) |
|
||||
| `--namespace`, `-n` | | `default` | List the Dapr pods in the defined namespace in Kubernetes. Only with `-k` flag (optional) |
|
||||
| `--output`, `-o` | | `table` | The output format of the list. Valid values are: `json`, `yaml`, or `table`
|
||||
|
||||
### Examples
|
||||
|
||||
|
@ -34,9 +37,15 @@ dapr list [flags]
|
|||
# List Dapr instances in self-hosted mode
|
||||
dapr list
|
||||
|
||||
# List Dapr instances in Kubernetes mode
|
||||
# List Dapr instances in all namespaces in Kubernetes mode
|
||||
dapr list -k
|
||||
|
||||
# List Dapr instances in JSON format
|
||||
dapr list -o json
|
||||
```
|
||||
|
||||
# List Dapr instances in a specific namespace in Kubernetes mode
|
||||
dapr list -k --namespace default
|
||||
|
||||
# List Dapr instances in all namespaces in Kubernetes mode
|
||||
dapr list -k --all-namespaces
|
||||
```
|
Loading…
Reference in New Issue