https://github.com/jthomperoo/custom-pod-autoscaler-operator

Operator for managing Kubernetes Custom Pod Autoscalers (CPA).
https://github.com/jthomperoo/custom-pod-autoscaler-operator

autoscaler autoscaling kubernetes kubernetes-operator

Last synced: 3 months ago
JSON representation

Operator for managing Kubernetes Custom Pod Autoscalers (CPA).

• Host: GitHub
• URL: https://github.com/jthomperoo/custom-pod-autoscaler-operator
• Owner: jthomperoo
• License: apache-2.0
• Created: 2019-09-26T13:38:35.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-19T13:07:20.000Z (7 months ago)
• Last Synced: 2024-06-20T12:59:45.169Z (5 months ago)
• Topics: autoscaler, autoscaling, kubernetes, kubernetes-operator
• Language: Go
• Homepage:
• Size: 444 KB
• Stars: 40
• Watchers: 5
• Forks: 6
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-cloud-native - custom-pod-autoscaler-operator - Operator for managing Kubernetes Custom Pod Autoscalers. (Autoscaler)

README

        
[![Build](https://github.com/jthomperoo/custom-pod-autoscaler-operator/workflows/main/badge.svg)](https://github.com/jthomperoo/custom-pod-autoscaler-operator/actions)

[![go.dev](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat)](https://pkg.go.dev/github.com/jthomperoo/custom-pod-autoscaler-operator)

[![Go Report Card](https://goreportcard.com/badge/github.com/jthomperoo/custom-pod-autoscaler-operator)](https://goreportcard.com/report/github.com/jthomperoo/custom-pod-autoscaler-operator)

[![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

# Custom Pod Autoscaler Operator

This is the operator for managing [Custom Pod Autoscalers](https://github.com/jthomperoo/custom-pod-autoscaler) (CPA).

This allows you to add your own CPAs to the cluster to manage autoscaling deployments, enabling this is a requirement

before you can add your own CPAs.

## Installation

See the [install guide](INSTALL.md) to see more in depth installation options, such as namespace specific installs and

installation using kubectl.

### Quick start

Run this to install the Operator and Custom Pod Autoscaler definition with cluster-wide scope on your cluster:

```

VERSION=v1.4.2

HELM_CHART=custom-pod-autoscaler-operator

helm install ${HELM_CHART} https://github.com/jthomperoo/custom-pod-autoscaler-operator/releases/download/${VERSION}/custom-pod-autoscaler-operator-${VERSION}.tgz

```

## Usage

See the [usage guide](USAGE.md) to see some simple usage options. For more indepth examples, check out the

[Custom Pod Autoscaler repo](https://github.com/jthomperoo/custom-pod-autoscaler).

## Developing

Developing this project requires these dependencies:

* [Go](https://golang.org/doc/install) == `1.18`

See the [contributing guide](CONTRIBUTING.md) for more information about how you can develop and contribute to this

project.

## Commands

* `make` - builds the operator binary.

* `make docker` - build the docker image for the operator.

* `make lint` - lints the codebase.

* `make format` - formats the codebase, must be run to pass the CI.

* `make test` - runs the Go tests.

* `make generate` - generates boilerplate and YAML config for the operator.

* `make view_coverage` - opens up any generated coverage reports in the browser.