k3s/docs/getting-started-guides/rkt
Mike Danese fe6b15ba2f rewrite all links to issues to k8s links 2015-08-05 21:11:11 -07:00
..
README.md rewrite all links to issues to k8s links 2015-08-05 21:11:11 -07:00

README.md

WARNING WARNING WARNING WARNING WARNING

PLEASE NOTE: This document applies to the HEAD of the source tree

If you are using a released version of Kubernetes, you should refer to the docs that go with that version.

The latest 1.0.x release of this document can be found [here](http://releases.k8s.io/release-1.0/docs/getting-started-guides/rkt/README.md).

Documentation for other releases can be found at releases.k8s.io.

Run Kubernetes with rkt

This document describes how to run Kubernetes using rkt as a container runtime. We still have a bunch of work to do to make the experience with rkt wonderful, please stay tuned!

Prerequisite

  • systemd should be installed on your machine and should be enabled. The minimum version required at this moment (2015/05/28) is 215. (Note that systemd is not required by rkt itself, we are using it here to monitor and manage the pods launched by kubelet.)

  • Install the latest rkt release according to the instructions here. The minimum version required for now is v0.5.6.

  • Make sure the rkt metadata service is running because it is necessary for running pod in private network mode. More details about the networking of rkt can be found in the documentation.

    To start the rkt metadata service, you can simply run:

    $ sudo rkt metadata-service
    

    If you want the service to be running as a systemd service, then:

    $ sudo systemd-run rkt metadata-service
    

    Alternatively, you can use the rkt-metadata.service and rkt-metadata.socket to start the service.

Local cluster

To use rkt as the container runtime, you just need to set the environment variable CONTAINER_RUNTIME:

$ export CONTAINER_RUNTIME=rkt
$ hack/local-up-cluster.sh

CoreOS cluster on Google Compute Engine (GCE)

To use rkt as the container runtime for your CoreOS cluster on GCE, you need to specify the OS distribution, project, image:

$ export KUBE_OS_DISTRIBUTION=coreos
$ export KUBE_GCE_MINION_IMAGE=<image_id>
$ export KUBE_GCE_MINION_PROJECT=coreos-cloud
$ export KUBE_CONTAINER_RUNTIME=rkt

You can optionally choose the version of rkt used by setting KUBE_RKT_VERSION:

$ export KUBE_RKT_VERSION=0.5.6

Then you can launch the cluster by:

$ kube-up.sh

Note that we are still working on making all containerized the master components run smoothly in rkt. Before that we are not able to run the master node with rkt yet.

CoreOS cluster on AWS

To use rkt as the container runtime for your CoreOS cluster on AWS, you need to specify the provider and OS distribution:

$ export KUBERNETES_PROVIDER=aws
$ export KUBE_OS_DISTRIBUTION=coreos
$ export KUBE_CONTAINER_RUNTIME=rkt

You can optionally choose the version of rkt used by setting KUBE_RKT_VERSION:

$ export KUBE_RKT_VERSION=0.5.6

You can optionally choose the CoreOS channel by setting COREOS_CHANNEL:

$ export COREOS_CHANNEL=stable

Then you can launch the cluster by:

$ kube-up.sh

Note: CoreOS is not supported as the master using the automated launch scripts. The master node is always Ubuntu.

Getting started with your cluster

See a simple nginx example to try out your new cluster.

For more complete applications, please look in the examples directory.

Analytics