github
/
k3s
mirror of https://github.com/k3s-io/k3s
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
k3s/docs/getting-started-guides/dcos.md

187 lines
7.2 KiB
Markdown
Raw Normal View History

Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
run hack/update-generated-docs.sh
2015-12-14 18:37:38 +00:00
<!-- TAG RELEASE_LINK, added by the munger automatically -->
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
<strong>
The latest release of this document can be found
[here](http://releases.k8s.io/release-1.1/docs/getting-started-guides/dcos.md).
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Getting started with Kubernetes on DCOS
----------------------------------------
This guide will walk you through installing [Kubernetes-Mesos](https://github.com/mesosphere/kubernetes-mesos) on [Datacenter Operating System (DCOS)](https://mesosphere.com/product/) with the [DCOS CLI](https://github.com/mesosphere/dcos-cli) and operating Kubernetes with the [DCOS Kubectl plugin](https://github.com/mesosphere/dcos-kubectl).
**Table of Contents**
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
<!-- BEGIN MUNGE: GENERATED_TOC -->
- [About Kubernetes on DCOS](#about-kubernetes-on-dcos)
- [Resources](#resources)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Uninstall](#uninstall)
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
<!-- END MUNGE: GENERATED_TOC -->
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
## About Kubernetes on DCOS
DCOS is system software that manages computer cluster hardware and software resources and provides common services for distributed applications. Among other services, it provides [Apache Mesos](http://mesos.apache.org/) as its cluster kernel and [Marathon](https://mesosphere.github.io/marathon/) as its init system. With DCOS CLI, Mesos frameworks like [Kubernetes-Mesos](https://github.com/mesosphere/kubernetes-mesos) can be installed with a single command.
Another feature of the DCOS CLI is that it allows plugins like the [DCOS Kubectl plugin](https://github.com/mesosphere/dcos-kubectl). This allows for easy access to a version-compatible Kubectl without having to manually download or install.
Further information about the benefits of installing Kubernetes on DCOS can be found in the [Kubernetes-Mesos documentation](../../contrib/mesos/README.md).
For more details about the Kubernetes DCOS packaging, see the [Kubernetes-Mesos project](https://github.com/mesosphere/kubernetes-mesos).
Since Kubernetes-Mesos is still alpha, it is a good idea to familiarize yourself with the [current known issues](../../contrib/mesos/docs/issues.md) which may limit or modify the behavior of Kubernetes on DCOS.
If you have problems completing the steps below, please [file an issue against the kubernetes-mesos project](https://github.com/mesosphere/kubernetes-mesos/issues).
## Resources
Explore the following resources for more information about Kubernetes, Kubernetes on Mesos/DCOS, and DCOS itself.
- [DCOS Documentation](https://docs.mesosphere.com/)
- [Managing DCOS Services](https://docs.mesosphere.com/services/kubernetes/)
- [Kubernetes Examples](../../examples/README.md)
- [Kubernetes on Mesos Documentation](../../contrib/mesos/README.md)
- [Kubernetes on Mesos Release Notes](https://github.com/mesosphere/kubernetes-mesos/releases)
- [Kubernetes on DCOS Package Source](https://github.com/mesosphere/kubernetes-mesos)
## Prerequisites
- A running [DCOS cluster](https://mesosphere.com/product/)
- [DCOS Community Edition](https://docs.mesosphere.com/install/) is currently available on [AWS](https://mesosphere.com/amazon/).
- [DCOS Enterprise Edition](https://mesosphere.com/product/) can be deployed on virtual or bare metal machines. Contact sales@mesosphere.com for more info and to set up an engagement.
- [DCOS CLI](https://docs.mesosphere.com/install/cli/) installed locally
## Install
1. Configure and validate the [Mesosphere Multiverse](https://github.com/mesosphere/multiverse) as a package source repository
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos config prepend package.sources https://github.com/mesosphere/multiverse/archive/version-1.x.zip
$ dcos package update --validate
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
2. Install etcd
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
By default, the Kubernetes DCOS package starts a single-node etcd. In order to avoid state loss in the event of Kubernetes component container failure, install an HA [etcd-mesos](https://github.com/mesosphere/etcd-mesos) cluster on DCOS.
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos package install etcd
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
3. Verify that etcd is installed and healthy
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
The etcd cluster takes a short while to deploy. Verify that `/etcd` is healthy before going on to the next step.
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos marathon app list
ID MEM CPUS TASKS HEALTH DEPLOYMENT CONTAINER CMD
/etcd 128 0.2 1/1 1/1 --- DOCKER None
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
4. Create Kubernetes installation configuration
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
Configure Kubernetes to use the HA etcd installed on DCOS.
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ cat >/tmp/options.json <<EOF
{
"kubernetes": {
"etcd-mesos-framework-name": "etcd"
}
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
}
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
EOF
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
5. Install Kubernetes
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos package install --options=/tmp/options.json kubernetes
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
6. Verify that Kubernetes is installed and healthy
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
The Kubernetes cluster takes a short while to deploy. Verify that `/kubernetes` is healthy before going on to the next step.
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos marathon app list
ID MEM CPUS TASKS HEALTH DEPLOYMENT CONTAINER CMD
/etcd 128 0.2 1/1 1/1 --- DOCKER None
/kubernetes 768 1 1/1 1/1 --- DOCKER None
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
7. Verify that Kube-DNS & Kube-UI are deployed, running, and ready
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos kubectl get pods --namespace=kube-system
NAME READY STATUS RESTARTS AGE
kube-dns-v8-tjxk9 4/4 Running 0 1m
kube-ui-v2-tjq7b 1/1 Running 0 1m
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
Names and ages may vary.
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Now that Kubernetes is installed on DCOS, you may wish to explore the [Kubernetes Examples](../../examples/README.md) or the [Kubernetes User Guide](../user-guide/README.md).
## Uninstall
1. Stop and delete all replication controllers and pods in each namespace:
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
Before uninstalling Kubernetes, destroy all the pods and replication controllers. The uninstall process will try to do this itself, but by default it times out quickly and may leave your cluster in a dirty state.
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos kubectl delete rc,pods --all --namespace=default
$ dcos kubectl delete rc,pods --all --namespace=kube-system
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
2. Validate that all pods have been deleted
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos kubectl get pods --all-namespaces
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
3. Uninstall Kubernetes
Guide style update - Don't indent top-level lists - Use 2 space list item indentation, unless using multi-line items, then use 4 space indents - Use underline for page title - Auto-generate table of contents - Start with lvl 2 headers (lvl 1 headers look too much like the page title)
2015-12-04 00:15:07 +00:00
```
$ dcos package uninstall kubernetes
```
Add DCOS getting started guide
2015-11-13 01:52:12 +00:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/getting-started-guides/dcos.md?pixel)]()
<!-- END MUNGE: GENERATED_ANALYTICS -->