Package org.cdk8s.plus24.k8s

Interface RbdVolumeSource

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RbdVolumeSource.Jsii$Proxy

@Generated(value="jsii-pacmak/1.72.0 (build 4b8828b)",
           date="2022-12-15T15:42:36.789Z")
@Stability(Stable)
public interface RbdVolumeSource
extends software.amazon.jsii.JsiiSerializable

Represents a Rados Block Device mount that lasts the lifetime of a pod.

RBD volumes support ownership management and SELinux relabeling.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	RbdVolumeSource.Builder	A builder for RbdVolumeSource
static class	RbdVolumeSource.Jsii$Proxy	An implementation for RbdVolumeSource

Method Summary

Modifier and Type	Method	Description
static RbdVolumeSource.Builder	builder()
default String	getFsType()	fsType is the filesystem type of the volume that you want to mount.
String	getImage()	image is the rados image name.
default String	getKeyring()	keyring is the path to key ring for RBDUser.
List<String>	getMonitors()	monitors is a collection of Ceph monitors.
default String	getPool()	pool is the rados pool name.
default Boolean	getReadOnly()	readOnly here will force the ReadOnly setting in VolumeMounts.
default LocalObjectReference	getSecretRef()	secretRef is name of the authentication secret for RBDUser.
default String	getUser()	user is the rados user name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getImage

@Stability(Stable)
@NotNull
String getImage()

image is the rados image name.

More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

getMonitors

@Stability(Stable)
@NotNull
List<String> getMonitors()

monitors is a collection of Ceph monitors.

More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

getFsType

@Stability(Stable)
@Nullable
default String getFsType()

fsType is the filesystem type of the volume that you want to mount.

Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd

getKeyring

@Stability(Stable)
@Nullable
default String getKeyring()

keyring is the path to key ring for RBDUser.

Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Default: etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

getPool

@Stability(Stable)
@Nullable
default String getPool()

pool is the rados pool name.

Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Default: rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

getReadOnly

@Stability(Stable)
@Nullable
default Boolean getReadOnly()

readOnly here will force the ReadOnly setting in VolumeMounts.

Defaults to false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Default: false. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

getSecretRef

@Stability(Stable)
@Nullable
default LocalObjectReference getSecretRef()

secretRef is name of the authentication secret for RBDUser.

If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Default: nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

getUser

@Stability(Stable)
@Nullable
default String getUser()

user is the rados user name.

Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

Default: admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

builder

@Stability(Stable)
static RbdVolumeSource.Builder builder()

Returns:

a RbdVolumeSource.Builder of RbdVolumeSource