{"id":13448988,"url":"https://github.com/atlassian/escalator","last_synced_at":"2025-12-29T03:03:29.014Z","repository":{"id":32389225,"uuid":"118404024","full_name":"atlassian/escalator","owner":"atlassian","description":"Escalator is a batch or job optimized horizontal autoscaler for Kubernetes","archived":false,"fork":false,"pushed_at":"2025-05-08T01:30:47.000Z","size":5776,"stargazers_count":679,"open_issues_count":14,"forks_count":62,"subscribers_count":38,"default_branch":"master","last_synced_at":"2025-05-08T01:34:03.554Z","etag":null,"topics":["asg","auto-scaling-group","autoscaler","autoscaling","aws","batch","cluster","default-autoscaler","drain","golang","kubernetes","scale","scaling","workload","workloads"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/atlassian.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2018-01-22T04:00:31.000Z","updated_at":"2025-05-08T00:46:16.000Z","dependencies_parsed_at":"2024-02-03T20:42:57.888Z","dependency_job_id":"eba19fc1-f05b-4e5c-8ebc-7f4f87648fe0","html_url":"https://github.com/atlassian/escalator","commit_stats":{"total_commits":340,"total_committers":29,"mean_commits":"11.724137931034482","dds":"0.48235294117647054","last_synced_commit":"454c7c666b9173bfe01b28ca8360660228d61996"},"previous_names":[],"tags_count":27,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian%2Fescalator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian%2Fescalator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian%2Fescalator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/atlassian%2Fescalator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/atlassian","download_url":"https://codeload.github.com/atlassian/escalator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254059518,"owners_count":22007771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["asg","auto-scaling-group","autoscaler","autoscaling","aws","batch","cluster","default-autoscaler","drain","golang","kubernetes","scale","scaling","workload","workloads"],"created_at":"2024-07-31T06:00:27.252Z","updated_at":"2025-12-29T03:03:23.979Z","avatar_url":"https://github.com/atlassian.png","language":"Go","readme":"# Escalator\n\n[![Godoc](https://godoc.org/github.com/atlassian/escalator?status.svg)](https://godoc.org/github.com/atlassian/escalator)\n[![Build Status](https://github.com/atlassian/escalator/actions/workflows/build.yml/badge.svg?branch=master)](https://github.com/atlassian/escalator/actions/workflows/build.yml?query=branch%3Amaster)\n[![Go Report Card](https://goreportcard.com/badge/github.com/atlassian/escalator)](https://goreportcard.com/report/github.com/atlassian/escalator)\n[![license](https://img.shields.io/github/license/atlassian/escalator.svg)](LICENSE)\n\n**Escalator is a batch or job optimized horizontal autoscaler for Kubernetes**\n\nIt is designed for large batch or job based workloads that cannot be force-drained and moved when the cluster needs to \nscale down - Escalator will ensure pods have been completed on nodes before terminating them. It is also optimised for \nscaling up the cluster as fast as possible to ensure pods are not left in a pending state.\n\n## Key Features\n\n- Calculate requests and capacity to determine whether to scale up, down or to stay at the current scale\n- Waits until non-daemonset pods on nodes have completed before terminating the node\n- Designed to work on selected auto-scaling groups to allow the default\n  [Kubernetes Autoscaler](https://github.com/kubernetes/autoscaler) to continue to scale service based workloads\n- Automatically terminate oldest nodes first\n- Support for slack space to ensure extra space in the event of a spike of scheduled pods\n- Does not terminate or factor cordoned nodes into calculations - allows cordoned nodes to persist for debugging \n- Support for different cloud providers - AWS only at the moment\n- Scaling and utilisation metrics\n- Leader election so you can run a HA Deployment inside a cluster.\n- Basic support for multiple different types of instances in a Node Group.\n\nThe need for this autoscaler is derived from our own experiences with very large batch workloads being scheduled and the\ndefault autoscaler not scaling up the cluster fast enough. These workloads can't be force-drained by the default \nautoscaler and must complete before the node can be terminated.\n\n## Documentation and Design\n\nSee [Docs](docs/README.md)\n\n## Requirements\n\n- [Kubernetes](https://kubernetes.io/) version 1.24+. Escalator has been tested and deployed on 1.24+ and newer. Older \nversions of Kubernetes may have bugs or issues that will prevent it from functioning properly.\n- [Go](https://golang.org/) version 1.20+\n- Dependencies and their locked versions can be found in `go.mod` and `go.sum`.\n\n## Building\n\n```bash\n# Fetch dependencies and build Escalator\nmake build\n```\n\n## How to run - Quick Start\n\n### Locally (out of cluster)\n\n```bash\ngo run cmd/main.go --kubeconfig=~/.kube/config --nodegroups=nodegroups_config.yaml\n```\n\n### Deployment (in cluster)\n\nSee [Deployment](./docs/deployment/README.md) for full Deployment documentation.\n\n```bash\n# Build the docker image\ndocker build -t atlassian/escalator .\n\n# Create RBAC configuration\nkubectl create -f docs/deployment/escalator-rbac.yaml\n\n# Create config map - modify to suit your needs\nkubectl create -f docs/deployment/escalator-cm.yaml\n\n# Create deployment\nkubectl create -f docs/deployment/escalator-deployment.yaml\n```\n\n## Configuring\n\nSee [Configuration](docs/configuration/README.md)\n\n## Testing\n\n```bash\nmake test\n```\n\n### Test a specific package\n\nFor example, to test the controller package:\n\n```bash\ngo test ./pkg/controller\n```\n\n## Contributors\n\nPull requests, issues and comments welcome. For pull requests:\n\n* Add tests for new features and bug fixes\n* Follow the existing style (we are using [goreturns](https://github.com/sqs/goreturns) to format and lint escalator)\n* Separate unrelated changes into multiple pull requests\n\nSee the existing issues for things to start contributing.\n\nFor bigger changes, make sure you start a discussion first by creating\nan issue and explaining the intended change.\n\nAtlassian requires contributors to sign a Contributor License Agreement,\nknown as a CLA. This serves as a record stating that the contributor is\nentitled to contribute the code/documentation/translation to the project\nand is willing to have it used in distributions and derivative works\n(or is willing to transfer ownership).\n\nPrior to accepting your contributions we ask that you please follow the appropriate\nlink below to digitally sign the CLA. The Corporate CLA is for those who are\ncontributing as a member of an organization and the individual CLA is for\nthose contributing as an individual.\n\n* [CLA for corporate contributors](https://opensource.atlassian.com/corporate)\n* [CLA for individuals](https://opensource.atlassian.com/individual)\n\n## License\n\nCopyright (c) 2018 Atlassian and others.\nApache 2.0 licensed, see [LICENSE](./LICENSE) file.\n","funding_links":[],"categories":["Go","Cost \u0026 Governance","Pod scaling","Operators vs Controllers","HarmonyOS","Autoscaler","Related Software"],"sub_categories":["Autoscaling / Scheduling","Windows Manager","[Jenkins](#jenkins)"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlassian%2Fescalator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fatlassian%2Fescalator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fatlassian%2Fescalator/lists"}