Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
74 changes: 60 additions & 14 deletions docs/commands/vks/config-auto-healing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,33 +4,68 @@

Configure auto-healing for a VKS cluster. Auto-healing automatically replaces unhealthy nodes to keep the cluster in a working state.

Only `--enable-auto-healing` is sent unconditionally. The optional threshold flags (`--max-unhealthy`, `--unhealthy-range`, `--timeout-unhealthy`) are only included in the request when explicitly provided on the command line.

Use `--dry-run` to preview the configuration that would be sent without executing the request.

## Synopsis

```
grn vks config-auto-healing
--cluster-id <value>
--enable-auto-healing
--enable-auto-healing <value>
[--max-unhealthy <value>]
[--unhealthy-range <value>]
[--timeout-unhealthy <value>]
[--dry-run]
```

## Options

`--cluster-id` (required)
: The ID of the cluster.
**`--cluster-id`** (string)

ID of the cluster to configure auto-healing for.

- Required: Yes

**`--enable-auto-healing`** (boolean)

Enable or disable auto-healing. Pass `true` to enable or `false` to disable.

- Required: Yes
- Possible values: `true`, `false`

**`--max-unhealthy`** (string)

Maximum proportion of unhealthy nodes tolerated before auto-healing is triggered. Accepts a percentage string.

- Required: No
- Constraints: percentage string, e.g. `30%`

**`--unhealthy-range`** (string)

Unhealthy node count range. When the number of unhealthy nodes falls within this range, auto-healing is triggered.

`--enable-auto-healing` (required)
: Whether to enable auto-healing. Pass `--enable-auto-healing` to enable, or `--enable-auto-healing=false` to disable.
- Required: No
- Constraints: bracket-enclosed range string, e.g. `[2-5]`

`--max-unhealthy` (optional)
: Maximum number (or percentage) of unhealthy nodes tolerated, e.g. `30%`.
**`--timeout-unhealthy`** (integer)

`--unhealthy-range` (optional)
: The unhealthy range threshold.
Time in seconds that a node may remain unhealthy before it is replaced.

`--timeout-unhealthy` (optional)
: Time in seconds a node may stay unhealthy before it is replaced.
- Required: No
- Default: `0`

**`--dry-run`** (boolean)

Preview the configuration that would be sent without executing the request.

- Required: No
- Default: `false`

## Global options

This command also accepts the global options (`--profile`, `--region`, `--output`, `--query`, `--endpoint-url`, `--debug`, …).

## Examples

Expand All @@ -39,16 +74,17 @@ Enable auto-healing with default thresholds:
```bash
grn vks config-auto-healing \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--enable-auto-healing
--enable-auto-healing true
```

Enable auto-healing with custom thresholds:

```bash
grn vks config-auto-healing \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--enable-auto-healing \
--enable-auto-healing true \
--max-unhealthy 30% \
--unhealthy-range '[2-5]' \
--timeout-unhealthy 300
```

Expand All @@ -57,5 +93,15 @@ Disable auto-healing:
```bash
grn vks config-auto-healing \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--enable-auto-healing=false
--enable-auto-healing false
```

Preview the configuration without applying it:

```bash
grn vks config-auto-healing \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--enable-auto-healing true \
--max-unhealthy 20% \
--dry-run
```
56 changes: 46 additions & 10 deletions docs/commands/vks/config-auto-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

## Description

Configure auto-upgrade schedule for a cluster. Sets the days and time when automatic Kubernetes version upgrades will be performed.
Configure the auto-upgrade schedule for a VKS cluster. Sets the days of the week and the time of day when automatic Kubernetes version upgrades will be performed.

> Formerly `set-auto-upgrade-config`. That name still works as a deprecated alias.
Use `--dry-run` to preview the configuration that would be sent without executing the request.

> **Alias:** `set-auto-upgrade-config` is a deprecated alias retained for backward compatibility. Prefer `config-auto-upgrade`.

## Synopsis

Expand All @@ -13,26 +15,50 @@ grn vks config-auto-upgrade
--cluster-id <value>
--weekdays <value>
--time <value>
[--dry-run]
```

## Options

`--cluster-id` (required)
: The ID of the cluster.
**`--cluster-id`** (string)

ID of the cluster to configure auto-upgrade for.

- Required: Yes

**`--weekdays`** (string)

Days of the week on which auto-upgrade will run, comma-separated.

- Required: Yes
- Possible values: `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat`, `Sun`
- Constraints: one or more values from the allowed set, e.g. `Mon,Wed,Fri`

**`--time`** (string)

Time of day at which auto-upgrade will run, in 24-hour `HH:mm` format.

- Required: Yes
- Constraints: `HH:mm`, e.g. `03:00`

`--weekdays` (required)
: Days of the week to perform auto upgrade, comma-separated. Valid values: `Mon`, `Tue`, `Wed`, `Thu`, `Fri`, `Sat`, `Sun`. Example: `Mon,Wed,Fri`
**`--dry-run`** (boolean)

`--time` (required)
: Time of day to perform auto upgrade in 24-hour format `HH:mm`. Example: `03:00`
Preview the configuration that would be sent without executing the request.

- Required: No
- Default: `false`

## Global options

This command also accepts the global options (`--profile`, `--region`, `--output`, `--query`, `--endpoint-url`, `--debug`, …).

## Examples

Set auto-upgrade to run on weekdays at 3 AM:

```bash
grn vks config-auto-upgrade \
--cluster-id k8s-xxxxx \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--weekdays Mon,Tue,Wed,Thu,Fri \
--time 03:00
```
Expand All @@ -41,7 +67,17 @@ Set auto-upgrade to run on weekends at midnight:

```bash
grn vks config-auto-upgrade \
--cluster-id k8s-xxxxx \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--weekdays Sat,Sun \
--time 00:00
```

Preview the configuration without applying it:

```bash
grn vks config-auto-upgrade \
--cluster-id cls-abc12345-6789-def0-1234-abcdef012345 \
--weekdays Mon,Wed,Fri \
--time 02:00 \
--dry-run
```
Loading
Loading