/kops

Kubernetes Operations (kops) - Production Grade K8s Installation, Upgrades, and Management

Primary LanguageGoApache License 2.0Apache-2.0

Kubernetes Operations (kops)

Build Status Go Report Card GoDoc Widget

The easiest way to get a production grade Kubernetes cluster up and running.

What is kops?

We like to think of it as kubectl for clusters.

kops lets you deploy production-grade Kubernetes clusters from the command line, with options that support HA Masters. Kubernetes Operations supports deploying Kubernetes on Amazon Web Services (AWS) and support for more platforms is planned.

Launching a Kubernetes cluster hosted on AWS

Check out our tutorial for launching a Kubernetes cluster hosted on AWS.

Features

  • Automated Kubernetes cluster CRUD for (AWS)
  • Highly Available (HA) Kubernetes Masters Setup
  • Uses a state-sync model for dry-run and automatic idempotency
  • Custom support for kubectl add-ons
  • Kops can generate Terraform configuration
  • Based on a simple meta-model defined in a directory tree
  • Command line autocomplete
  • Community support
  • Upgrade from kube-up

Installing

kubectl is required, see here.

OSX From Homebrew (Latest Stable Release)

$ brew update && brew install kops

OSX From Homebrew (HEAD of master)

$ brew update && brew install --HEAD kops

Linux

Download the latest release, then:

$ chmod +x kops-linux-amd64                 # Add execution permissions
$ mv kops-linux-amd64 /usr/local/bin/kops   # Move the kops to /usr/local/bin

From Source

Go 1.7+ and make are required.

$ go get -d k8s.io/kops
$ cd ${GOPATH}/src/k8s.io/kops/
$ git checkout release
$ make

See building notes for more information.

At this time, Windows is not a supported platform.

Getting involved!

Want to contribute to kops? We would love the extra help from the community. We have a quickstart guide on adding a feature.

Kops also has time set aside every other week to offer help and guidance to the community. Kops maintainers have agreed to set aside time specifically dedicated to working with newcomers, helping with PRs, and discussing new features.

We recommend letting us know beforehand if you plan on attending so we can have time to prepare for the call.

Maintainer Schedule URL
@justinsb 2nd / 4th Friday 9am PDT Zoom
@chrislovecnm 2nd / 4th Friday 9am PDT Zoom
@kris-nova 2nd / 4th Friday 9am PDT Zoom

Reach out to us on kubernetes slack. A great place to get involved or ask questions is #sig-cluster-lifecycle.

Other Resources

History

View our changelog

GitHub Issues

Bugs

If you think you have found a bug please follow the instructions below.

  • Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate.
  • Set -v 10 command line option and save the log output. Please paste this into your issue.
  • Note the version of kops you are running (from kops version), and the command line options you are using
  • Open a new issue
  • Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others.
  • Feel free to reach out to the kops community on kubernetes slack

Features

We also use the issue tracker to track features. If you have an idea for a feature, or think you can help kops become even more awesome follow the steps below.

  • Open a new issue
  • Remember users might be searching for your issue in the future, so please give it a meaningful title to helps others.
  • Clearly define the use case, using concrete examples. EG: I type this and kops does that.
  • Some of our larger features will require some design. If you would like to include a technical design for your feature please include it in the issue.
  • After the new feature is well understood, and the design agreed upon we can start coding the feature. We would love for you to code it. So please open up a WIP (work in progress) pull request, and happy coding.