diff --git a/Documentation/README.md b/Documentation/README.md deleted file mode 100644 index ea1aa88ce..000000000 --- a/Documentation/README.md +++ /dev/null @@ -1,18 +0,0 @@ -# Rook Documentation - -## Getting Started - -- [Kubernetes](kubernetes.md) (recommended) - - [Cluster Configuration Details](cluster-tpr.md) - - [Pool Configuration Details](pool-tpr.md) -- [Standalone](standalone.md) - -## Tools and Basic Usage - -- [Rook Client](client.md) -- [Rook Toolbox](toolbox.md) - -## Advanced Usage - -- [Monitoring Rook on Kubernetes](k8s-monitoring.md) -- [Advanced Configuration and Troubleshooting](advanced-configuration.md) diff --git a/Documentation/client.md b/Documentation/client.md index fe15a74fd..77c78de91 100644 --- a/Documentation/client.md +++ b/Documentation/client.md @@ -1,7 +1,11 @@ # Using Rook The `rookctl` client tool can be used to manage your Rook cluster once it is running as well as manage block, file and object storage. See the sections below for details on how to configure each type of storage. -If you don't yet have a Rook cluster running or for instructions to launch the rook-client pod, refer to our [Quickstart Guides](README.md). +If you don't yet have a Rook cluster running, refer to our [Quickstart Guides](README.md). + +`rookctl` can be accessed in the following ways: +- Kubernetes: Start the [toolbox](toolbox.md) pod +- Standalone: [Download the binary](standalone.md#rook-client-tool) to your client machine. ## Block Storage 1. Create a new volume image (10MB) @@ -13,7 +17,7 @@ If you don't yet have a Rook cluster running or for instructions to launch the r 1. Map the block volume and format it and mount it ```bash - # If running in the rook-client container, no need to run privileged + # If running in the toolbox container, no need to run privileged rookctl block map --name test --format --mount /tmp/rook-volume # If running standalone, you may need to run privileged and take ownership of the folder @@ -31,7 +35,7 @@ If you don't yet have a Rook cluster running or for instructions to launch the r 1. Cleanup ```bash - # If running in the rook-client container, no need to run privileged + # If running in the toolbox container, no need to run privileged rookctl block unmap --mount /tmp/rook-volume # If running standalone, you may need to run privileged @@ -54,7 +58,7 @@ If you don't yet have a Rook cluster running or for instructions to launch the r 1. Mount the shared file system from the cluster to your local machine ```bash - # If running in the rook-client container, no need to run privileged + # If running in the toolbox container, no need to run privileged rookctl filesystem mount --name testFS --path /tmp/rookFS # If running standalone, you may need to run privileged and take ownership of the folder @@ -72,7 +76,7 @@ If you don't yet have a Rook cluster running or for instructions to launch the r 1. Unmount the shared file system (this does **not** delete the data from the cluster) ```bash - # If running in the rook-client container, no need to run privileged + # If running in the toolbox container, no need to run privileged rookctl filesystem unmount --path /tmp/rookFS # If running standalone, you may need to run privileged diff --git a/Documentation/k8s-filesystem.md b/Documentation/k8s-filesystem.md index 04d9b6e7b..533605830 100644 --- a/Documentation/k8s-filesystem.md +++ b/Documentation/k8s-filesystem.md @@ -9,7 +9,7 @@ This example runs a shared file system for the [kube-registry](https://github.co This guide assumes you have created a Rook cluster and pool as explained in the main [Kubernetes guide](kubernetes.md) ## Rook Client -Setting up the Rook file system requires running `rookctl` commands with the [Rook client](kubernetes.md#rook-client). This will be simplified in the future with a TPR for the file system. +Setting up the Rook file system requires running `rookctl` commands with the [Rook toolbox](kubernetes.md#tools). This will be simplified in the future with a TPR for the file system. ## Create the File System Create the file system with the default pools. @@ -42,7 +42,7 @@ The kube-registry yaml is defined [here](/demo/kubernetes/kube-registry.yaml). W In the future this step will be improved with a Rook volume plugin. ```bash cd demo/kubernetes -export MONS=$(kubectl -n rook get pod mon0 mon1 mon2 -o json|jq ".items[].status.podIP"|tr -d "\""|sed -e 's/$/:6790/'|paste -s -d, -) +export MONS=$(kubectl -n rook get pod -l app=rook-ceph-mon -o json|jq ".items[].status.podIP"|tr -d "\""|sed -e 's/$/:6790/'|paste -s -d, -) sed "s/INSERT_MONS_HERE/$MONS/g" kube-registry.yaml | kubectl create -f - ``` @@ -50,12 +50,12 @@ You now have a docker registry which is HA with persistent storage. ### Test the storage -Once you have pushed an image to the registry (see the [instructions](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/registry) to expose and use the kube-registry), verify that kube-registry is using the filesystem that was configured above by mounting the shared file system in the rook-client pod. +Once you have pushed an image to the registry (see the [instructions](https://github.com/kubernetes/kubernetes/tree/master/cluster/addons/registry) to expose and use the kube-registry), verify that kube-registry is using the filesystem that was configured above by mounting the shared file system in the toolbox pod. ```bash -# Start and connect to the rook-client pod -kubectl create -f rook-client.yaml -kubectl -n rook exec rook-client -it sh +# Start and connect to the toolbox pod +kubectl create -f rook-tools.yaml +kubectl -n rook exec rook-tools -it sh # Mount the same filesystem that the kube-registry is using mkdir /tmp/registry diff --git a/Documentation/k8s-object.md b/Documentation/k8s-object.md index e952b60b9..b13fd4ee5 100644 --- a/Documentation/k8s-object.md +++ b/Documentation/k8s-object.md @@ -7,11 +7,11 @@ Object storage exposes an S3 API to the storage cluster for applications to put This guide assumes you have created a Rook cluster as explained in the main [Kubernetes guide](kubernetes.md) ## Rook Client -Setting up the object storage requires running `rookctl` commands with the [rook-client](kubernetes.md#rook-client) pod. This will be simplified in the future with a TPR for the object stores. +Setting up the object storage requires running `rookctl` commands with the [Rook toolbox](kubernetes.md#tools) pod. This will be simplified in the future with a TPR for the object stores. ## Create the Object Store and User Now we will create the object store, which starts the RGW service in the cluster with the S3 API. -From within the rook-client container, run the following: +From within the rook-tools container, run the following: ```bash # Create an object storage instance in the cluster diff --git a/Documentation/kubernetes.md b/Documentation/kubernetes.md index 903bf1e00..952cc6ad8 100644 --- a/Documentation/kubernetes.md +++ b/Documentation/kubernetes.md @@ -40,13 +40,13 @@ Use `kubectl` to list pods in the `rook` namespace. You should be able to see th ```bash $ kubectl -n rook get pod -NAME READY STATUS RESTARTS AGE -mon0 1/1 Running 0 1m -mon1 1/1 Running 0 1m -mon2 1/1 Running 0 1m -osd-3n85p 1/1 Running 0 1m -osd-6jmph 1/1 Running 0 1m -rook-api-1709486253-gvdnc 1/1 Running 0 1m +NAME READY STATUS RESTARTS AGE +rook-api-1511082791-7qs0m 1/1 Running 0 5m +rook-ceph-mgr0-1279756402-wc4vt 1/1 Running 0 5m +rook-ceph-mon0-jflt5 1/1 Running 0 6m +rook-ceph-mon1-wkc8p 1/1 Running 0 6m +rook-ceph-mon2-p31dj 1/1 Running 0 6m +rook-ceph-osd-0h6nb 1/1 Running 0 5m ``` ## Storage @@ -57,28 +57,10 @@ For a walkthrough of the three types of storage exposed by Rook, see the guides ## Tools -### Rook Client -The [rookctl](/demo/kubernetes/rook-client.yaml) tool allows you to configure Block, File System, and Object storage. - -You can start a client pod that is automatically configured to connect to your storage cluster with the following: -```bash -kubectl create -f rook-client.yaml - -# Check when the pod is in the Running state -kubectl -n rook get pod rook-client - -# Connect to the client pod -kubectl -n rook exec rook-client -it sh - -# Verify the rookctl tool can talk to the cluster -rookctl node ls -``` - -Now you can use the `rookctl` tool as required in the [File System](k8s-filesystem.md) and [Object](k8s-object.md) walkthroughs, or a [simplified walkthrough of block, file and object storage](client.md). - -### Advanced Configuration and Troubleshooting We have created a [toolbox](/demo/kubernetes/rook-tools.yaml) container that contains the full suite of Ceph clients for debugging and troubleshooting your Rook cluster. Please see the [toolbox readme](toolbox.md) for setup and usage information. Also see our [advanced configuration](advanced-configuration.md) document for helpful maintenance and tuning examples. +The toolbox also contains the `rookctl` tool as required in the [File System](k8s-filesystem.md) and [Object](k8s-object.md) walkthroughs, or a [simplified walkthrough of block, file and object storage](client.md). In the near future, `rookctl` will not be required for kubernetes scenarios. + ### Monitoring Each Rook cluster has some built in metrics collectors/exporters for monitoring with [Prometheus](https://prometheus.io/). To learn how to set up monitoring for your Rook cluster, you can follow the steps in the [monitoring guide](./k8s-monitoring.md). diff --git a/Documentation/standalone.md b/Documentation/standalone.md index 428202a36..628352f9b 100644 --- a/Documentation/standalone.md +++ b/Documentation/standalone.md @@ -9,18 +9,18 @@ Rook can be deployed as a standalone service directly on any modern Linux host by running the following: -1. Download the latest client and server binaries +1. Start a one-node Rook cluster + ```bash + docker run -it quay.io/rook/rookd:latest + ``` + +2. Download the latest `rookctl` binary ```bash wget https://github.com/rook/rook/releases/download/v0.4.0/rook-v0.4.0-linux-amd64.tar.gz tar xvf rook-v0.4.0-linux-amd64.tar.gz ``` -2. Start a one node Rook cluster - ```bash - ./rookd --config-dir /tmp/rook-test - ``` - -3. In another console (but in the same path), verify the Rook cluster is ready +3. Verify the Rook cluster is ready ```bash ./rookctl status ``` diff --git a/demo/kubernetes/rook-client.yaml b/demo/kubernetes/rook-client.yaml deleted file mode 100644 index 56b36e687..000000000 --- a/demo/kubernetes/rook-client.yaml +++ /dev/null @@ -1,30 +0,0 @@ -apiVersion: v1 -kind: Pod -metadata: - name: rook-client - namespace: rook -spec: - containers: - - name: rook-client - image: quay.io/rook/toolbox:master-latest - imagePullPolicy: IfNotPresent - command: ["sleep", "36500d"] - securityContext: - privileged: true - volumeMounts: - - mountPath: /dev - name: dev - - mountPath: /sys - name: sys - - mountPath: /lib/modules - name: libmodules - volumes: - - name: dev - hostPath: - path: /dev - - name: sys - hostPath: - path: /sys - - name: libmodules - hostPath: - path: /lib/modules \ No newline at end of file diff --git a/e2e/framework/manager/rook_test_infra.go b/e2e/framework/manager/rook_test_infra.go index e042f972c..0c8b71445 100644 --- a/e2e/framework/manager/rook_test_infra.go +++ b/e2e/framework/manager/rook_test_infra.go @@ -312,7 +312,7 @@ func createK8sRookOperator(k8sHelper *utils.K8sHelper, tag string) error { func createK8sRookToolbox(k8sHelper *utils.K8sHelper, tag string) (err error) { - //Create rook client + //Create rook toolbox raw, err := ioutil.ReadFile(path.Join(getPodSpecPath(), rookToolsFileName)) if err != nil { diff --git a/e2e/framework/transport/k8s_transport_client.go b/e2e/framework/transport/k8s_transport_client.go index 6f9d3d7e1..cdb02b885 100644 --- a/e2e/framework/transport/k8s_transport_client.go +++ b/e2e/framework/transport/k8s_transport_client.go @@ -40,7 +40,7 @@ func (k *k8sTransportClient) Execute(cmdArgs []string, optional []string) (stdou return "", "invalid number of optional params used", 1 } } else { - initialArgs := []string{"exec", "-n", "rook", "rook-client", "--"} + initialArgs := []string{"exec", "-n", "rook", "rook-tools", "--"} cmdArgs = append(initialArgs, cmdArgs...) }