85bbe7df36
|
||
|---|---|---|
| .back_github | ||
| _vendor | ||
| addons | ||
| channels | ||
| charts/kops | ||
| cloudmock/aws | ||
| cmd | ||
| dns-controller | ||
| docker | ||
| docs | ||
| examples | ||
| federation | ||
| hack | ||
| hooks | ||
| images | ||
| nodeup/pkg | ||
| permalinks | ||
| pkg | ||
| protokube | ||
| tests | ||
| upup | ||
| util/pkg | ||
| vendor | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| .shipbot.yaml | ||
| .travis.yml | ||
| CHANGES.md | ||
| CONTRIBUTING.md | ||
| HISTORY.md | ||
| LICENSE | ||
| Makefile | ||
| OWNERS | ||
| README.md | ||
| ROADMAP.md | ||
| code-of-conduct.md | ||
| doc.go | ||
| version.go | ||
README.md
Kubernetes Operations (kops)
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 helps you create, destroy, upgrade and maintain production-grade, highly available, Kubernetes clusters from the command line. AWS (Amazon Web Services) is currently officially supported, with GCE and VMware vSphere in alpha and other platforms planned.
Can I see it in action?
Launching a Kubernetes cluster hosted on AWS
To replicate the above demo, check out our tutorial for launching a Kubernetes cluster hosted on AWS.
Features
- Automates the provisioning of Kubernetes clusters in (AWS)
- Deploys Highly Available (HA) Kubernetes Masters
- Supports upgrading from kube-up
- Built on a state-sync model for dry-runs and automatic idempotency
- Ability to generate configuration files for AWS CloudFormation and Terraform Terraform configuration
- Supports custom Kubernetes add-ons
- Command line autocompletion
- Community supported!
Installing
kubectl is required, see here.
OSX From Homebrew (Latest Stable Release)
$ brew update && brew install 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
Developer From Source
Go 1.8+ and make are required. You may need to do a full build including pushing protokube, nodeup, and kops to s3.
See the install notes for more information.
$ go get -d k8s.io/kops
$ cd ${GOPATH}/src/k8s.io/kops/
$ git checkout release
$ make
At this time, Windows is not a supported platform.
History
See the releases for more information on changes between releases.
Getting involved and contributing!
Are you interested in contributing to kops? We, the maintainers and community, would love your suggestions, contributions, and help! We have a quick-start guide on adding a feature. Also, the maintainers can be contacted at any time to learn more about how to get involved.
In the interest of getting more new folks involved with kops, we are starting to tag issues with good-starter-issue. These are typically issues that have smaller scope but are good ways to start to get acquainted with the codebase.
We also encourage ALL active community participants to act as if they are maintainers, even if you don't have "official" write permissions. This is a community effort, we are here to serve the Kubernetes community. If you have an active interest and you want to get involved, you have real power! Don't assume that the only people who can get things done around here are the "maintainers".
We also would love to add more "official" maintainers, so show us what you can do!
What this means:
Issues
- Help read and triage issues, assist when possible.
- Point out issues that are duplicates, out of date, etc.
- Even if you don't have tagging permissions, make a note and tag maintainers. (
/close,/dupe #127)
- Even if you don't have tagging permissions, make a note and tag maintainers. (
Pull Requests
- Read and review the code. Leave comments, questions, and critiques (
/lgtm) - Download, compile, and run the code and make sure the tests pass (make test).
- Also verify that the new feature seems sane, follows best architectural patterns, and includes tests.
Maintainers
Office Hours
Kops maintainers set aside one hour every other week for public office hours. Office hours are hosted on a zoom video chat on Fridays at 5 pm UTC/12 noon ET/9 am US Pacific, on odd week numbered weeks. We strive to get to know and help developers either working on kops or interested in getting to know more about the project.
Open Office Hours Topics
Include but not limited to:
- Help and guide to those who attend, who are interested in contributing.
- Discuss the current state of the kops project, including releases.
- Strategize about how to move
kopsforward. - Collaborate about open and upcoming PRs.
- Present demos.
This time is focused on developers, although we will never turn a courteous participant away. Please swing by, even if you've never actually installed kops.
We encourage you to reach out beforehand if you plan on attending. You're welcome to join any session, and please feel free to add an item to the agenda where we track notes from office hours.
Office hours are hosted on Zoom video conference, held on Fridays at 5 pm UTC/12 noon ET/9 am US Pacific every other odd numbered week.
You can check your week number using:
date +%V
The maintainers and other community members are generally available on the kubernetes slack in #kops, so come find and chat with us about how kops can be better for you!
Other Resources
- Create kubecfg settings for kubectl
- Set up add-ons, to add important functionality to Kubernetes
- Learn about InstanceGroups; change instance types, number of nodes, and other options
- Read about networking options
- Look at our other interesting modes
- Full command line interface documentation
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 10command 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
thisand kops doesthat. - 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.