Skip to content

Commit 5f420ba

Browse files
committed
Add a couple missing etcd-s3 flags
Signed-off-by: Brad Davidson <brad.davidson@rancher.com>
1 parent fb489bb commit 5f420ba

File tree

2 files changed

+13
-5
lines changed

2 files changed

+13
-5
lines changed

docs/cli/etcd-snapshot.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,12 @@ K3s supports replicating etcd snapshots to and restoring etcd snapshots from S3-
9595
| `--etcd-s3-skip-ssl-verify` | Disables S3 SSL certificate validation |
9696
| `--etcd-s3-access-key` | S3 access key |
9797
| `--etcd-s3-secret-key` | S3 secret key |
98+
| `--etcd-s3-session-token` | S3 session token |
9899
| `--etcd-s3-bucket` | S3 bucket name |
100+
| `--etcd-s3-bucket-lookup-type` | S3 bucket lookup type, one of 'auto', 'dns', 'path'; default is 'auto' if not set |
99101
| `--etcd-s3-region` | S3 region / bucket location (optional). defaults to us-east-1 |
100102
| `--etcd-s3-folder` | S3 folder |
103+
| `--etcd-s3-retention` | S3 retention limit (default: 5) |
101104
| `--etcd-s3-proxy` | Proxy server to use when connecting to S3, overriding any proxy-releated environment variables |
102105
| `--etcd-s3-insecure` | Disables S3 over HTTPS |
103106
| `--etcd-s3-timeout` | S3 timeout (default: `5m0s`) |

docs/cli/server.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,23 +47,28 @@ The following options must be set to the same value on all servers in the cluste
4747
| `--etcd-snapshot-schedule-cron` value | | "0 */12 \* \* \*" | Snapshot interval time in cron spec. eg. every 5 hours '0 */5 _ \* _' |
4848
| `--etcd-snapshot-retention` value | | 5 | Number of snapshots to retain |
4949
| `--etcd-snapshot-dir` value | | $\{data-dir\}/db/snapshots | Directory to save db snapshots |
50+
51+
### S3 etcd Snapshot Storage
52+
53+
| Flag | Environment Variable | Default | Description |
54+
|---------------------------------------|--------------------------|----------------------------------------|-------------------------------------------------------------------------------|
5055
| `--etcd-s3` | | | Enable backup to S3 |
5156
| `--etcd-s3-endpoint` value | | "s3.amazonaws.com" | S3 endpoint url |
5257
| `--etcd-s3-endpoint-ca` value | | | S3 custom CA cert to connect to S3 endpoint |
5358
| `--etcd-s3-skip-ssl-verify` | | | Disables S3 SSL certificate validation |
5459
| `--etcd-s3-access-key` value | `AWS_ACCESS_KEY_ID` | | S3 access key |
5560
| `--etcd-s3-secret-key` value | `AWS_SECRET_ACCESS_KEY` | | S3 secret key |
61+
| `--etcd-s3-session-token` value | `AWS_SESSION_TOKEN` | | S3 session token |
5662
| `--etcd-s3-bucket` value | | | S3 bucket name |
63+
| `--etcd-s3-bucket-lookup-type` value | | | S3 bucket lookup type, one of 'auto', 'dns', 'path'; default is 'auto' if not set |
5764
| `--etcd-s3-region` value | | "us-east-1" | S3 region / bucket location (optional) |
5865
| `--etcd-s3-folder` value | | | S3 folder |
59-
| `--etcd-s3-proxy` | | | Proxy server to use when connecting to S3, overriding any proxy-releated environment variables |
60-
| `--etcd-s3-config-secret` | | | Name of secret in the kube-system namespace used to configure S3, if etcd-s3 is enabled and no other etcd-s3 options are set |
66+
| `--etcd-s3-retention` value | | 5 | S3 retention limit |
67+
| `--etcd-s3-proxy` value | | | Proxy server to use when connecting to S3, overriding any proxy-releated environment variables |
68+
| `--etcd-s3-config-secret` value | | | Name of secret in the kube-system namespace used to configure S3, if etcd-s3 is enabled and no other etcd-s3 options are set |
6169
| `--etcd-s3-insecure` | | | Disables S3 over HTTPS |
6270
| `--etcd-s3-timeout` value | | 5m0s | S3 timeout (default: 5m0s) |
6371

64-
65-
66-
6772
### Cluster Options
6873

6974
| Flag | Environment Variable | Description |

0 commit comments

Comments
 (0)