8000 Update tortoise user document by sanposhiho · Pull Request #403 · mercari/tortoise · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Update tortoise user document #403

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

Merged
merged 1 commit into from
May 20, 2024
Merged

Update tortoise user document #403

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
101 changes: 61 additions & 40 deletions docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,47 +25,9 @@ spec:

This is the example for a minimum required configuration.

### updateMode

```yaml
apiVersion: autoscaling.mercari.com/v1beta3
kind: Tortoise
spec:
...
updateMode: Auto
```

`.spec.updateMode` could contain three values:
- `Off` (default): DryRun mode. The tortoise doesn't change anything in your workload or autoscaler.
- `Auto`: The tortoise keep updating your workload or autoscaler to be optimized.
- `Emergency`: The tortoise scale up/out your workload to be big enough so that the workload can handle unexpectedly bigger traffic.

#### updateMode: `Off`

`Off` is the default value of `updateMode`.
It means a DryRun mode - the tortoise doesn't change anything in your workload or autoscaler.

But, even during `Off` mode, the tortoise actually generates the recommendation for your workload's resource request, and your HPA's target utilization.
### Configure how each container's each resource is scaled (`.spec.AutoscalingPolicy` / `.spec.TargetRefs.HorizontalPodAutoscalerName`)

You can observe the recommendation values with these metrics:
- `mercari.tortoise.proposed_cpu_request`: CPU request a tortoise proposes.
- `mercari.tortoise.proposed_memory_request`: memory request that a tortoise proposes.
- `mercari.tortoise.proposed_hpa_minreplicas`: HPA `.spec.minReplicas` that a tortoise proposes.
- `mercari.tortoise.proposed_hpa_maxreplicas`: HPA `.spec.maxReplicas` that a tortoise proposes.
- `mercari.tortoise.proposed_hpa_utilization_target`: HPA `.spec.metrics[*].containerResource.target.averageUtilization` that a tortoise proposes.

#### updateMode: `Auto`

`Auto` is a update mode to let tortoise keep updating your workload or autoscaler to be optimized.

#### updateMode: `Emergency`

`Emergency` is a update mode to enable the emergency mode.
Please refer to [Emergency mode](./emergency.md) for more details.

### `.spec.AutoscalingPolicy`

There are two primary options for configuring resource scaling within containers:
There are two options for configuring resource scaling:
1. Allow Tortoise to automatically determine the appropriate autoscaling policy for each resource.
2. Manually define the autoscaling policy for each resource.

Expand All @@ -84,6 +46,27 @@ Additionally, if a `ContainerResource` metric is later added to an HPA associate
Tortoise will automatically update relevant resources to utilize a `Horizontal` policy in AutoscalingPolicy.
- if a container doesn't have the resource request, that container's autoscaling policy is always set to "Off" because tortoise cannot generate any recommendation without the resource request.

You can see how actually your tortoise scales your Pods with `.status.autoscalingPolicy`:

```yaml
apiVersion: autoscaling.mercari.com/v1beta3
kind: Tortoise
metadata:
name: your-tortoise-name
namespace: your-namespace
...
status:
autoscalingPolicy:
- containerName: awesome-mercari-container
policy:
cpu: Horizontal
memory: Vertical
- containerName: istio-proxy
policy:
cpu: Horizontal
memory: Vertical
```

#### 2. Manually define the autoscaling policy for each resource.

With the second option, you must manually specify the AutoscalingPolicy for the resources of each container within this field.
Expand Down Expand Up @@ -114,6 +97,44 @@ Be aware that when new containers are introduced to the workload, the Autoscalin
if you want to configure autoscaling for a new container,
as Tortoise will default to an `Off` policy for resources within the new container, preventing scaling.

### updateMode

```yaml
apiVersion: autoscaling.mercari.com/v1beta3
kind: Tortoise
spec:
...
updateMode: Auto
```

`.spec.updateMode` could contain three values:
- `Off` (default): DryRun mode. The tortoise doesn't change anything in your workload or autoscaler.
- `Auto`: The tortoise keep updating your workload or autoscaler to be optimized.
- `Emergency`: The tortoise scale up/out your workload to be big enough so that the workload can handle unexpectedly bigger traffic.

#### updateMode: `Off`

`Off` is the default value of `updateMode`.
It means a DryRun mode - the tortoise doesn't change anything in your workload or autoscaler.

But, even during `Off` mode, the tortoise actually generates the recommendation for your workload's resource request, and your HPA's target utilization.

You can observe the recommendation values with these metrics:
- `mercari.tortoise.proposed_cpu_request`: CPU request a tortoise proposes.
- `mercari.tortoise.proposed_memory_request`: memory request that a tortoise proposes.
- `mercari.tortoise.proposed_hpa_minreplicas`: HPA `.spec.minReplicas` that a tortoise proposes.
- `mercari.tortoise.proposed_hpa_maxreplicas`: HPA `.spec.maxReplicas` that a tortoise proposes.
- `mercari.tortoise.proposed_hpa_utilization_target`: HPA `.spec.metrics[*].containerResource.target.averageUtilization` that a tortoise proposes.

#### updateMode: `Auto`

`Auto` is a update mode to let tortoise keep updating your workload or autoscaler to be optimized.

#### updateMode: `Emergency`

`Emergency` is a update mode to enable the emergency mode.
Please refer to [Emergency mode](./emergency.md) for more details.

### `.spec.DeletionPolicy`

```yaml
Expand Down
0