-
Notifications
You must be signed in to change notification settings - Fork 53
doc(*): strike all references to deisctl #163
Conversation
Welcome to Deis Powered by CoreOS | ||
|
||
With a dev cluster now running, we are ready to set up a local Docker registry. | ||
TODO: Document some approved "zero to kubernetes" options. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you reference deis/deis#4809 and say instructions coming soon
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something like:
Deis v2 is designed to work on any Kubernetes cluster after version 1.1.2. Kubernetes itself includes tools for creating clusters on a variety of platforms, or you may prefer to use Google Container Engine. Additionally, the Deis team maintains Kube Solo....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@technosophos is that accurate that we maintain kube-solo? I know know @rimusz is pretty involved in it, but it's not an official Deis project, so should we re-word that?
Was there a list somewhere (I'm not finding it now) of all the k8s distributions we've successfully tested against so far?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we're planning on maintaining an official list. Can we not just point people to the k8s documentation? I don't feel like we need to walk people through something that is abundantly documented elsewhere, and I am really hesitant to state that we "officially" support anything.
Let's not mention Kube Solo or MicroKube. You're right.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was referring to the beta requirement: Beta should also exit with a strong opinion about production and staging configurations and how best to go from zero to kubernetes
. Until we make that decision, IMO we should remove this TODO because it's already in that issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So I've been resisting taking on the role of guiding people on k8s. But reading the last few comments, and especially seeing @arschles 's table, I have changed my mind. I really like the idea of adding a table like the above. (Maybe break kube-up into a few lines to stress the big back-ends it supplies.)
Maybe the last column could be "easy, medium, hard" instead of "low, medium, high".
Given this, the list I'd like to see would be:
Kube-up with Vagrant
Kube-up with GCE (maybe)
micro-kube
GKE
Something with AWS (kube-up with aws?).
DigitalOcean if anyone has done it
And then a disclaimer saying that any Kubernetes 1.1+ platform should support Deis.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm good with that. anyone care to extend that table? the options I've listed are the only ones I have non-trivial experience with (kube-up.sh only with vagrant), so I can't comment on where they fit...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@arschles, please, do extend the table with this guide for Digital Ocean using terraform. Level of config is medium, as you need to generate your TLS assets, and run a script for your terraform
env variables.
Name | Cloud? | Local? | Level of Configurability | Ease of setup |
---|---|---|---|---|
Digital Ocean using Terraform | Yes | No | Medium | Easy |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hermanjunge ok, I'm happy to add the row you added however.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also note that I'm rendering all rows in this gist
@krancour made a few comments, and a little concerned about the TODO at https://github.com/deis/workflow/pull/163/files#diff-a2831b297cb4c9d8ab12c22c6d0e3665R26. Are you cool with merging with it still in? |
I would rather not replace with TODO if possible. Both TODOs could be removed in favor of very simple placeholders or links to other docs, which would be better, IMO. |
Ok. The TODOs should be fleshed out a bit more. #180 should precede this and would address that. It's a full rewrite of |
@krancour gave an LGTM. I understand that we probably don't need to resolve https://github.com/deis/workflow/pull/163/files#r48198801 in this PR. However, can you create an issue to do so? |
## Install the Deis Client | ||
|
||
The `deis` client is also written in Go. Your Deis client should match your server's version. Like `deisctl`, we recommend that developers build `deis` from source: | ||
The `deis` client is also written in Go. Your Deis client should match your server's version. We recommend that developers build `deis` from source: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/also//
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice catch. Thanks.
@arschles @technosophos and anyone else who was following this... #180 (a more comprehensive rewrite of dev environment setup docs) squared away what I believe were the only controversial points of this PR. After rebase, all that is left to this PR is removal of any overt references to the defunct |
|
||
deis is a "dev" tool, used to deploy and scale applications to a Deis Platform. deisctl is an "ops" tool, used to configure and manage the Deis Platform itself. | ||
|
||
[dais]: https://en.wikipedia.org/wiki/Dais |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should still keep this link or it'll break the link on line 5
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup. That was an accident. I'll fix.
@bacongobbler your feedback has all been acted upon. |
@@ -72,4 +65,4 @@ If you already have an account, use `deis login` to authenticate against the Dei | |||
Deis session information is stored in your user's ~/.deis directory. | |||
|
|||
|
|||
[controller]: ../understanding-deis/components.md#controller |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this link was accidentally removed. We have a link for it here
@krancour good to go |
doc(*): strike all references to deisctl
Partially addresses #161
Note that this is deliberately replacing certain bits that were removed with
TODOs
. And anywhere where a reference todeisctl
was removed from a list or larger chunk of text, I am making no claim to the accuracy of those sections with respect to v2.The documentation requires a comprehensive overhaul, but to keep PRs reasonable in scope, I'm limiting this to simple removal of references to a component that no longer exists. A series of PRs such as this will incrementally address #161.