Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation (Readme) to include version matrix #3813

Closed
Nitecon opened this issue Nov 9, 2017 · 6 comments
Closed

Improve documentation (Readme) to include version matrix #3813

Nitecon opened this issue Nov 9, 2017 · 6 comments

Comments

@Nitecon
Copy link

Nitecon commented Nov 9, 2017

  1. What kops version are you running? use kops version
    Version 1.6.0 (git-f69a313ce)

  2. What Kubernetes version are you running? use kubectl version
    GitVersion:"v1.7.8

  3. What cloud provider are you using?
    AWS

  4. What commands did you execute (Please provide cluster manifest kops get --name my.example.com, if available) and what happened after commands executed?
    kops version

  5. What you expected to happen:
    Documentation (readme) should show a matrix of tested / vetted / limit versions of associated kubernetes versions. If we are to assume 1.6.0 can only properly maintain / install / upgrade 1.6.x versions then it should show it as such. There is currently no documentation showing appropriate kops versions with the associated kubernetes versions. Ideally kops version should report the version of kops including the kubernetes supported min and max versions, even if it's just 1 version.

  6. How can we to reproduce it (as minimally and precisely as possible):
    Ask a regular user with kops version 1.4 what version on kubernetes is appropriate, what is the minimum version it can upgrade and what is the maximum version it can upgrade to?

  7. Anything else do we need to know:
    Although docker versions are more tightly coupled with kubernetes having at least a mention of this would greatly increase stability at least from our testing with some services that use docker cmds inside kubernetes in our lower environments. This ask however is an absolute nice to have as it's up to the upstream service to provide that information in a more clear way.

@chrislovecnm
Copy link
Contributor

chrislovecnm commented Nov 9, 2017

We need a weird matrix. We need a note that kops 1.8.x works with k8s 1.8.x and below. We should have compatibility 1.4.x -> 1.8.x k8s. kops releases are different than k8s releases. The version has to match if you are using the latest k8s release. For instance kops 1.7.x does not support k8s 1.8.x, but does support k8s 1.6.x.

@blakebarnett
Copy link

I think we should create a kops channels command that displays this info (and perhaps any other inventory/assets info that pertains to each)

@Nitecon
Copy link
Author

Nitecon commented Nov 9, 2017

@chrislovecnm i 100% agree it's very confusing when I'm trying to onboard new folks into kubernetes with kops. Being behind the k8s project in version numbers and supported versions is not a big deal it's just really confusing when the readme shows brew update && brew install kops, so now as a new user you have kops but as a new user you don't know what to look for... You don't know what version of kops you have nor do you know how that relates to k8s version. You generally only figure this out after you've upgraded your cluster a few times.

Lastly the assumption that I see from most folks is when they get kops installed they assume it's going to be the latest stable version of kubernetes which will almost never be the case, so that adds additional confusion.

@chrislovecnm
Copy link
Contributor

Lastly the assumption that I see from most folks is when they get kops installed they assume it's going to be the latest stable version of kubernetes which will almost never be the case, so that adds additional confusion.

Well, that is debatable. The channels file is probably not updated enough, but stable is burned in the version of k8s in production. Usually, @justinsb and I recommend versions that running in production. Also never run the latest :)

@chrislovecnm
Copy link
Contributor

chrislovecnm commented Nov 10, 2017

k8s-github-robot pushed a commit that referenced this issue Nov 16, 2017
Automatic merge from submit-queue.

README and issue template updates

Addresses #3813

- add information about new features
- removing maintainers section
- adding GCE documentation to README
- reformating the issues template
@chrislovecnm
Copy link
Contributor

Closing done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants