mirror of https://github.com/dapr/docs.git
Merge pull request #992 from mukundansundar/update-cli-ref
Update CLI reference
This commit is contained in:
Aaron Crawfis
GitHub
commit
bdf468803c
|
|
@ -9,14 +9,13 @@ weight: 10
|
|||
The Dapr CLI allows you to setup Dapr on your local dev machine or on a Kubernetes cluster, provides debugging support, and launches and manages Dapr instances.
|
||||
|
||||
```bash
|
||||
|
||||
__
|
||||
|
||||
____/ /___ _____ _____
|
||||
/ __ / __ '/ __ \/ ___/
|
||||
/ /_/ / /_/ / /_/ / /
|
||||
\__,_/\__,_/ .___/_/
|
||||
/_/
|
||||
|
||||
/ /_/ / /_/ / /_/ / /
|
||||
\__,_/\__,_/ .___/_/
|
||||
/_/
|
||||
|
||||
===============================
|
||||
Distributed Application Runtime
|
||||
|
||||
|
|
@ -25,20 +24,20 @@ Usage:
|
|||
|
||||
Available Commands:
|
||||
completion Generates shell completion scripts
|
||||
components List all Dapr components
|
||||
configurations List all Dapr configurations
|
||||
dashboard Start Dapr dashboard
|
||||
components List all Dapr components. Supported platforms: Kubernetes
|
||||
configurations List all Dapr configurations. Supported platforms: Kubernetes
|
||||
dashboard Start Dapr dashboard. Supported platforms: Kubernetes and self-hosted
|
||||
help Help about any command
|
||||
init Install Dapr on supported hosting platforms, currently: Kubernetes and self-hosted
|
||||
invoke Invoke a method on a given Dapr application
|
||||
list List all Dapr instances
|
||||
logs Get Dapr sidecar logs for an application
|
||||
mtls Check if mTLS is enabled
|
||||
publish Publish a pub-sub event
|
||||
run Run Dapr and (optionally) your application side by side
|
||||
status Show the health status of Dapr services
|
||||
stop Stop Dapr instances and their associated apps in self-hosted mode
|
||||
uninstall Uninstall Dapr runtime
|
||||
init Install Dapr on supported hosting platforms. Supported platforms: Kubernetes and self-hosted
|
||||
invoke Invoke a method on a given Dapr application. Supported platforms: Self-hosted
|
||||
list List all Dapr instances. Supported platforms: Kubernetes and self-hosted
|
||||
logs Get Dapr sidecar logs for an application. Supported platforms: Kubernetes
|
||||
mtls Check if mTLS is enabled. Supported platforms: Kubernetes
|
||||
publish Publish a pub-sub event. Supported platforms: Self-hosted
|
||||
run Run Dapr and (optionally) your application side by side. Supported platforms: Self-hosted
|
||||
status Show the health status of Dapr services. Supported platforms: Kubernetes
|
||||
stop Stop Dapr instances and their associated apps. . Supported platforms: Self-hosted
|
||||
uninstall Uninstall Dapr runtime. Supported platforms: Kubernetes and self-hosted
|
||||
|
||||
Flags:
|
||||
-h, --help help for dapr
|
||||
|
|
@ -60,7 +59,7 @@ You can learn more about each Dapr command from the links below.
|
|||
- [`dapr invoke`]({{< ref dapr-invoke.md >}})
|
||||
- [`dapr list`]({{< ref dapr-list.md >}})
|
||||
- [`dapr logs`]({{< ref dapr-logs.md >}})
|
||||
- [`dapr mtls`]({{< ref dapr-mtls.md >}})
|
||||
- [`dapr mtls`]({{< ref dapr-mtls >}})
|
||||
- [`dapr publish`]({{< ref dapr-publish.md >}})
|
||||
- [`dapr run`]({{< ref dapr-run.md >}})
|
||||
- [`dapr status`]({{< ref dapr-status.md >}})
|
||||
|
|
|
|||
|
|
@ -12,10 +12,16 @@ Generates shell completion scripts
|
|||
## Usage
|
||||
|
||||
```bash
|
||||
dapr completion [flags]
|
||||
dapr completion [command]
|
||||
dapr completion [flags]
|
||||
dapr completion [command]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description |
|
||||
|------|----------------------|---------|-------------|
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
|
||||
## Examples
|
||||
|
||||
### Installing bash completion on macOS using Homebrew
|
||||
|
|
@ -96,10 +102,3 @@ bash Generates bash completion scripts
|
|||
powershell Generates powershell completion scripts
|
||||
zsh Generates zsh completion scripts
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
|
|
||||
|
|
|
|||
|
|
@ -7,7 +7,11 @@ description: "Detailed information on the components CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
List all Dapr components
|
||||
List all Dapr components.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -21,3 +25,10 @@ dapr components [flags]
|
|||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr components in a Kubernetes cluster |
|
||||
|
||||
## Examples
|
||||
|
||||
### List Kubernetes components
|
||||
```bash
|
||||
dapr components -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,11 @@ description: "Detailed information on the configurations CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
List all Dapr configurations
|
||||
List all Dapr configurations.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -23,4 +27,10 @@ dapr configurations [flags]
|
|||
| `--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 |
|
||||
|
|
||||
|
||||
## Examples
|
||||
|
||||
### List Kubernetes Dapr configurations
|
||||
```bash
|
||||
dapr configurations -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,20 +7,46 @@ description: "Detailed information on the dashboard CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Start Dapr dashboard
|
||||
Start [Dapr dashboard](https://github.com/dapr/dashboard).
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr dashboard [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running |
|
||||
| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard |
|
||||
| `--version`, `-v` | | `false` | Print the version for Dapr dashboard |
|
||||
| Name | Environment Variable | Default | Description |
|
||||
|------|----------------------|---------|-------------|
|
||||
| `--help`, `-h` | | | Prints this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Opens Dapr dashboard in local browser via local proxy to Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The namespace where Dapr dashboard is running |
|
||||
| `--port`, `-p` | | `8080` | The local port on which to serve Dapr dashboard |
|
||||
| `--version`, `-v` | | `false` | Print the version for Dapr dashboard |
|
||||
|
||||
## Examples
|
||||
|
||||
### Start dashboard locally
|
||||
```bash
|
||||
dapr dashboard
|
||||
```
|
||||
|
||||
### Start dashboard service locally on a specified port
|
||||
```bash
|
||||
dapr dashboard -p 9999
|
||||
```
|
||||
|
||||
### Port forward to dashboard service running in Kubernetes
|
||||
```bash
|
||||
dapr dashboard -k
|
||||
```
|
||||
|
||||
### Port forward to dashboard service running in Kubernetes on a specified port
|
||||
```bash
|
||||
dapr dashboard -k -p 9999
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,10 +7,14 @@ description: "Detailed information on the init CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Install Dapr on supported hosting platforms, currently: Kubernetes and self-hosted
|
||||
Install Dapr on supported hosting platforms.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr init [flags]
|
||||
```
|
||||
|
|
@ -25,6 +29,32 @@ dapr init [flags]
|
|||
| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in |
|
||||
| `--network` | `DAPR_NETWORK` | | The Docker network on which to deploy the Dapr runtime |
|
||||
| `--redis-host` | `DAPR_REDIS_HOST` | `localhost` | The host on which the Redis service resides |
|
||||
| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` |
|
||||
| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation |
|
||||
|
||||
## Examples
|
||||
|
||||
### Initialize Dapr in self-hosted mode
|
||||
```bash
|
||||
dapr init
|
||||
```
|
||||
|
||||
### Initialize Dapr in Kubernetes
|
||||
```bash
|
||||
dapr init -k
|
||||
```
|
||||
|
||||
### Initialize specified version of Dapr runtime in self-hosted mode
|
||||
```bash
|
||||
dapr init --runtime-version 0.10.0
|
||||
```
|
||||
|
||||
### Initialize specified version of Dapr runtime in Kubernetes
|
||||
```bash
|
||||
dapr init -k --runtime-version 0.10.0
|
||||
```
|
||||
|
||||
### Initialize Dapr in [slim self-hosted mode]({{< ref self-hosted-no-docker.md >}})
|
||||
```bash
|
||||
dapr init -s
|
||||
```
|
||||
|
|
@ -7,10 +7,13 @@ description: "Detailed information on the invoke CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Invoke a method on a given Dapr application
|
||||
Invoke a method on a given Dapr application.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr invoke [flags]
|
||||
```
|
||||
|
|
@ -22,5 +25,17 @@ dapr invoke [flags]
|
|||
| `--app-id`, `-a` | | | The application id to invoke |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--method`, `-m` | | | The method to invoke |
|
||||
| `--payload`, `-p` | | | The JSON payload (optional) |
|
||||
| `--data`, `-d` | | | The JSON serialized data string (optional) |
|
||||
| `--verb`, `-v` | | `POST` | The HTTP verb to use |
|
||||
|
||||
## Examples
|
||||
|
||||
### Invoke a sample method on target app with POST Verb
|
||||
```bash
|
||||
dapr invoke --app-id target --method sample --data '{"key":"value"}'
|
||||
```
|
||||
|
||||
### Invoke a sample method on target app with GET Verb
|
||||
```bash
|
||||
dapr invoke --app-id target --method sample --verb GET
|
||||
```
|
||||
|
|
|
|||
|
|
@ -1,24 +0,0 @@
|
|||
---
|
||||
type: docs
|
||||
title: "invokeGet CLI command reference"
|
||||
linkTitle: "invokeGet"
|
||||
description: "Detailed information on the invokeGet CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Issue HTTP GET to Dapr app
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr invokeGet [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-a` | | | The app ID to invoke |
|
||||
| `--help`, `-h` | | | Help for invokeGet |
|
||||
| `--method`, `-m` | | | The method to invoke |
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
---
|
||||
type: docs
|
||||
title: "invokePost CLI command reference"
|
||||
linkTitle: "invokePost"
|
||||
description: "Detailed information on the invokePost CLI command"
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Issue HTTP POST to Dapr app with an optional payload
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr invokePost [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-a` | | | The app ID to invoke |
|
||||
| `--help`, `-h` | | | Help for invokePost |
|
||||
| `--method`, `-m` | | | The method to invoke |
|
||||
| `--payload`, `-p` | | | (optional) a json payload |
|
||||
|
|
@ -7,10 +7,14 @@ description: "Detailed information on the list CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
List all Dapr instances
|
||||
List all Dapr instances.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr list [flags]
|
||||
```
|
||||
|
|
@ -21,3 +25,15 @@ dapr list [flags]
|
|||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | List all Dapr pods in a Kubernetes cluster |
|
||||
|
||||
## Examples
|
||||
|
||||
### List Dapr instances in self-hosted mode
|
||||
```bash
|
||||
dapr list
|
||||
```
|
||||
|
||||
### List Dapr instances in Kubernetes mode
|
||||
```bash
|
||||
dapr list -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,10 +7,13 @@ description: "Detailed information on the logs CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Gets Dapr sidecar logs for an app in Kubernetes
|
||||
Get Dapr sidecar logs for an application.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
dapr logs [flags]
|
||||
```
|
||||
|
|
@ -24,3 +27,11 @@ dapr logs [flags]
|
|||
| `--kubernetes`, `-k` | | `true` | Get logs from a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `default` | The Kubernetes namespace in which your application is deployed |
|
||||
| `--pod-name`, `-p` | | | The name of the pod in Kubernetes, in case your application has multiple pods (optional) |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### Get logs of sample app from target pod in custom namespace
|
||||
```bash
|
||||
dapr logs -k --app-id sample --pod-name target --namespace custom
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,11 @@ description: "Detailed information on the mtls CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Check if mTLS is enabled
|
||||
Check if mTLS is enabled.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -16,6 +20,13 @@ dapr mtls [flags]
|
|||
dapr mtls [command]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Check if mTLS is enabled in a Kubernetes cluster |
|
||||
|
||||
## Available Commands
|
||||
|
||||
```txt
|
||||
|
|
@ -23,9 +34,16 @@ expiry Checks the expiry of the root certificate
|
|||
export Export the root CA, issuer cert and key from Kubernetes to local files
|
||||
```
|
||||
|
||||
## Flags
|
||||
## Command Reference
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Check if mTLS is enabled in a Kubernetes cluster |
|
||||
You can learn more about each sub command from the links below.
|
||||
|
||||
- [`dapr mtls expiry`]({{< ref dapr-mtls-expiry.md >}})
|
||||
- [`dapr mtls export`]({{< ref dapr-mtls-export.md >}})
|
||||
|
||||
## Examples
|
||||
|
||||
### Check if mTLS is enabled
|
||||
```bash
|
||||
dapr mtls -k
|
||||
```
|
||||
|
|
@ -0,0 +1,33 @@
|
|||
---
|
||||
type: docs
|
||||
title: "mtls expiry CLI command reference"
|
||||
linkTitle: "mtls expiry"
|
||||
description: "Detailed information on the mtls expiry CLI command"
|
||||
weight: 2000
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Checks the expiry of the root certificate
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
```bash
|
||||
dapr mtls expiry [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | help for expiry |
|
||||
|
||||
## Examples
|
||||
|
||||
### Check expiry of Kubernetes certs
|
||||
```bash
|
||||
dapr mtls expiry
|
||||
```
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
type: docs
|
||||
title: "mtls export CLI command reference"
|
||||
linkTitle: "mtls export"
|
||||
description: "Detailed information on the mtls export CLI command"
|
||||
weight: 1000
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Export the root CA, issuer cert and key from Kubernetes to local files
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
```bash
|
||||
dapr mtls export [flags]
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | help for export |
|
||||
| `--out`, `-o` | | current directory | The output directory path to save the certs |
|
||||
|
||||
## Examples
|
||||
|
||||
### Check expiry of Kubernetes certs
|
||||
```bash
|
||||
dapr mtls export -o ./certs
|
||||
```
|
||||
|
|
@ -7,7 +7,11 @@ description: "Detailed information on the publish CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Publish an event to multiple consumers
|
||||
Publish a pub-sub event.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -24,3 +28,11 @@ dapr publish [flags]
|
|||
| `--topic`, `-t` | | | The topic to be published to |
|
||||
| `--data`, `-d` | | | The JSON serialized string (optional) |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
|
||||
## Examples
|
||||
|
||||
### Publish to sample topic in target pubsub
|
||||
```bash
|
||||
dapr publish --publish-app-id appId --topic sample --pubsub target --data '{"key":"value"}'
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,11 @@ description: "Detailed information on the run CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Run Dapr's sidecar and (optionally) an application.
|
||||
Run Dapr and (optionally) your application side by side.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -15,30 +19,11 @@ Run Dapr's sidecar and (optionally) an application.
|
|||
dapr run [flags] [command]
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
Run a Java application:
|
||||
```bash
|
||||
dapr run --app-id myapp -- java -jar myapp.jar
|
||||
```
|
||||
Run a NodeJs application that listens to port 3000:
|
||||
```bash
|
||||
dapr run --app-id myapp --app-port 3000 -- node myapp.js
|
||||
```
|
||||
Run a Python application:
|
||||
```bash
|
||||
dapr run --app-id myapp -- python myapp.py
|
||||
```
|
||||
Run sidecar only:
|
||||
```bash
|
||||
dapr run --app-id myapp
|
||||
```
|
||||
|
||||
## Flags
|
||||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id`, `-i` | | | The id for your application, used for service discovery |
|
||||
| `--app-id`, `-a` | | | The id for your application, used for service discovery |
|
||||
| `--app-max-concurrency` | | `unlimited` | The concurrency level of the application, otherwise is unlimited |
|
||||
| `--app-port`, `-p` | | | The port your application is listening on
|
||||
| `--app-protocol`, `-P` | | `http` | The protocol (gRPC or HTTP) Dapr uses to talk to the application. Valid values are: `http` or `grpc` |
|
||||
|
|
@ -49,8 +34,38 @@ dapr run --app-id myapp
|
|||
| `--dapr-http-port` | | `50001` | The HTTP port for Dapr to listen on |
|
||||
| `--enable-profiling` | | `false` | Enable `pprof` profiling via an HTTP endpoint
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--image` | | | The image to build the code in. Input is: `repository/image` |
|
||||
| `--log-level` | | `info` | The log verbosity. Valid values are: `debug`, `info`, `warning`, `error`, `fatal`, or `panic` |
|
||||
| `--placement-host-address` | `DAPR_PLACEMENT_HOST` | `localhost` | The host on which the placement service resides |
|
||||
| `--placement-host-address` | `DAPR_PLACEMENT_HOST_ADDRESS` | `localhost` | The host on which the placement service resides |
|
||||
| `--profile-port` | | `7777` | The port for the profile server to listen on |
|
||||
|
||||
## Examples
|
||||
|
||||
### Run a .NET application
|
||||
|
||||
```bash
|
||||
dapr run --app-id myapp --app-port 5000 -- dotnet run
|
||||
```
|
||||
|
||||
### Run a Java application
|
||||
|
||||
```bash
|
||||
dapr run --app-id myapp -- java -jar myapp.jar
|
||||
```
|
||||
|
||||
### Run a NodeJs application that listens to port 3000
|
||||
|
||||
```bash
|
||||
dapr run --app-id myapp --app-port 3000 -- node myapp.js
|
||||
```
|
||||
|
||||
### Run a Python application
|
||||
|
||||
```bash
|
||||
dapr run --app-id myapp -- python myapp.py
|
||||
```
|
||||
|
||||
### Run sidecar only
|
||||
|
||||
```bash
|
||||
dapr run --app-id myapp
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,12 +7,14 @@ description: "Detailed information on the status CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Show the health status of Dapr services
|
||||
Show the health status of Dapr services.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
This command only works for Kubernetes mode.
|
||||
|
||||
```bash
|
||||
dapr status -k
|
||||
```
|
||||
|
|
@ -23,3 +25,10 @@ dapr status -k
|
|||
| --- | --- | --- | --- |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
| `--kubernetes`, `-k` | | `false` | Show the health status of Dapr services on Kubernetes cluster |
|
||||
|
||||
## Examples
|
||||
|
||||
### Get status of Dapr services from Kubernetes
|
||||
```bash
|
||||
dapr status -k
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,11 @@ description: "Detailed information on the stop CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Stop Dapr instances and their associated apps in self-hosted mode
|
||||
Stop Dapr instances and their associated apps.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -19,5 +23,12 @@ dapr stop [flags]
|
|||
|
||||
| Name | Environment Variable | Default | Description
|
||||
| --- | --- | --- | --- |
|
||||
| `--app-id` | | | The application id to be stopped |
|
||||
| `--app-id`, `-a` | | | The application id to be stopped |
|
||||
| `--help`, `-h` | | | Print this help message |
|
||||
|
||||
## Examples
|
||||
|
||||
### Stop Dapr application
|
||||
```bash
|
||||
dapr stop --app-id <ID>
|
||||
```
|
||||
|
|
|
|||
|
|
@ -7,7 +7,12 @@ description: "Detailed information on the uninstall CLI command"
|
|||
|
||||
## Description
|
||||
|
||||
Uninstall Dapr runtime
|
||||
Uninstall Dapr runtime.
|
||||
|
||||
## Supported platforms
|
||||
|
||||
- [Self-Hosted]({{< ref self-hosted >}})
|
||||
- [Kubernetes]({{< ref kubernetes >}})
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -24,3 +29,20 @@ dapr uninstall [flags]
|
|||
| `--kubernetes`, `-k` | | `false` | Uninstall Dapr from a Kubernetes cluster |
|
||||
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to uninstall Dapr from |
|
||||
| `--network` | `DAPR_NETWORK` | | The Docker network from which to remove the Dapr runtime |
|
||||
|
||||
## Examples
|
||||
|
||||
### Uninstall from self-hosted mode
|
||||
```bash
|
||||
dapr uninstall
|
||||
```
|
||||
|
||||
### Uninstall from self-hosted mode and remove .dapr directory, Redis, Placement and Zipkin containers
|
||||
```bash
|
||||
dapr uninstall --all
|
||||
```
|
||||
|
||||
### Uninstall from Kubernetes
|
||||
```bash
|
||||
dapr uninstall -k
|
||||
```
|
||||
|
|
|
|||
Loading…
Reference in New Issue