mirror of https://github.com/kubernetes/kops.git
Remove duplicated docs
The docs in README.md is duplicated in /docs, but we are not good at keeping them in sync. Therefor I removed most of the information from README.md andr refer to the docs instead. Also fixed a few broken/missing links.
This commit is contained in:
Ole Markus With
parent
a8f13e319c
commit
94effc501b
200
README.md
200
README.md
|
|
@ -29,33 +29,9 @@ in alpha, and other platforms planned.
|
|||
</p>
|
||||
|
||||
|
||||
## Launching a Kubernetes cluster hosted on AWS, GCE, DigitalOcean or OpenStack
|
||||
## Installing and launching a Kubernetes cluster hosted on AWS, GCE, DigitalOcean or OpenStack
|
||||
|
||||
To replicate the above demo, check out our [tutorial](/docs/getting_started/aws.md) for
|
||||
launching a Kubernetes cluster hosted on AWS.
|
||||
|
||||
To install a Kubernetes cluster on GCE please follow this [guide](/docs/getting_started/gce.md).
|
||||
|
||||
To install a Kubernetes cluster on DigitalOcean, follow this [guide](/docs/getting_started/digitalocean.md).
|
||||
|
||||
To install a Kubernetes cluster on OpenStack, follow this [guide](/docs/getting_started/openstack.md).
|
||||
|
||||
**For anything beyond experimental clusters it is highly encouraged to [version control the cluster manifest files](/docs/manifests_and_customizing_via_api.md) and [run kops in a CI environment](/docs/continuous_integration.md).**
|
||||
|
||||
## Features
|
||||
|
||||
* Automates the provisioning of Kubernetes clusters in [AWS](/docs/getting_started/aws.md), [OpenStack](/docs/getting_started/openstack.md) and [GCE](/docs/getting_started/gce.md)
|
||||
* Deploys Highly Available (HA) Kubernetes Masters
|
||||
* Built on a state-sync model for **dry-runs** and automatic **idempotency**
|
||||
* Ability to generate [Terraform](/docs/terraform.md)
|
||||
* Supports custom Kubernetes [add-ons](/docs/operations/addons.md)
|
||||
* Command line [autocompletion](/docs/cli/kops_completion.md)
|
||||
* YAML Manifest Based API [Configuration](/docs/manifests_and_customizing_via_api.md)
|
||||
* [Templating](/docs/cluster_template.md) and dry-run modes for creating
|
||||
Manifests
|
||||
* Choose from eight different CNI [Networking](/docs/networking.md) providers out-of-the-box
|
||||
* Supports upgrading from [kube-up](/docs/upgrade_from_kubeup.md)
|
||||
* Capability to add containers, as hooks, and files to nodes via a [cluster manifest](/docs/cluster_spec.md)
|
||||
See [Getting Started](https://kops.sigs.k8s.io/getting_started/install/)
|
||||
|
||||
|
||||
## Documentation
|
||||
|
|
@ -63,181 +39,19 @@ To install a Kubernetes cluster on OpenStack, follow this [guide](/docs/getting_
|
|||
Documentation is in the `/docs` directory, and can be seen at [kops.sigs.k8s.io](https://kops.sigs.k8s.io/).
|
||||
|
||||
|
||||
## Kubernetes Release Compatibility
|
||||
## Releases and kubernetes Release Compatibility
|
||||
|
||||
|
||||
### Kubernetes Version Support
|
||||
|
||||
kops is intended to be backward compatible. It is always recommended to use the
|
||||
latest version of kops with whatever version of Kubernetes you are using. We suggest
|
||||
kops users run one of the [3 minor versions](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md#supported-releases-and-component-skew) Kubernetes is supporting however we
|
||||
do our best to support previous releases for a period of time.
|
||||
|
||||
One exception, in regard to compatibility, kops supports the equivalent
|
||||
Kubernetes minor release number. A minor version is the second digit in the
|
||||
release number. kops version 1.13.0 has a minor version of 13. The numbering
|
||||
follows the semantic versioning specification, MAJOR.MINOR.PATCH.
|
||||
|
||||
For example, kops 1.12.0 does not support Kubernetes 1.13.0, but kops 1.13.0
|
||||
supports Kubernetes 1.12.2 and previous Kubernetes versions. Only when the kops minor
|
||||
version matches the Kubernetes minor version does kops officially support the
|
||||
Kubernetes release. kops does not stop a user from installing mismatching
|
||||
versions of K8s, but Kubernetes releases always require kops to install specific
|
||||
versions of components like docker, that tested against the particular
|
||||
Kubernetes version.
|
||||
|
||||
|
||||
#### Compatibility Matrix
|
||||
|
||||
| kops version | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x | k8s 1.16.x |
|
||||
|---------------|------------|------------|------------|------------|------------|
|
||||
| 1.16.0 | ✔ | ✔ | ✔ | ✔ | ✔ |
|
||||
| 1.15.x | ✔ | ✔ | ✔ | ✔ | ⚫ |
|
||||
| 1.14.x | ✔ | ✔ | ✔ | ⚫ | ⚫ |
|
||||
| ~~1.13.x~~ | ✔ | ✔ | ⚫ | ⚫ | ⚫ |
|
||||
| ~~1.12.x~~ | ✔ | ⚫ | ⚫ | ⚫ | ⚫ |
|
||||
|
||||
Use the latest version of kops for all releases of Kubernetes, with the caveat
|
||||
that higher versions of Kubernetes are not _officially_ supported by kops. Releases which are ~~crossed out~~ _should_ work but we suggest should be upgraded soon.
|
||||
|
||||
### kops Release Schedule
|
||||
|
||||
This project does not follow the Kubernetes release schedule. `kops` aims to
|
||||
provide a reliable installation experience for kubernetes, and typically
|
||||
releases about a month after the corresponding Kubernetes release. This time
|
||||
allows for the Kubernetes project to resolve any issues introduced by the new
|
||||
version and ensures that we can support the latest features. kops will release
|
||||
alpha and beta pre-releases for people that are eager to try the latest
|
||||
Kubernetes release. Please only use pre-GA kops releases in environments that
|
||||
can tolerate the quirks of new releases, and please do report any issues
|
||||
encountered.
|
||||
|
||||
|
||||
## Installing
|
||||
|
||||
### Prerequisite
|
||||
|
||||
`kubectl` is required, see [here](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
|
||||
|
||||
|
||||
### OSX From Homebrew
|
||||
|
||||
```console
|
||||
brew update && brew install kops
|
||||
```
|
||||
|
||||
The `kops` binary is also available via our [releases](https://github.com/kubernetes/kops/releases/latest).
|
||||
|
||||
|
||||
### Linux
|
||||
|
||||
```console
|
||||
curl -LO https://github.com/kubernetes/kops/releases/download/$(curl -s https://api.github.com/repos/kubernetes/kops/releases/latest | grep tag_name | cut -d '"' -f 4)/kops-linux-amd64
|
||||
chmod +x kops-linux-amd64
|
||||
sudo mv kops-linux-amd64 /usr/local/bin/kops
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
1) Get `kops-windows-amd64` from our [releases](https://github.com/kubernetes/kops/releases/latest).
|
||||
2) Rename `kops-windows-amd64` to `kops.exe` and store it in a preferred path.
|
||||
3) Make sure the path you chose is added to your `Path` environment variable.
|
||||
|
||||
## Release History
|
||||
|
||||
See the [releases](https://github.com/kubernetes/kops/releases) for more
|
||||
information on changes between releases.
|
||||
See [Releases and versioning](https://kops.sigs.k8s.io/welcome/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](/docs/development/adding_a_feature.md). Also, the
|
||||
maintainers can be contacted at any time to learn more about how to get
|
||||
involved.
|
||||
See [Contributing](https://kops.sigs.k8s.io/welcome/contributing/)
|
||||
|
||||
In the interest of getting more newer 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`).
|
||||
|
||||
__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.
|
||||
|
||||
This repository uses the Kubernetes bots. See a full list of the commands [here](
|
||||
https://go.k8s.io/bot-commands).
|
||||
|
||||
|
||||
## Office Hours
|
||||
### Office Hours
|
||||
|
||||
Kops maintainers set aside one hour every other week for **public** office hours. This time is used to gather with community members interested in kops. This session is open to both developers and users.
|
||||
|
||||
Office hours are hosted on a [zoom video chat](https://zoom.us/my/k8ssigaws) on Fridays at [12 noon (Eastern Time)/9 am (Pacific Time)](https://www.worldtimebuddy.com/?pl=1&lid=100,5,8,12) during weeks with odd "numbers". To check this weeks' number, run: `date +%V`. If the response is odd, join us on Friday for office hours!
|
||||
|
||||
### Office Hours Topics
|
||||
|
||||
We do maintain an [agenda](https://docs.google.com/document/d/12QkyL0FkNbWPcLFxxRGSPt_tNPBHbmni3YLY-lHny7E/edit) and stick to it as much as possible. If you want to hold the floor, put your item in this doc. Bullet/note form is fine. Even if your topic gets in late, we do our best to cover it.
|
||||
|
||||
Our office hours call is recorded, but the tone tends to be casual. First-timers are always welcome. Typical areas of discussion can include:
|
||||
- Contributors with a feature proposal seeking feedback, assistance, etc
|
||||
- Members planning for what we want to get done for the next release
|
||||
- Strategizing for larger initiatives, such as those that involve more than one sig or potentially more moving pieces
|
||||
- Help wanted requests
|
||||
- Demonstrations of cool stuff. PoCs. Fresh ideas. Show us how you use kops to go beyond the norm- help us define the future!
|
||||
|
||||
Office hours are designed for ALL of those contributing to kops or the community. Contributions are not limited to those who commit source code. There are so many important ways to be involved-
|
||||
- helping in the slack channels
|
||||
- triaging/writing issues
|
||||
- thinking about the topics raised at office hours and forming and advocating for your good ideas forming opinions
|
||||
- testing pre-(and official) releases
|
||||
|
||||
Although not exhaustive, the above activities are extremely important to our continued success and are all worth contributions. If you want to talk about kops and you have doubt, just come.
|
||||
|
||||
|
||||
### Other Ways to Communicate with the Contributors
|
||||
|
||||
Please check in with us in the [#kops-users](https://kubernetes.slack.com/messages/kops-users/) or [#kops-dev](https://kubernetes.slack.com/messages/kops-dev/) channel. Often-times, a well crafted question or potential bug report in slack will catch the attention of the right folks and help quickly get the ship righted.
|
||||
|
||||
## 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](https://github.com/kubernetes/kops/issues/new).
|
||||
- Remember users might be searching for your issue in the future, so please give it a meaningful title to help others.
|
||||
- Feel free to reach out to the kops community on [kubernetes slack](https://github.com/kubernetes/community/blob/master/communication.md#social-media).
|
||||
|
||||
|
||||
### 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](https://github.com/kubernetes/kops/issues/new).
|
||||
- Remember users might be searching for your issue in the future, so please give it a meaningful title to help 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.
|
||||
For more information about the office hours and how to join, see [Office Hours](https://kops.sigs.k8s.io/welcome/office_hours/)
|
||||
|
|
|
|||
|
|
@ -36,9 +36,4 @@ in alpha, and other platforms planned.
|
|||
Manifests
|
||||
* Choose from eight different CNI [Networking](networking.md) providers out-of-the-box
|
||||
* Supports upgrading from [kube-up](upgrade_from_kubeup.md)
|
||||
* Capability to add containers, as hooks, and files to nodes via a [cluster manifest](cluster_spec.md)
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
[To check out Live documentation](https://kops.sigs.k8s.io/)
|
||||
* Capability to add containers, as hooks, and files to nodes via a [cluster manifest](cluster_spec.md)
|
||||
|
|
@ -7,11 +7,11 @@ do our best to support previous releases for a period of time.
|
|||
|
||||
One exception, in regard to compatibility, kops supports the equivalent
|
||||
Kubernetes minor release number. A minor version is the second digit in the
|
||||
release number. kops version 1.13.0 has a minor version of 13. The numbering
|
||||
release number. kops version 1.16.0 has a minor version of 16. The numbering
|
||||
follows the semantic versioning specification, MAJOR.MINOR.PATCH.
|
||||
|
||||
For example, kops 1.12.0 does not support Kubernetes 1.13.0, but kops 1.13.0
|
||||
supports Kubernetes 1.12.2 and previous Kubernetes versions. Only when the kops minor
|
||||
For example, kops 1.16.0 does not support Kubernetes 1.17.0, but kops 1.16.0
|
||||
supports Kubernetes 1.15.2 and previous Kubernetes versions. Only when the kops minor
|
||||
version matches the Kubernetes minor version does kops officially support the
|
||||
Kubernetes release. kops does not stop a user from installing mismatching
|
||||
versions of K8s, but Kubernetes releases always require kops to install specific
|
||||
|
|
@ -21,13 +21,13 @@ Kubernetes version.
|
|||
|
||||
## Compatibility Matrix
|
||||
|
||||
| kops version | k8s 1.11.x | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x |
|
||||
| kops version | k8s 1.12.x | k8s 1.13.x | k8s 1.14.x | k8s 1.15.x | k8s 1.16.x |
|
||||
|---------------|------------|------------|------------|------------|------------|
|
||||
| 1.15.0 | ✔ | ✔ | ✔ | ✔ | ✔ |
|
||||
| 1.14.x | ✔ | ✔ | ✔ | ✔ | ⚫ |
|
||||
| 1.13.x | ✔ | ✔ | ✔ | ⚫ | ⚫ |
|
||||
| ~~1.12.x~~ | ✔ | ✔ | ⚫ | ⚫ | ⚫ |
|
||||
| ~~1.11.x~~ | ✔ | ⚫ | ⚫ | ⚫ | ⚫ |
|
||||
| 1.16.0 | ✔ | ✔ | ✔ | ✔ | ✔ |
|
||||
| 1.15.x | ✔ | ✔ | ✔ | ✔ | ⚫ |
|
||||
| 1.14.x | ✔ | ✔ | ✔ | ⚫ | ⚫ |
|
||||
| ~~1.13.x~~ | ✔ | ✔ | ⚫ | ⚫ | ⚫ |
|
||||
| ~~1.12.x~~ | ✔ | ⚫ | ⚫ | ⚫ | ⚫ |
|
||||
|
||||
|
||||
Use the latest version of kops for all releases of Kubernetes, with the caveat
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ nav:
|
|||
- Authentication: "authentication.md"
|
||||
- Development:
|
||||
- Building: "development/building.md"
|
||||
- Releases: "releases.md"
|
||||
- Releasing: "development/release.md"
|
||||
- New Kubernetes Version: "development/new_kubernetes_version.md"
|
||||
- Developing using Docker: "development/Docker.md"
|
||||
- Development with vSphere: "vsphere-dev.md"
|
||||
|
|
@ -132,11 +132,11 @@ nav:
|
|||
- Notes on master instance sizing: "development/instancesizes.md"
|
||||
- Our release process: "development/release.md"
|
||||
- Releasing with Homebrew: "development/homebrew.md"
|
||||
- Rolling Update Diagrams: "development/rolling_update.md"
|
||||
- Bazel: "development/bazel.md"
|
||||
- Vendoring: "development/vendoring.md"
|
||||
- Ports: "development/ports.md"
|
||||
- Releases:
|
||||
- 1.16: releases/1.16-NOTES.md
|
||||
- 1.15: releases/1.15-NOTES.md
|
||||
- 1.14: releases/1.14-NOTES.md
|
||||
- 1.13: releases/1.13-NOTES.md
|
||||
|
|
|
|||
Loading…
Reference in New Issue