PLEASE NOTE: This document applies to v0.8 version and not to the latest release v0.9Documentation for other releases can be found by using the version selector in the left bottom of any doc page.
Rook can be installed on any existing Kubernetes clusters as long as it meets the minimum version and have the required privilege to run in the cluster (see below for more information). If you dont have a Kubernetes cluster, you can quickly set one up using Minikube, Kubeadm or CoreOS/Vagrant.
Kubernetes v1.7 or higher is supported by Rook.
Privileges and RBAC
Rook requires privileges to manage the storage in your cluster. See the details here for setting up RBAC.
The Rook agent requires setup as a Flex volume plugin to manage the storage attachments in your cluster. See the Flex Volume Configuration topic to configure your Kubernetes deployment to load the Rook volume plugin.
Rook will run wherever Kubernetes is running. Here are some simple environments to help you get started with Rook.
minikube, refer to this page. Once you have
minikube installed, start a cluster by doing the following:
$ minikube start Starting local Kubernetes cluster... Starting VM... SSH-ing files into VM... Setting up certs... Starting cluster components... Connecting to cluster... Setting up kubeconfig... Kubectl is now configured to use the cluster.
After these steps, your minikube cluster is ready to install Rook on.
You can easily spin up Rook on top of a
You can find the instructions on how to install kubeadm in the Install
kubeadm, you can use Rook in just a few minutes!
New local Kubernetes cluster with Vagrant
For a quick start with a new local cluster, use the Rook fork of coreos-kubernetes. This will bring up a multi-node Kubernetes cluster with
vagrant and CoreOS virtual machines ready to use Rook immediately.
git clone https://github.com/rook/coreos-kubernetes.git cd coreos-kubernetes/multi-node/vagrant vagrant up export KUBECONFIG="$(pwd)/kubeconfig" kubectl config use-context vagrant-multi
Then wait for the cluster to come up and verify that kubernetes is done initializing (be patient, it takes a bit):
Once you see a url response, your cluster is ready for use by Rook.
Using Rook in Kubernetes
Now that you have a Kubernetes cluster running, you can start using Rook with these steps.
Using Rook on Tectonic Bare Metal
Follow these instructions to run Rook on Tectonic Kubernetes