kubectl directpv install

The kubectl directpv install command deploys DirectPV components to your Kubernetes cluster. DirectPV installs as a CSI driver that manages local drives for persistent storage.

For installation prerequisites and post-installation steps, see Installation.

kubectl directpv install

┌──────────────────────────┬──────────────────────────────────────────┬─────────┐
│ KIND                     │ NAME                                     │ STATUS  │
├──────────────────────────┼──────────────────────────────────────────┼─────────┤
│ Namespace                │ directpv                                 │ Created │
│ CustomResourceDefinition │ directpvdrives.directpv.min.io           │ Created │
│ CustomResourceDefinition │ directpvvolumes.directpv.min.io          │ Created │
│ CustomResourceDefinition │ directpvnodes.directpv.min.io            │ Created │
│ CustomResourceDefinition │ directpvinitrequests.directpv.min.io     │ Created │
│ StorageClass             │ directpv-min-io                          │ Created │
│ ServiceAccount           │ directpv-min-io                          │ Created │
│ ClusterRole              │ directpv-min-io                          │ Created │
│ ClusterRoleBinding       │ directpv-min-io                          │ Created │
│ Role                     │ directpv-min-io                          │ Created │
│ RoleBinding              │ directpv-min-io                          │ Created │
│ DaemonSet                │ node-server                              │ Created │
│ Deployment               │ controller                               │ Created │
│ CSIDriver                │ directpv-min-io                          │ Created │
└──────────────────────────┴──────────────────────────────────────────┴─────────┘

DirectPV installed successfully

kubectl directpv install [--apparmor-profile "string"]  \
                         [--dry-run]                    \
                         [--image "string"]             \
                         [--image-pull-secrets "string"]\
                         [--installed-version "string"] \
                         [--legacy]                     \
                         [--node-selector "string"]     \
                         [--openshift]                  \
                         [--org "string"]               \
                         [--registry "string"]          \
                         [--seccomp-profile "string"]   \
                         [--tolerations "string"]

Optional

The name of the AppArmor profile to apply to DirectPV pods. The profile must be loaded on all nodes where DirectPV runs.

For the AppArmor profile, see AppArmor profile.

Optional

Preview the installation without making changes. Displays what resources would be created or updated.

Optional

The DirectPV container image name and tag.

Default: directpv:<version>

Optional

Image pull secrets for accessing private registries. Specify multiple secrets as a comma-separated list.

Optional

Specify the currently installed DirectPV version. Use this flag during upgrades to ensure proper migration handling.

Optional

Enable legacy mode to support volumes created by DirectCSI (the predecessor to DirectPV). When enabled, DirectPV installs additional components (legacy-node-server, legacy-controller) that can manage DirectCSI volumes alongside DirectPV volumes.

Optional

Deploy DirectPV DaemonSet pods only on nodes matching the specified labels. Use the format KEY=VALUE. Specify multiple selectors as a comma-separated list.

Optional

Use OpenShift-specific installation configuration. Set this flag when installing on Red Hat OpenShift clusters.

Optional

The organization name in the container registry.

Default: minio

Optional

The container registry to pull DirectPV images from.

Default: quay.io

Optional

The path to the seccomp profile JSON file. The profile must exist on all nodes where DirectPV runs.

For the seccomp profile, see Seccomp profile.

Optional

Set tolerations for DirectPV DaemonSet pods to allow scheduling on tainted nodes. Use the format KEY[=VALUE]:EFFECT, where EFFECT is one of NoSchedule, PreferNoSchedule, or NoExecute. Specify multiple tolerations as a comma-separated list.

This command supports the following global flags:

Install DirectPV using default configuration:

kubectl directpv install

Pull DirectPV images from a private registry:

kubectl directpv install --registry private-registry.io --org my-org

Deploy DirectPV only on nodes with a specific label:

kubectl directpv install --node-selector storage-node=true

Install DirectPV on tainted nodes:

kubectl directpv install --tolerations dedicated=storage:NoSchedule

View what resources would be created without making changes:

kubectl directpv install --dry-run

Install DirectPV with an AppArmor security profile:

kubectl directpv install --apparmor-profile directpv

Install DirectPV with a seccomp security profile:

kubectl directpv install --seccomp-profile profiles/seccomp.json

Install DirectPV on a Red Hat OpenShift cluster:

kubectl directpv install --openshift

The install command creates the following Kubernetes resources:

The command displays a table showing each resource and its status:

• Created: The resource was newly created.
• Updated: An existing resource was modified.

To upgrade an existing DirectPV installation, see Upgrade DirectPV.

DirectPV supports both AppArmor and seccomp security profiles for enhanced container security:

• AppArmor: Restricts the capabilities of DirectPV pods at the kernel level. Load the profile on each node before installation.
• Seccomp: Filters system calls available to DirectPV containers. Place the profile JSON file on each node.

For security profile files, see Support Scripts.