public/rancher-docs
1
0
Fork 0
mirror of https://github.com/rancher/rancher-docs.git synced 2026-09-25 04:28:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update RKE CLI docs with folder info

Browse Source
This commit is contained in:
Denise Schannon
2019-10-03 18:28:55 -07:00
parent 74030ec55c
commit 1cb1125f5d
3 changed files with 10 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/rke/latest/en/etcd-snapshots/one-time-snapshots/_index.md
+5 -3
View File
@@ -10,7 +10,7 @@ One-time snapshots are handled differently depending on your version of RKE.
To save a snapshot of etcd from each etcd node in the cluster config file, run the `rke etcd snapshot-save` command.
The snapshot is saved in `/opt/rke/etcd-snapshots`.
The snapshot is saved in `/opt/rke/etcd-snapshots`.
When running the command, an additional container is created to take the snapshot. When the snapshot is completed, the container is automatically removed.
@@ -34,6 +34,7 @@ $ rke etcd snapshot-save \
--access-key S3_ACCESS_KEY \
--secret-key S3_SECRET_KEY \
--bucket-name s3-bucket-name \
--folder s3-folder-name \ # Optional - Available as of v0.3.0
--s3-endpoint s3.amazonaws.com
```
@@ -50,6 +51,7 @@ $ rke etcd snapshot-save \
| `--access-key` value | Specify s3 accessKey | * |
| `--secret-key` value | Specify s3 secretKey | * |
| `--bucket-name` value | Specify s3 bucket name | * |
| `--folder` value | Specify folder inside bucket where backup will be stored. This is optional. _Available as of v0.3.0_ | * |
| `--region` value | Specify the s3 bucket location (optional) | * |
| `--ssh-agent-auth` | [Use SSH Agent Auth defined by SSH_AUTH_SOCK]({{< baseurl >}}/rke/latest/en/config-options/#ssh-agent) | |
| `--ignore-docker-version` | [Disable Docker version check]({{< baseurl >}}/rke/latest/en/config-options/#supported-docker-versions) |
@@ -105,10 +107,10 @@ $ rke etcd snapshot-save --config cluster.yml --name snapshot-name
| Option | Description |
| --- | --- |
| `--name` value | Specify snapshot name |
| `--name` value | Specify snapshot name |
| `--config` value | Specify an alternate cluster YAML file (default: `cluster.yml`) [$RKE_CONFIG] |
| `--ssh-agent-auth` | [Use SSH Agent Auth defined by SSH_AUTH_SOCK]({{< baseurl >}}/rke/latest/en/config-options/#ssh-agent) |
| `--ignore-docker-version` | [Disable Docker version check]({{< baseurl >}}/rke/latest/en/config-options/#supported-docker-versions) |
{{% /tab %}}
{{% /tabs %}}
{{% /tabs %}}
content/rke/latest/en/etcd-snapshots/recurring-snapshots/_index.md
+2 -2
View File
@@ -33,7 +33,7 @@ time="2018-05-04T18:43:16Z" level=info msg="Created backup" name="2018-05-04T18:
|**interval_hours**| The duration in hours between recurring backups. This supercedes the `creation` option (which was used in RKE prior to v0.2.0) and will override it if both are specified.| |
|**retention**| The number of snapshots to retain before rotation. This supercedes the `retention` option and will override it if both are specified.| |
|**bucket_name**| S3 bucket name where backups will be stored| * |
|**folder**| Folder inside S3 bucket where backups will be stored. This is optional.| * |
|**folder**| Folder inside S3 bucket where backups will be stored. This is optional. _Available as of v0.3.0_ | * |
|**access_key**| S3 access key with permission to access the backup bucket.| * |
|**secret_key** |S3 secret key with permission to access the backup bucket.| * |
|**region** |S3 region for the backup bucket. This is optional.| * |
@@ -83,7 +83,7 @@ services:
secret_key: S3_SECRET_KEY
bucket_name: s3-bucket-name
region: ""
folder: ""
folder: "" # Optional - Available as of v0.3.0
endpoint: s3.amazonaws.com
```
content/rke/latest/en/etcd-snapshots/restoring-from-backup/_index.md
+3 -1
View File
@@ -47,6 +47,7 @@ $ rke etcd snapshot-restore \
--access-key S3_ACCESS_KEY \
--secret-key S3_SECRET_KEY \
--bucket-name s3-bucket-name \
--folder s3-folder-name \ # Optional - Available as of v0.3.0
--s3-endpoint s3.amazonaws.com
```
**Note:** if you were restoring a cluster that had Rancher installed, the Rancher UI should start up after a few minutes; you don't need to re-run Helm.
@@ -62,6 +63,7 @@ $ rke etcd snapshot-restore \
| `--access-key` value | Specify s3 accessKey | *|
| `--secret-key` value | Specify s3 secretKey | *|
| `--bucket-name` value | Specify s3 bucket name | *|
| `--folder` value | Specify folder inside bucket where backup will be stored. This is optional. This is optional. _Available as of v0.3.0_ | *|
| `--region` value | Specify the s3 bucket location (optional) | *|
| `--ssh-agent-auth` | [Use SSH Agent Auth defined by SSH_AUTH_SOCK]({{< baseurl >}}/rke/latest/en/config-options/#ssh-agent) | |
| `--ignore-docker-version` | [Disable Docker version check]({{< baseurl >}}/rke/latest/en/config-options/#supported-docker-versions) |
@@ -109,4 +111,4 @@ The `pki.bundle.tar.gz` file is also expected to be in the same location.
| `--ignore-docker-version` | [Disable Docker version check]({{< baseurl >}}/rke/latest/en/config-options/#supported-docker-versions) |
{{% /tab %}}
{{% /tabs %}}
{{% /tabs %}}