Issues, whether bugs, tasks, or feature requests are essential for keeping goldilocks great. We believe it should be as easy as possible to contribute changes that get things working in your environment. There are a few guidelines that we need contributors to follow so that we can keep on top of things.
# Code of Conduct
This project adheres to a code of conduct. Please review this document before contributing to this project.
# Sign the CLA
Before you can contribute, you will need to sign the Contributor License Agreement (opens new window).
# Project Structure
Goldilocks can run in 3 modes. There is a CLI that allows the manipulation of VPA objects, a dashboard, and a controller that runs in-cluster and manages VPA objects based on namespace labels. The CLI uses the cobra package and the commands are in the
# Getting Started
We label issues with the "good first issue" tag (opens new window) if we believe they'll be a good starting point for new contributors. If you're interested in working on an issue, please start a conversation on that issue, and we can help answer any questions as they come up.
This repo contains a pre-commit file for use with pre-commit (opens new window). Just run
pre-commit install and you will have the hooks.
# Setting Up Your Development Environment
# Using Kind
Make sure you have the following installed:
- kind 0.9.0 (opens new window) or higher
- reckoner v1.4.0 (opens new window) or higher
- helm 2.13.1 (opens new window) or higher
Go into the /hack/kind (opens new window) directory and run
This will create a kind cluster, place a demo app, install VPA, and install the latest goldilocks. You can run your local development against this cluster.
# Using your own cluster
- A properly configured Golang environment with Go 1.11 or higher
- If you want to see the local changes you make on a dashboard, you will need access to a Kubernetes cluster defined in
~/.kube/configor the KUBECONFIG variable.
- The vertical pod autoscaler (opens new window) will need to be installed in the cluster.
- Install the project with
go get github.com/fairwindsops/goldilocks
- Change into the goldilocks directory which is installed at
make buildto ensure all dependencies are downloaded.
- See the dashboard with
go run main.go dashboard, then open http://localhost:8080/. This assumes that you have a working KUBECONFIG in place with access to a cluster.
# End-To-End Tests
The e2e tests run using Venom (opens new window). You can run them yourself by:
- installing venom
- setting up a kind cluster
kind create cluster
The tests are also run automatically by CI
You can add tests in the e2e/tests (opens new window) directory. See the Venom README for more info.
# Creating a New Issue
If you've encountered an issue that is not already reported, please create an issue that contains the following:
- Clear description of the issue
- Steps to reproduce it
- Appropriate labels
# Creating a Pull Request
Each new pull request should:
- Reference any related issues
- Add tests that show the issues have been solved
- Pass existing tests and linting
- Contain a clear indication of if they're ready for review or a work in progress
- Be up to date and/or rebased on the master branch
# Creating a new release
Push a new annotated tag. This tag should contain a changelog of pertinent changes.