Skip to content

Commit

Permalink
updates from PR review
Browse files Browse the repository at this point in the history
  • Loading branch information
chrislovecnm committed Nov 10, 2017
1 parent 8835ba2 commit 8aca438
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 15 deletions.
22 changes: 15 additions & 7 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,29 @@ you can.

------------- BUG REPORT TEMPLATE --------------------

1. What kops version are you running? Use `kops version`?
1. What `kops` version are you running? The command `kops version`, will display
this information.

1. What Kubernetes version are you running? Use `kubectl version`?
1. What Kubernetes version are you running? `kubectl version` will print the
version if a cluster is running or provide the Kubernetes version specified as
a `kops` flag.

1. What cloud provider are you using?

1. What commands did you execute, and what happened after the commands executed?
1. What commands did you run?

1. Can you provide cluster manifest `kops get --name my.example.com -oyaml`?
1. What happened after the commands executed?

1. What you expected to happen?
1. Please provide your cluster manifest. Execute
`kops get --name my.example.com -oyaml` to display your cluster manifest.
You may want to remove your cluster name and other sensitive information.

1. How can we to reproduce it (as minimally and precisely as possible)?
1. What did you expect to happen?

1. Can you run the `kops` command with the `-v 10` flag and provide logs?
1. What is the simplest way to reproduce this issue?

1. Please run the commands with most verbose logging by adding the `-v 10` flag.
Paste the logs into this report, or in a gist and provide the gist link here.

1. Anything else do we need to know?

Expand Down
44 changes: 36 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ in alpha, and other platforms planned.
To replicate the above demo, check out our [tutorial](/docs/aws.md) for
launching a Kubernetes cluster hosted on AWS.

To install a Kuberentes cluster on GCE please follow this [guide](/docs/tutorial/gce.md).
To install a Kubernetes cluster on GCE please follow this [guide](/docs/tutorial/gce.md).


## Features
Expand All @@ -59,17 +59,45 @@ Documentation is in the `/docs` directory, [and the index is here.](docs/README.

## Kubernetes Release Compatibility

`kops` is intended to be backward compatible. It is always recommended to use the
latest version of kop with whatever version of Kuberentes you are using. This
project does not follow the Kubernetes release schedule but typically releases
after Kubernetes does. `kops` supports the matching Kubernetes minor release.
For instance kops, 1.8.x does not support Kubernetes 1.9.x, but kops 1.9.x
supports Kubernetes 1.9.x. Moreover, kops 1.8.x attempts to be backward compatible
and support Kubernetes 1.4.x.

### 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. One
exception, kops supports the equivalent Kubernetes minor release number. A
minor version is the second digit in the release number. kops version 1.8.0
has a minor version of 8. The numbering follows the semantic versioning
specification, MAJOR.MINOR.PATCH.

For example kops, 1.8.0 does not support Kubernetes 1.9.2, but kops 1.9.0
supports Kubernetes 1.9.2 and previous Kubernetes versions. Only when 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
Kuberenetes version.

Use the latest version of kops for all releases of Kuberentes, with the caveat
that higher versions of Kuberentes are not _officially_ supported by kops.


### 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](http://kubernetes.io/docs/user-guide/prereqs/).


Expand Down

0 comments on commit 8aca438

Please sign in to comment.