-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
docs: Add quick start for the Docker provider #1484
docs: Add quick start for the Docker provider #1484
Conversation
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.
/approve
this looks great to me, just a couple of questions for my own edification
/assign @detiber
for lgtm
docs/book/src/user/quick-start.md
Outdated
```bash | ||
kind create cluster --name=clusterapi | ||
export KUBECONFIG="$(kind get kubeconfig-path --name="clusterapi")" | ||
``` |
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.
Not a blocker, but it would be nice if we could reference this block form other tabs rather than replicating in multiple places.
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'd prefer this as well, maybe we can have a special KIND configuration section when you have to pick your infrastructure provider?
name: capi-quickstart-worker | ||
spec: | ||
template: | ||
spec: {} |
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.
Yuck, I'm wondering if we should make some of these fields optional rather than required.
docs/book/src/user/quick-start.md
Outdated
```bash | ||
kind create cluster --name=clusterapi | ||
export KUBECONFIG="$(kind get kubeconfig-path --name="clusterapi")" | ||
``` |
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'd prefer this as well, maybe we can have a special KIND configuration section when you have to pick your infrastructure provider?
How many of the outstanding comments are blockers? Can we create issues and fast follow on improvements (e.g. swapping Calico for Weave)? |
@randomvariable I'm good with issues and followups for the comments I raised. |
We should target the |
Thanks everyone for your feedback! I got busy and wasn't able to look at the PR. Will look over comments now and will address minor things, and happy to file issues for major things, or where we don't have consensus right now. |
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.
no-op comment because GH thinks I'm leaving a review (on my own PR?) instead of leaving a comment...
71cfeb9
to
df9e537
Compare
df9e537
to
f1f52c3
Compare
Squashed and rebased on changes from #1318. I removed the redundant "Prerequisites" section the top of the quick start, because the very same section appears at the top of the Installation doc, which is included in the quick start doc. |
f1f52c3
to
0e4db86
Compare
Added the 📖 unicode symbol to the commit subject :-) |
0e4db86
to
168321f
Compare
Removed a line that got left during the rebase. |
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 PR should likely be retargeted for release-0.2
since CAPD has been moved in-tree now.
@detiber Won't a CAPD quick start also make sense in v1a3 (on master)? |
Yes, but without a release yet, I'm not sure what changes would be needed to make it work for master/v1alpha3. |
168321f
to
9afc1ea
Compare
Rebased on |
Argh, I pushed prior to switching the base... Now I need to clean up these extra commits, I guess |
9afc1ea
to
b3407a0
Compare
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: chuckha, dlipovetsky The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Nevermind, I had commits from master in my branch. Removed now. |
@dlipovetsky I was wondering what had happened. Thank you for this PR. I'm using it right now to try and quick start CAPD on my local mac machine. |
/hold Don't merge, again the "install infra provider" section for Docker is missing :( |
Signed-off-by: Daniel Lipovetsky <dlipovetsky@d2iq.com>
b3407a0
to
600405a
Compare
/hold cancel Fixed. |
/lgtm |
/hold cancel (Didn't I cancel it already?) |
What this PR does / why we need it:
Add Docker provider to the book quick start.
/cc @chuckha