Umbrella documentation issue

[pieterlange]

There's a bit of documentation already out there, but some of it is hard to find and a lot of it is outdated. The move to the dedicated repo included a bunch of improvements of which nearly all are mostly documented in github issues.

Proposal for documentation checklist:

• Cluster lifecycle documentation
  • relevant: Documentation of long-term managing capabilities #61
• Compiling instructions (in README, Documentation for v0.9.2 #162)
• Feature overview (in README, Documentation for v0.9.2 #162)
• README.md cleanup? (too much info on one page) Documentation for v0.9.2 #162
• List of third party blog posts (with dates/versions)
• Add ROADMAP.md Documentation for v0.9.2 #162
• GOALS in README
  • Done in a way other than initially planned
• Fixes
  • Documentation on external DNS seems out of date Documentation for v0.9.2 #162
• Currently un-documented pre-requisites
  • Internet Gateway needs to be added to VPC before cluster can be created Documentation for v0.9.2 #162
  • KubernetesCluster tag is not applied to existing objects Documentation for v0.9.2 #162
  • What's the smallest instance size I can use? Documentation for v0.9.2 #162
  • Creating new cluster in brand new VPC requires "DNS Hostnames" setting to be turned on Documentation for v0.9.2 #162
  • List of IAM permissions
• Custom configuration
  • Docker container log limit
• FAQ/Gotchas (in Documentation/kubernetes-on-aws-limitations.md, Documentation for v0.9.2 #162)
  • does hostPort not work on kube-aws/CoreOS?

[mumoshu]

Thanks for starting this!

• Regarding the compiling instructions part, I guess we'd better document at least the fact we need to git clone the repo under $GOPATH/src/github.com/coreos like I've explained in Can't build executable kube-aws from the lastest release source code. #87 (comment)
• Should we document about experimental features, too?
• Anyone likes the idea of something like GOALS.md which I've mentioned in Destroy do not clean up everything #59 (comment)?

[aholbreich]

Anyone likes the idea of something like GOALS.md which I've mentioned in #59 (comment)?

yes, me ;)

[mumoshu]

Added "Fixes", "Currently un-documented pre-requisites", "Custom configuration" to the list.

[mumoshu]

@aholbreich FYI, regarding one of your comment:

Allows management of several clusters in convenient way

Probably in a way other than you might have expected but the work is ongoing at #238.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten