Skip to content
Open
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To address these challenges, the platform team has embarked on developing Tortoi
an automated solution designed to meet all Kubernetes resource optimization needs.

This approach shifts the optimization responsibility from service owners to the platform team (Tortoises),
allowing for comprehensive tuning by the platform team to ensure all Tortoises in the cluster adapts to each workload.
allowing for comprehensive tuning by the platform team to ensure all Tortoises in the cluster adapt to each workload.
On the other hand, service owners are required to configure only a minimal number of parameters
to initiate autoscaling with Tortoise, significantly simplifying their involvement.

Expand Down
2 changes: 1 addition & 1 deletion api/v1beta3/tortoise_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -179,7 +179,7 @@ type TargetRefs struct {
HorizontalPodAutoscalerName *string `json:"horizontalPodAutoscalerName,omitempty" protobuf:"bytes,2,opt,name=horizontalPodAutoscalerName"`
}

// CrossVersionObjectReference contains enough information toet identify the referred resource.
// CrossVersionObjectReference contains enough information to let identify the referred resource.
type CrossVersionObjectReference struct {
// kind is the kind of the referent; More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Kind string `json:"kind" protobuf:"bytes,1,opt,name=kind"`
Expand Down
2 changes: 1 addition & 1 deletion docs/contributor-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ If you didn’t add a test, you didn’t fix the bug.
- **Do not** test anything manually in your Kubernetes cluster.
Instead, you **must** implement all testing in the e2e tests.
- **Do not** bring any breaking change in Tortoise CRD.
However, you **may** bring breaking changes in Golang functions or types within the repository - we're not developping the library and don't have to care much about downstream dependencies.
However, you **may** bring breaking changes in Golang functions or types within the repository - we're not developing the library and don't have to care much about downstream dependencies.

### Suggestion

Expand Down
4 changes: 2 additions & 2 deletions docs/horizontal.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Currently, Tortoise supports only `type: ContainerResource` metric.
If HPA has `type: Resource` metrics, Tortoise just removes them because they'd be conflict with `type: ContainerResource` metrics managed by Tortoise.
If HPA has metrics other than `Resource` or `ContainerResource`, Tortoise just keeps them.

### How Tortoise
### How Tortoise calculates the recommendations

### MaxReplicas

Expand Down Expand Up @@ -54,7 +54,7 @@ Supposing your web frontend is down, your backend app Pods would be scaled in be
But, when your web frontend is back, the huge traffic that the backend app usually handles would come again,
and if the backend had been scaled in too much, it could be overwhelmed easily.

To prevent this kind of issue like domino, Tortoise sets MinReplicas like above so that it can keep the replica number to some extend, preventing too much scaling in.
To prevent this kind of issue like domino, Tortoise sets MinReplicas like above so that it can keep the replica number to some extent, preventing too much scaling in.

### Target utilization

Expand Down