Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update to Docusaurous 3.0.0 #200

Merged
merged 6 commits into from
Nov 20, 2023
Merged

Update to Docusaurous 3.0.0 #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8007477
Prep en pages for MDX 3
dereknola Nov 17, 2023
efdfa2b
Fix for zh and kr translation for MDX3
dereknola Nov 17, 2023
ae28329
Update to docusaurus 3.0.0
dereknola Nov 17, 2023
97deff7
Fix broken link
dereknola Nov 17, 2023
58e7af8
Update CI nodejs to 18
dereknola Nov 17, 2023
41ab2cf
Remove extra `
dereknola Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ jobs:
- uses: actions/checkout@v3
with:
ref: ${{ github.event.inputs.dev_branch }}
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18
cache: yarn

- name: Install dependencies
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/test-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
- uses: actions/setup-node@v4
with:
node-version: 16.x
node-version: 18
cache: yarn

- name: Install dependencies
Expand Down
48 changes: 25 additions & 23 deletions docs/cli/server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,29 +34,31 @@ The following options must be set to the same value on all servers in the cluste

### Database

| Flag | Environment Variable | Description |
| ------------------------------------- | -------------------------- | -------------------------------------------------------------------------------------------------------- |
| `--datastore-endpoint` value | `K3S_DATASTORE_ENDPOINT` | Specify etcd, Mysql, Postgres, or Sqlite (default) data source name |
| `--datastore-cafile` value | `K3S_DATASTORE_CAFILE` | TLS Certificate Authority file used to secure datastore backend communication |
| `--datastore-certfile` value | `K3S_DATASTORE_CERTFILE` | TLS certification file used to secure datastore backend communication |
| `--datastore-keyfile` value | `K3S_DATASTORE_KEYFILE` | TLS key file used to secure datastore backend communication |
| `--etcd-expose-metrics` | N/A | Expose etcd metrics to client interface (default: false) |
| `--etcd-disable-snapshots` | N/A | Disable automatic etcd snapshots |
| `--etcd-snapshot-name` value | N/A | Set the base name of etcd snapshots. Default: etcd-snapshot-`<unix-timestamp>` (default:"etcd-snapshot") |
| `--etcd-snapshot-schedule-cron` value | N/A | Snapshot interval time in cron spec. eg. every 5 hours '0 */5 _ \* _' (default: "0 */12 \* \* \*") |
| `--etcd-snapshot-retention` value | N/A | Number of snapshots to retain (default: 5) |
| `--etcd-snapshot-dir` value | N/A | Directory to save db snapshots (default: ${data-dir}/db/snapshots) |
| `--etcd-s3` | N/A | Enable backup to S3 |
| `--etcd-s3-endpoint` value | N/A | S3 endpoint url (default: "s3.amazonaws.com") |
| `--etcd-s3-endpoint-ca` value | N/A | S3 custom CA cert to connect to S3 endpoint |
| `--etcd-s3-skip-ssl-verify` | N/A | Disables S3 SSL certificate validation |
| `--etcd-s3-access-key` value | `AWS_ACCESS_KEY_ID` | S3 access key |
| `--etcd-s3-secret-key` value | `AWS_SECRET_ACCESS_KEY` | S3 secret key |
| `--etcd-s3-bucket` value | N/A | S3 bucket name |
| `--etcd-s3-region` value | N/A | S3 region / bucket location (optional) (default: "us-east-1") |
| `--etcd-s3-folder` value | N/A | S3 folder |
| `--etcd-s3-insecure` | Disables S3 over HTTPS |
| `--etcd-s3-timeout` value | S3 timeout (default: 5m0s) |
| Flag | Environment Variable | Default | Description |
|---------------------------------------|--------------------------|------------------------------------|-------------------------------------------------------------------------------|
| `--datastore-endpoint` value | `K3S_DATASTORE_ENDPOINT` | | Specify etcd, Mysql, Postgres, or Sqlite data source name |
| `--datastore-cafile` value | `K3S_DATASTORE_CAFILE` | | TLS Certificate Authority file used to secure datastore backend communication |
| `--datastore-certfile` value | `K3S_DATASTORE_CERTFILE` | | TLS certification file used to secure datastore backend communication |
| `--datastore-keyfile` value | `K3S_DATASTORE_KEYFILE` | | TLS key file used to secure datastore backend communication |
| `--etcd-expose-metrics` | | false | Expose etcd metrics to client interface |
| `--etcd-disable-snapshots` | | false | Disable automatic etcd snapshots |
| `--etcd-snapshot-name` value | | "etcd-snapshot-&lt;unix-timestamp&gt;" | Set the base name of etcd snapshots. |
| `--etcd-snapshot-schedule-cron` value | | "0 */12 \* \* \*" | Snapshot interval time in cron spec. eg. every 5 hours '0 */5 _ \* _' |
| `--etcd-snapshot-retention` value | | 5 | Number of snapshots to retain |
| `--etcd-snapshot-dir` value | | $\{data-dir\}/db/snapshots | Directory to save db snapshots |
| `--etcd-s3` | | | Enable backup to S3 |
| `--etcd-s3-endpoint` value | | "s3.amazonaws.com" | S3 endpoint url |
| `--etcd-s3-endpoint-ca` value | | | S3 custom CA cert to connect to S3 endpoint |
| `--etcd-s3-skip-ssl-verify` | | | Disables S3 SSL certificate validation |
| `--etcd-s3-access-key` value | `AWS_ACCESS_KEY_ID` | | S3 access key |
| `--etcd-s3-secret-key` value | `AWS_SECRET_ACCESS_KEY` | | S3 secret key |
| `--etcd-s3-bucket` value | | | S3 bucket name |
| `--etcd-s3-region` value | | "us-east-1" | S3 region / bucket location (optional) |
| `--etcd-s3-folder` value | | | S3 folder |
| `--etcd-s3-insecure` | | | Disables S3 over HTTPS |
| `--etcd-s3-timeout` value | | 5m0s | S3 timeout (default: 5m0s) |




### Cluster Options
Expand Down
18 changes: 9 additions & 9 deletions docs/cli/token.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ The server token is also used as the [PBKDF2](https://en.wikipedia.org/wiki/PBKD
Unless custom CA certificates are in use, only the short (password-only) token format can be used when starting the first server in the cluster. This is because the cluster CA hash cannot be known until after the server has generated the self-signed cluster CA certificates.
:::

For more information on using custom CA certificates, see the [`k3s certificate` documentation](certificate.md#).
For more information on using custom CA certificates, see the [`k3s certificate` documentation](./certificate.md).
For more information on backing up your cluster, see the [Backup and Restore](../datastore/backup-restore.md) documentation.

### Agent
Expand Down Expand Up @@ -105,8 +105,8 @@ A token in secure format, including the cluster CA hash, will be written to stdo

Flag | Description
---- | ----
`--data-dir` value |(data) Folder to hold state default /var/lib/rancher/k3s or ${HOME}/.rancher/k3s if not root
`--kubeconfig` value | (cluster) Server to connect to [$KUBECONFIG]
`--data-dir` value | Folder to hold state (default: /var/lib/rancher/k3s or $\{HOME\}/.rancher/k3s if not root)
`--kubeconfig` value | Server to connect to [$KUBECONFIG]
`--description` value | A human friendly description of how this token is used
`--groups` value | Extra groups that this token will authenticate as when used for authentication. (default: Default: "system:bootstrappers:k3s:default-node-token")
`--ttl` value | The duration before the token is automatically deleted (e.g. 1s, 2m, 3h). If set to '0', the token will never expire (default: 24h0m0s)
Expand All @@ -118,8 +118,8 @@ Delete one or more tokens. The full token can be provided, or just the token ID.

Flag | Description
---- | ----
`--data-dir` value |(data) Folder to hold state default /var/lib/rancher/k3s or ${HOME}/.rancher/k3s if not root
`--kubeconfig` value |(cluster) Server to connect to [$KUBECONFIG]
`--data-dir` value | Folder to hold state (default: /var/lib/rancher/k3s or $\{HOME\}/.rancher/k3s if not root)
`--kubeconfig` value |Server to connect to [$KUBECONFIG]

#### `k3s token generate`

Expand All @@ -129,15 +129,15 @@ You don't have to use this command in order to generate a token. You can do so y

Flag | Description
---- | ----
`--data-dir` value | (data) Folder to hold state default /var/lib/rancher/k3s or ${HOME}/.rancher/k3s if not root
`--kubeconfig` value | (cluster) Server to connect to [$KUBECONFIG]
`--data-dir` value | Folder to hold state (default: /var/lib/rancher/k3s or $\{HOME\}/.rancher/k3s if not root)
`--kubeconfig` value | Server to connect to [$KUBECONFIG]

#### `k3s token list`

List bootstrap tokens, showing their ID, description, and remaining time-to-live.

Flag | Description
---- | ----
`--data-dir` value | (data) Folder to hold state default /var/lib/rancher/k3s or ${HOME}/.rancher/k3s if not root
`--kubeconfig` value | (cluster) Server to connect to [$KUBECONFIG]
`--data-dir` value | Folder to hold state (default: /var/lib/rancher/k3s or $\{HOME\}/.rancher/k3s if not root)
`--kubeconfig` value | Server to connect to [$KUBECONFIG]
`--output` value | Output format. Valid options: text, json (default: "text")
2 changes: 1 addition & 1 deletion docs/reference/env-variables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ When using this method to install K3s, the following environment variables can b
| `INSTALL_K3S_TYPE` | Type of systemd service to create, will default from the K3s exec command if not specified. |
| `INSTALL_K3S_SELINUX_WARN` | If set to true will continue if k3s-selinux policy is not found. |
| `INSTALL_K3S_SKIP_SELINUX_RPM` | If set to true will skip automatic installation of the k3s RPM. |
| `INSTALL_K3S_CHANNEL_URL` | Channel URL for fetching K3s download URL. Defaults to <https://update.k3s.io/v1-release/channels>. |
| `INSTALL_K3S_CHANNEL_URL` | Channel URL for fetching K3s download URL. Defaults to https://update.k3s.io/v1-release/channels. |
| `INSTALL_K3S_CHANNEL` | Channel to use for fetching K3s download URL. Defaults to "stable". Options include: `stable`, `latest`, `testing`. |

This example shows where to place aforementioned environment variables as options (after the pipe):
Expand Down
Loading
Loading