Skip to content

Conversation

@castrojo
Copy link
Member

@castrojo castrojo commented Dec 12, 2016

As per discussions on sig-cluster-lifecycle, we'd like our docs to be more lifecycle focused instead of one huge installation page. This breaks down the one big page into multiple smaller pages, it is mostly all new content.


This change is Reviewable

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 12, 2016
@pwittrock pwittrock removed their assignment Dec 12, 2016
@pwittrock
Copy link
Member

pwittrock commented Dec 12, 2016

@kubernetes/sig-cluster-lifecycle

@roberthbailey Is this something cluster lifecycle should look at?

path: /home/ubuntu/etcd-snapshots/etcd-snapshot-2016-11-09-02.41.47.tar.gz
sha256: 1dea04627812397c51ee87e313433f3102f617a9cab1d1b79698323f6459953d
size: 68K
status: completed
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

close this code block

The cluster must be in a state of only having a single member. So it's best to
deploy a new cluster using the etcd charm, without adding any additional units.

juju deploy etcd new-etcd
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be in a code block?


> The above code snippet will deploy a single unit of etcd, as 'new-etcd'

juju run-action etcd/0 restore target=/mnt/etcd-backups
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be in a code block?

@@ -0,0 +1,11 @@
# GLossary and Terminology
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GLossary

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://github.com/kubernetes/kubernetes/wiki/CLA-FAQ to sign the CLA.

Once you've signed, please reply here (e.g. "I signed it!") and we'll verify. Thanks.


If you have questions or suggestions related to this bot's behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Dec 15, 2016
@castrojo
Copy link
Member Author

Sorry, bad rebase, sorry for the spam folks, fixed.

@roberthbailey
Copy link

@castrojo - needs rebase

@roberthbailey
Copy link

Also assigning @jaredbhatti for tech writer review.

@roberthbailey roberthbailey removed their assignment Dec 20, 2016
@mikedanese
Copy link
Member

Tech LGTM

@castrojo
Copy link
Member Author

castrojo commented Jan 9, 2017

Fixes #2041

@castrojo
Copy link
Member Author

castrojo commented Jan 9, 2017

Fixes #1952

@jaredbhatti
Copy link
Contributor

Pinged to put content into our new templates:
http://kubernetes.io/docs/contribute/page-templates/

Thanks!

Copy the snapshot to the local disk and then check the sha256sum.

```
juju scp etcd/0:/home/ubuntu/etcd-snapshots/etcd-snapshot-2016-11-09-02.41.47.tar.gz .
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you're using a code block (```), the indentation isn't necessary. On the deploy preview, it's indented farther than the other code blocks.

@devin-donnelly
Copy link
Contributor

devin-donnelly commented Jan 10, 2017

@castrojo Docs LGTM modulo one wording issue in the main landing page. I think we can merge this once that's fixed.

However, we'll do so with the caveat that these kinds of guides to Bare Metal installation/running guides might/should move to a dedicated portion of the site.

---

{% capture overview %}
There are multiple ways to run a Kubernetes with Ubuntu. These pages explain how to deploy Kubernetes on Ubuntu on multiple public and private clouds, as well as bare metal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"run a Kubernetes" -> "run Kubernetes" or "run a Kubernetes cluster"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will be happy to move to a dedicated bare metal section once that's in place.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm putting together a proposal that I hope to get out to sig-docs within a week.

 - This supercedes PR #1770
 - This breaks up the section from one huge installation page into:
   - A new index page.
   - New support grid with commercial and community support options.
   - Move to lifecycle-based pages based on operational tasks.
     - Add support for local deployments via LXD.
       - Added screenshots to images/docs/ubuntu
     - Add backup page.
     - Add decommissioning page.
     - Add a glossary of terms page.
     - Rewritten installation page.
     - Add logging page.
     - Add monitoring page.
     - Add networking page, flannel only for now, calico in progress.
     - Add a scaling page.
     - Add a security page.
     - Add a storage page.
     - Add a troubleshooting page.
     - Add an upgrade page.
     - Add a cluster validation page.
     - Add new ubuntu content to the index page.
       - Add Ubuntu to _data TOC.
     - Add warning about choosing ipv6 with LXD, thanks Ed Baluf.
     - Template-ize all the pages per jaredb's review.
@devin-donnelly
Copy link
Contributor

Thanks! Merging now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants