Add docs for upgrade command in cli (#1181)

* Add docs for upgrade command in cli

https://github.com/dapr/docs/issues/1163

* Update dapr-upgrade.md

* Update dapr-upgrade.md

Co-authored-by: Mark Fussell <mfussell@microsoft.com>
Co-authored-by: Aaron Crawfis <Aaron.Crawfis@microsoft.com>
This commit is contained in:
halspang 2021-02-11 14:39:14 -08:00 committed by GitHub
parent 93bd2ab585
commit 5b02d7b24d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 64 additions and 12 deletions

View File

@ -72,13 +72,13 @@ The output should look like this:
```md
__
____/ /___ _____ _____
/ __ / __ '/ __ \/ ___/
/ /_/ / /_/ / /_/ / /
\__,_/\__,_/ .___/_/
/_/
/ /_/ / /_/ / /_/ / /
\__,_/\__,_/ .___/_/
/_/
===============================
Distributed Application Runtime
@ -101,10 +101,11 @@ Available Commands:
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
upgrade Upgrades a Dapr control plane installation in a cluster. Supported platforms: Kubernetes
Flags:
-h, --help help for dapr
--version version for dapr
-v, --version version for dapr
Use "dapr [command] --help" for more information about a command.
```

View File

@ -9,13 +9,14 @@ 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
@ -38,10 +39,11 @@ Available Commands:
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
upgrade Upgrades a Dapr control plane installation in a cluster. Supported platforms: Kubernetes
Flags:
-h, --help help for dapr
--version version for dapr
-v, --version version for dapr
Use "dapr [command] --help" for more information about a command.
```
@ -65,6 +67,7 @@ You can learn more about each Dapr command from the links below.
- [`dapr status`]({{< ref dapr-status.md >}})
- [`dapr stop`]({{< ref dapr-stop.md >}})
- [`dapr uninstall`]({{< ref dapr-uninstall.md >}})
- [`dapr upgrade`]({{< ref dapr-upgrade.md >}})
## Environment Variables

View File

@ -0,0 +1,48 @@
---
type: docs
title: "upgrade CLI command reference"
linkTitle: "upgrade"
description: "Detailed information on the upgrade CLI command"
---
## Description
Upgrade Dapr on supported hosting platforms.
## Supported platforms
- [Kubernetes]({{< ref kubernetes >}})
## Usage
```bash
dapr upgrade [flags]
```
## Flags
| Name | Environment Variable | Default | Description
| --- | --- | --- | --- |
| `--help`, `-h` | | | Print this help message |
| `--kubernetes`, `-k` | | `false` | Upgrade Dapr in a Kubernetes cluster |
| `--runtime-version` | | `latest` | The version of the Dapr runtime to upgrade 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) |
## Examples
### Upgrade Dapr in Kubernetes to latest version
```bash
dapr upgrade -k
```
### Upgrade specified version of Dapr runtime in Kubernetes
```bash
dapr upgrade -k --runtime-version 1.0.0
```
### Upgrade specified version of Dapr runtime in Kubernetes with value set
```bash
dapr upgrade -k --runtime-version 1.0.0 --set global.logAsJson=true
```
# Related links
- [Upgrade Dapr on a Kubernetes cluster]({{< ref kubernetes-upgrade.md >}})