Merge branch 'v1.7' into typo_parameterconsistency

This commit is contained in:
greenie-msft 2022-04-20 14:22:49 -07:00 committed by GitHub
commit df856c76c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 18 deletions

View File

@ -53,7 +53,7 @@ You can provide the method parameters and values in the body of the request, for
```shell ```shell
curl -X POST http://localhost:3500/v1.0/actors/x-wing/33/method/fly \ curl -X POST http://localhost:3500/v1.0/actors/x-wing/33/method/fly \
-H "Content-Type: application/json" -H "Content-Type: application/json" \
-d '{ -d '{
"destination": "Hoth" "destination": "Hoth"
}' }'
@ -63,7 +63,7 @@ or
```shell ```shell
curl -X POST http://localhost:3500/v1.0/actors/x-wing/33/method/fly \ curl -X POST http://localhost:3500/v1.0/actors/x-wing/33/method/fly \
-H "Content-Type: application/json" -H "Content-Type: application/json" \
-d "{\"destination\":\"Hoth\"}" -d "{\"destination\":\"Hoth\"}"
``` ```
@ -103,7 +103,7 @@ Parameter | Description
```shell ```shell
curl -X POST http://localhost:3500/v1.0/actors/stormtrooper/50/state \ curl -X POST http://localhost:3500/v1.0/actors/stormtrooper/50/state \
-H "Content-Type: application/json" -H "Content-Type: application/json" \
-d '[ -d '[
{ {
"operation": "upsert", "operation": "upsert",
@ -242,7 +242,7 @@ Parameter | Description
```shell ```shell
curl http://localhost:3500/v1.0/actors/stormtrooper/50/reminders/checkRebels \ curl http://localhost:3500/v1.0/actors/stormtrooper/50/reminders/checkRebels \
-H "Content-Type: application/json" -H "Content-Type: application/json" \
-d '{ -d '{
"data": "someData", "data": "someData",
"dueTime": "1m", "dueTime": "1m",
@ -383,7 +383,7 @@ Parameter | Description
```shell ```shell
curl http://localhost:3500/v1.0/actors/stormtrooper/50/timers/checkRebels \ curl http://localhost:3500/v1.0/actors/stormtrooper/50/timers/checkRebels \
-H "Content-Type: application/json" -H "Content-Type: application/json" \
-d '{ -d '{
"data": "someData", "data": "someData",
"dueTime": "1m", "dueTime": "1m",

View File

@ -22,19 +22,22 @@ dapr init [flags]
### Flags ### Flags
| Name | Environment Variable | Default | Description | | Name | Environment Variable | Default | Description |
| -------------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------ | | --------------------- | -------------------- | ------------- | ------------------------------------------------------------------------------------ |
| `--enable-ha` | | `false` | Enable high availability (HA) mode | | `--dashboard-version` | | `latest` | The version of the Dapr dashboard to install, for example: `1.0.0` |
| `--enable-mtls` | | `true` | Enable mTLS in your cluster | | `--enable-ha` | | `false` | Enable high availability (HA) mode |
| `--help`, `-h` | | | Print this help message | | `--enable-mtls` | | `true` | Enable mTLS in your cluster |
| `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster | | `--from-dir` | | | Path to a local directory containing a downloaded "Dapr Installer Bundle" release which is used to `init` the airgap environment |
| `--wait` | | `false` | Wait for Kubernetes initialization to complete | | `--help`, `-h` | | | Print this help message |
| `--timeout` | | `300` | The wait timeout for the Kubernetes installation | | `--image-registry` | | | Pulls container images required by Dapr from the given image registry |
| `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in | | `--kubernetes`, `-k` | | `false` | Deploy Dapr to a Kubernetes cluster |
| `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` | | `--namespace`, `-n` | | `dapr-system` | The Kubernetes namespace to install Dapr in |
| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation | | `--network` | | | The Docker network on which to install and deploy the Dapr runtime |
| `--from-dir` | | | Path to a local directory containing a downloaded "Dapr Installer Bundle" release which is used to `init` the airgap environment | | `--runtime-version` | | `latest` | The version of the Dapr runtime to install, for example: `1.0.0` |
| `--image-registry` | | | Pulls container images required by Dapr from the given image registry | | `--set` | | | Configure options on the command line to be passed to the Dapr Helm chart and the Kubernetes cluster upon install. Can specify multiple values in a comma-separated list, for example: `key1=val1,key2=val2` |
| `--slim`, `-s` | | `false` | Exclude placement service, Redis and Zipkin containers from self-hosted installation |
| `--timeout` | | `300` | The wait timeout for the Kubernetes installation |
| `--wait` | | `false` | Wait for Kubernetes initialization to complete |
| N/A |DAPR_DEFAULT_IMAGE_REGISTRY| | In self hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr` it pulls the required images from Github container registry. To default to Docker hub as default, just unset this env variable.| | N/A |DAPR_DEFAULT_IMAGE_REGISTRY| | In self hosted mode, it is used to specify the default container registry to pull images from. When its value is set to `GHCR` or `ghcr` it pulls the required images from Github container registry. To default to Docker hub as default, just unset this env variable.|
### Examples ### Examples
@ -111,3 +114,9 @@ You can also specify a specific runtime version.
```bash ```bash
dapr init -k --runtime-version 1.4.0 dapr init -k --runtime-version 1.4.0
``` ```
Use the `--set` flag to configure a set of [Helm Chart values](https://github.com/dapr/dapr/tree/master/charts/dapr#configuration) during Dapr installation to help set up a Kubernetes cluster.
```bash
dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error
```