Skip to content

Commit 468b2f7

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

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

docs/datastore/backup_restore.md

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

docs/reference/server_config.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -71,26 +71,24 @@ The following options must be set to the same value on all servers in the cluste
7171
| etcd-snapshot-retention | Number of snapshots to retain | 5 | |
7272
| etcd-snapshot-dir | Directory to save db snapshots. | $&#123;data-dir&#125;/db/snapshots | |
7373
| etcd-snapshot-compress | Compress etcd snapshot | | |
74+
### S3 etcd Snapshot Storage
7475
| etcd-s3 | Enable backup to S3 | | |
7576
| etcd-s3-endpoint | S3 endpoint url | "s3.amazonaws.com" | |
7677
| etcd-s3-endpoint-ca | S3 custom CA cert to connect to S3 endpoint | | |
7778
| etcd-s3-skip-ssl-verify | Disables S3 SSL certificate validation | | |
7879
| etcd-s3-access-key | S3 access key | | AWS_ACCESS_KEY_ID |
7980
| etcd-s3-secret-key | S3 secret key | | AWS_SECRET_ACCESS_KEY |
81+
| etcd-s3-session-token | S3 session token | | AWS_SESSION_TOKEN |
8082
| etcd-s3-bucket | S3 bucket name | | |
83+
| etcd-s3-bucket-lookup-type | S3 bucket lookup type, one of 'auto', 'dns', 'path' | "auto" | |
8184
| etcd-s3-region | S3 region / bucket location (optional) | "us-east-1" | |
8285
| etcd-s3-folder | S3 folder | | |
86+
| etcd-s3-retention | S3 retention limit | 5 | |
87+
| etcd-s3-proxy | Proxy server to use when connecting to S3, overriding any proxy-releated environment variables | | |
88+
| 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 | | |
8389
| etcd-s3-insecure | Disables S3 over HTTPS | | |
8490
| etcd-s3-timeout | S3 timeout | 5m0s | |
8591

86-
:::info Version Gate
87-
Starting in versions v1.34.0+rke2r1, v1.33.4+rke2r1, v1.32.8+rke2r1, v1.31.12+rke2r1, RKE2 includes a new flag for S3 retention. It has the same default value as the local snapshot retention.
88-
:::
89-
90-
| Flag | Description | Default |
91-
| --- | --- | --- |
92-
| etcd-s3-retention | Number of snapshots in S3 to retain | 5 |
93-
9492
### Flags
9593
| Flag | Description |
9694
| --- | --- |

0 commit comments

Comments
 (0)