OpenShift

OpenShift adds a number of security and other enhancements to Kubernetes. In particular, security context constraints allow the cluster admin to define exactly which permissions are allowed to pods running in the cluster. You will need to define those permissions that allow the Rook pods to run.

The settings for Rook in OpenShift are described below, and are also included in the example yaml files:

  • operator-openshift.yaml: Creates the security context constraints and starts the operator deployment
  • object-openshift.yaml: Creates an object store with rgw listening on a valid port number for OpenShift

TL;DR

To create an OpenShift cluster, the commands basically include:

  1. oc create -f common.yaml
  2. oc create -f operator-openshift.yaml
  3. oc create -f cluster.yaml

Rook Privileges

To orchestrate the storage platform, Rook requires the following access in the cluster:

  • Create hostPath volumes, for persistence by the Ceph mon and osd pods
  • Run pods in privileged mode, for access to /dev and hostPath volumes
  • Host networking for the Rook agent and clusters that require host networking
  • Ceph OSDs require host PIDs for communication on the same node

Security Context Constraints

Before starting the Rook operator or cluster, create the security context constraints needed by the Rook pods. The following yaml is found in operator-openshift.yaml under /cluster/examples/kubernetes/ceph.

NOTE Older versions of OpenShift may require apiVersion: v1.

  1. kind: SecurityContextConstraints
  2. apiVersion: security.openshift.io/v1
  3. metadata:
  4.   name: rook-ceph
  5. allowPrivilegedContainer: true
  6. allowHostNetwork: true
  7. allowHostDirVolumePlugin: true
  8. priority:
  9. allowedCapabilities: []
  10. allowHostPorts: false
  11. allowHostPID: true
  12. allowHostIPC: false
  13. readOnlyRootFilesystem: false
  14. requiredDropCapabilities: []
  15. defaultAddCapabilities: []
  16. runAsUser:
  17.   type: RunAsAny
  18. seLinuxContext:
  19.   type: MustRunAs
  20. fsGroup:
  21.   type: MustRunAs
  22. supplementalGroups:
  23.   type: RunAsAny
  24. allowedFlexVolumes:
  25.   - driver: "ceph.rook.io/rook"
  26.   - driver: "ceph.rook.io/rook-ceph"
  27. volumes:
  28.   - configMap
  29.   - downwardAPI
  30.   - emptyDir
  31.   - flexVolume
  32.   - hostPath
  33.   - persistentVolumeClaim
  34.   - projected
  35.   - secret
  36. users:
  37.   # A user needs to be added for each rook service account.
  38.   # This assumes running in the default sample "rook-ceph" namespace.
  39.   # If other namespaces or service accounts are configured, they need to be updated here.
  40.   - system:serviceaccount:rook-ceph:rook-ceph-system
  41.   - system:serviceaccount:rook-ceph:default
  42.   - system:serviceaccount:rook-ceph:rook-ceph-mgr
  43.   - system:serviceaccount:rook-ceph:rook-ceph-osd

Important to note is that if you plan on running Rook in namespaces other than the default rook-ceph, the example scc will need to be modified to accommodate for your namespaces where the Rook pods are running.

To create the scc you will need a privileged account:

  1. oc login -u system:admin

We will create the security context constraints with the operator in the next section.

Rook Settings

There are some Rook settings that also need to be adjusted to work in OpenShift.

Operator Settings

There is an environment variable that needs to be set in the operator spec that will allow Rook to run in OpenShift clusters.

  • ROOK_HOSTPATH_REQUIRES_PRIVILEGED: Must be set to true. Writing to the hostPath is required for the Ceph mon and osd pods. Given the restricted permissions in OpenShift with SELinux, the pod must be running privileged in order to write to the hostPath volume.
  1. - name: ROOK_HOSTPATH_REQUIRES_PRIVILEGED
  2.   value: "true"

Now create the security context constraints and the operator:

  1. oc create -f operator-openshift.yaml

Cluster Settings

The cluster settings in cluster.yaml are largely isolated from the differences in OpenShift. There is perhaps just one to take note of:

  • dataDirHostPath: Ensure that it points to a valid, writable path on the host systems.

Object Store Settings

In OpenShift, ports less than 1024 cannot be bound. In the object store CRD, ensure the port is modified to meet this requirement.

  1. gateway:
  2.   port: 8080

You can expose a different port such as 80 by creating a service.

A sample object store can be created with these settings:

  1. oc create -f object-openshift.yaml

MiniShift

There is a known issue in MiniShift that does not allow Rook to be tested in some common end-to-end scenarios. Flex drivers are not currently supported, which means that block and file volumes cannot be mounted. See this tracking issue.