Skip to main content

Configure permissions for Lumi Enterprise on OpenShift

AI summary
Explains permissions that Imply Lumi Enterprise requires for OpenShift deployments. Covers namespace creation and security context constraints. Details the cluster-admin role needed for installation and service account configurations.

About AI summaries.
info

Imply Lumi Enterprise on OpenShift is an early access feature.

Imply Lumi Enterprise needs permissions on the service accounts where the Lumi pods run, and on the namespace and cluster resources that the Lumi Helm chart manages.

Lumi runs its pods under the following service accounts:

  • cluster-TENANT_ID: Runs the Apache® Druid pods for your Lumi cluster, including data nodes. The Lumi Helm chart creates this service account. Replace TENANT_ID with your Lumi tenant ID.
  • lumi: Runs the update-client service, which installs Lumi and handles future updates.

Before you install Lumi, do the following:

  1. Create the namespace for your Lumi deployment.
  2. Grant security context constraints (SCCs) to the cluster-TENANT_ID service account.
  3. Make sure you can run the installation as a user with the built-in OpenShift cluster-admin role.

In this topic, placeholder values are shown in uppercase—for example, NAMESPACE. Replace these with values for your own environment.

Create the namespace​

Create the namespace for your Lumi deployment. Later topics assume that this namespace already exists.

oc new-project NAMESPACE

Grant SCCs​

Lumi runs some pods with elevated security context constraints (SCCs), which OpenShift doesn't allow by default. Grant these permissions before you install.

The cluster-TENANT_ID service account needs the following SCCs:

Security context constraintGrantsUsed for
system:openshift:scc:privilegedcontainers[0].securityContext.fsGroup: 1001Allows Druid pods to read from and write to their own storage.
system:openshift:scc:privilegedcontainers[0].privileged: trueAllows data nodes to access and manage Non-Volatile Memory Express® (NVMe®) devices.
system:openshift:scc:privilegedhostPath volume for local NVMe storage at /mnt/k8s-disks/0Mounts the local NVMe storage in data node pods for the best segment storage performance.
system:openshift:scc:anyuidRoot userLets task pods access /opt/imply. OpenShift runs containers as a random non-root user ID by default, and /opt/imply isn't reassigned to that ID, so task pods can't read it without root access.

How you grant these SCCs depends on your environment. For example, you can use the following OpenShift CLI (oc) commands:

# Grants the Druid service account the privileged SCC.
oc adm policy add-scc-to-user privileged -z cluster-TENANT_ID -n NAMESPACE

# Grants the Druid service account the anyuid SCC, so task pods can run as root.
oc adm policy add-scc-to-user anyuid -z cluster-TENANT_ID -n NAMESPACE

Installation permissions​

To install Lumi, you need the built-in OpenShift cluster-admin role. The bootstrap Job uses the cluster-admin role to set up everything Lumi requires.

When you run helm install, Lumi installs the cluster and its services into the single namespace you provide. During installation, the Lumi Helm chart creates the following roles for the lumi service account:

RoleScopeGrantsUsed for
lumi-admin RoleNamespaceFull access to all resources within the Lumi namespaceSuperset of the permissions needed by all current and future Lumi components. Runs helm install commands.
lumi-admin ClusterRoleClusterGET on customresourcedefinitions for rollouts.argoproj.ioAllows the update-client to manage Argo Rollouts deployments.
lumi-admin ClusterRoleClusterCREATE, GET, UPDATE, DELETE on validatingwebhookconfigurations for admissionregistration.k8s.ioAllows Lumi to validate deployments through a webhook.

Next step​

After you configure permissions, continue to Provision dependencies.