Docs for dapr int/upgrade in k8s mode using GHCR and private registry (#2508)

* Update docs for dapr int/upgrade in k8s mode using GHCR and private registry

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>

* Addressing review comments

Signed-off-by: Pravin Pushkar <ppushkar@microsoft.com>

Co-authored-by: Mark Fussell <markfussell@gmail.com>
This commit is contained in:
Pravin Pushkar 2022-07-02 05:42:21 +05:30 committed by GitHub
parent dc3e62d455
commit 6f75254db1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 1 deletions

View File

@ -38,7 +38,7 @@ dapr init [flags]
| `--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| | 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, unset the environment variable or leave it blank|
### Examples
@ -120,3 +120,14 @@ Use the `--set` flag to configure a set of [Helm Chart values](https://github.co
```bash
dapr init -k --set global.tag=1.0.0 --set dapr_operator.logLevel=error
```
You can also specify a private registry to pull container images from. As of now `dapr init -k` does not use specific images for sentry, operator, placement and sidecar. It relies on only Dapr runtime container image `dapr` for all these images.
Scenario 1 : dapr image hosted directly under root folder in private registry -
```bash
dapr init -k --image-registry docker.io/username
```
Scenario 2 : dapr image hosted under a new/different directory in private registry -
```bash
dapr init -k --image-registry docker.io/username/<directory-name>
```

View File

@ -33,6 +33,7 @@ dapr upgrade [flags]
| `--kubernetes`, `-k` | | `false` | Upgrade/Downgrade Dapr in a Kubernetes cluster |
| `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade/downgrade to, for example: `1.0.0` |
| `--set` | | | Set values on the command line (can specify multiple or separate values with commas: key1=val1,key2=val2) |
| `--image-registry` | | | Pulls container images required by Dapr from the given image registry |
### Examples
@ -46,6 +47,14 @@ dapr upgrade -k --runtime-version 1.2
# Upgrade or downgrade to a specified version of Dapr runtime in Kubernetes with value set
dapr upgrade -k --runtime-version 1.2 --set global.logAsJson=true
```
```bash
# Upgrade or downgrade using private registry, if you are using private registry for hosting dapr images and have used it while doing `dapr init -k`
# Scenario 1 : dapr image hosted directly under root folder in private registry -
dapr init -k --image-registry docker.io/username
# Scenario 2 : dapr image hosted under a new/different directory in private registry -
dapr init -k --image-registry docker.io/username/<directory-name>
```
### Warning messages
This command can issue warning messages.