tortoise

README

tortoise

Tortoise, they are living in the Kubernetes cluster.

Tortoise, you need to feed only very few parameters to them.

Tortoise, they will soon start to eat historical usage data of Pods.

Tortoise, once you start to live with them, you no longer need to configure autoscaling by yourself.

Install

Tortoise, you cannot get it from the breeder.

Tortoise, you need to get it from GitHub instead.

# Install CRDs into the K8s cluster specified in ~/.kube/config.
make install
# Deploy controller to the K8s cluster specified in ~/.kube/config.
make deploy

Tortoise, you don't need a rearing cage, but need VPA in your Kubernetes cluster before installing it.

Usage

Tortoise, they only need the deployment name basically.

apiVersion: autoscaling.mercari.com/v1alpha1
kind: Tortoise
metadata:
  name: lovely-tortoise
  namespace: zoo
spec:
  updateMode: Auto
  targetRefs:
    deploymentName: sample-deployment

Tortoise, then they'll prepare/keep adjusting HPA and VPA to achieve efficient autoscaling based on the past behavior of the workload.

Documentations

• Concept: describes a brief overview of tortoise.
• Horizontal scaling: describes how the Tortoise does the horizontal autoscaling.
• Vertical scaling: describes how the Tortoise does the vertical autoscaling.
• Emergency mode: describes the emergency mode.
• Flag configurations for admin: describes how the cluster admin can configure the global behavior via flags
• Technically details: describes the technically details of Tortoise. (mostly for the contributors)
• Contributor guide: describes other stuff for the contributor. (testing etc)

API definition

• Tortoise

Contribution

Before implementing any feature changes as Pull Requests, please raise the Issue and discuss what you propose with maintainers.

Also, please read the CLA carefully before submitting your contribution to Mercari. Under any circumstances, by submitting your contribution, you are deemed to accept and agree to be bound by the terms and conditions of the CLA.

https://www.mercari.com/cla/

LICENSE

Copyright 2023 Mercari, Inc.

Licensed under the MIT License.