mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-29 06:29:34 +00:00
Merge pull request #1810 from deniseschannon/rke-cli
Add docs for RKE CLI
This commit is contained in:
@@ -36,6 +36,10 @@ nodes:
|
|||||||
ssh_key_path: /home/user/.ssh/id_rsa
|
ssh_key_path: /home/user/.ssh/id_rsa
|
||||||
ssh_cert: |-
|
ssh_cert: |-
|
||||||
ssh-rsa-cert-v01@openssh.com AAAAHHNza...
|
ssh-rsa-cert-v01@openssh.com AAAAHHNza...
|
||||||
|
taints: # Available as of v0.3.0
|
||||||
|
- key: test-key
|
||||||
|
value: test-value
|
||||||
|
effect: NoSchedule
|
||||||
- address: example.com
|
- address: example.com
|
||||||
user: ubuntu
|
user: ubuntu
|
||||||
role:
|
role:
|
||||||
@@ -123,3 +127,9 @@ If the Docker socket is different than the default, you can set the `docker_sock
|
|||||||
### Labels
|
### Labels
|
||||||
|
|
||||||
You have the ability to add an arbitrary map of labels for each node. It can be used when using the [ingress controller's]({{< baseurl >}}/rke/latest/en/config-options/add-ons/ingress-controllers/) `node_selector` option.
|
You have the ability to add an arbitrary map of labels for each node. It can be used when using the [ingress controller's]({{< baseurl >}}/rke/latest/en/config-options/add-ons/ingress-controllers/) `node_selector` option.
|
||||||
|
|
||||||
|
### Taints
|
||||||
|
|
||||||
|
_Available as of v0.3.0_
|
||||||
|
|
||||||
|
You have the ability to add [taints](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/) for each node.
|
||||||
|
|||||||
@@ -34,6 +34,7 @@ $ rke etcd snapshot-save \
|
|||||||
--access-key S3_ACCESS_KEY \
|
--access-key S3_ACCESS_KEY \
|
||||||
--secret-key S3_SECRET_KEY \
|
--secret-key S3_SECRET_KEY \
|
||||||
--bucket-name s3-bucket-name \
|
--bucket-name s3-bucket-name \
|
||||||
|
--folder s3-folder-name \ # Optional - Available as of v0.3.0
|
||||||
--s3-endpoint s3.amazonaws.com
|
--s3-endpoint s3.amazonaws.com
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -50,6 +51,7 @@ $ rke etcd snapshot-save \
|
|||||||
| `--access-key` value | Specify s3 accessKey | * |
|
| `--access-key` value | Specify s3 accessKey | * |
|
||||||
| `--secret-key` value | Specify s3 secretKey | * |
|
| `--secret-key` value | Specify s3 secretKey | * |
|
||||||
| `--bucket-name` value | Specify s3 bucket name | * |
|
| `--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) | * |
|
| `--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) | |
|
| `--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) |
|
| `--ignore-docker-version` | [Disable Docker version check]({{< baseurl >}}/rke/latest/en/config-options/#supported-docker-versions) |
|
||||||
|
|||||||
@@ -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.| |
|
|**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.| |
|
|**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| * |
|
|**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.| * |
|
|**access_key**| S3 access key with permission to access the backup bucket.| * |
|
||||||
|**secret_key** |S3 secret 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.| * |
|
|**region** |S3 region for the backup bucket. This is optional.| * |
|
||||||
@@ -83,7 +83,7 @@ services:
|
|||||||
secret_key: S3_SECRET_KEY
|
secret_key: S3_SECRET_KEY
|
||||||
bucket_name: s3-bucket-name
|
bucket_name: s3-bucket-name
|
||||||
region: ""
|
region: ""
|
||||||
folder: ""
|
folder: "" # Optional - Available as of v0.3.0
|
||||||
endpoint: s3.amazonaws.com
|
endpoint: s3.amazonaws.com
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|||||||
@@ -47,6 +47,7 @@ $ rke etcd snapshot-restore \
|
|||||||
--access-key S3_ACCESS_KEY \
|
--access-key S3_ACCESS_KEY \
|
||||||
--secret-key S3_SECRET_KEY \
|
--secret-key S3_SECRET_KEY \
|
||||||
--bucket-name s3-bucket-name \
|
--bucket-name s3-bucket-name \
|
||||||
|
--folder s3-folder-name \ # Optional - Available as of v0.3.0
|
||||||
--s3-endpoint s3.amazonaws.com
|
--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.
|
**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 | *|
|
| `--access-key` value | Specify s3 accessKey | *|
|
||||||
| `--secret-key` value | Specify s3 secretKey | *|
|
| `--secret-key` value | Specify s3 secretKey | *|
|
||||||
| `--bucket-name` value | Specify s3 bucket name | *|
|
| `--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) | *|
|
| `--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) | |
|
| `--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) |
|
| `--ignore-docker-version` | [Disable Docker version check]({{< baseurl >}}/rke/latest/en/config-options/#supported-docker-versions) |
|
||||||
|
|||||||
Reference in New Issue
Block a user