volume

Documentation

Index

• Constants
• type ListScope
• type SecretFormat
• type SecretScope
• type SecretVolumeContext
  • func NewvolumeContextFromMap(parameters map[string]string) (*SecretVolumeContext, error)
  • func (v SecretVolumeContext) ToMap() map[string]string

Constants

const (
	// kubernetes and sig defained annotations for PVC
	CSIStoragePVCName                       string = "csi.storage.k8s.io/pvc/name"
	CSIStoragePVCNamespace                  string = "csi.storage.k8s.io/pvc/namespace"
	CSIStoragePodName                       string = "csi.storage.k8s.io/pod.name"
	CSIStoragePodNamespace                  string = "csi.storage.k8s.io/pod.namespace"
	CSIStoragePodUid                        string = "csi.storage.k8s.io/pod.uid"
	CSIStorageServiceAccountName            string = "csi.storage.k8s.io/serviceAccount.name"
	CSIStorageEphemeral                     string = "csi.storage.k8s.io/ephemeral"
	StorageKubernetesCSIProvisionerIdentity string = "storage.kubernetes.io/csiProvisionerIdentity"
	VolumeKubernetesStorageProvisioner      string = "volume.kubernetes.io/storage-provisioner"
	// nolint:lll
	// https://kubernetes.io/docs/reference/labels-annotations-taints/#volume-beta-kubernetes-io-storage-provisioner-deprecated
	DeprecatedVolumeKubernetesStorageProvisioner string = "volume.beta.kubernetes.io/storage-provisioner"
)

const (
	ScopePod            ListScope = "pod"
	ScopeNode           ListScope = "node"
	ScopeService        string    = "service"
	ScopeListenerVolume string    = "listener-volume"
)

const (
	KerberosServiceNamesSplitter string = ","
)

Types

type ListScope

type ListScope string

type SecretFormat

type SecretFormat string

const (
	SecretFormatTLSPEM   SecretFormat = "tls-pem"
	SecretFormatTLSP12   SecretFormat = "tls-p12"
	SecretFormatKerberos SecretFormat = "kerberos"
)

type SecretScope

type SecretScope struct {
	Pod  ListScope `json:"pod"`
	Node ListScope `json:"node"`
	// this field is k-v pair, key is service name, value is service type
	Services []string `json:"service"`
	// this field is k-v pair, key is listener volume name, value is listener volume type
	ListenerVolumes []string `json:"listener-volume"`
}

type SecretVolumeContext

type SecretVolumeContext struct {
	// Default values for volume context
	Pod                    string `json:"csi.storage.k8s.io/pod.name"`
	PodNamespace           string `json:"csi.storage.k8s.io/pod.namespace"`
	PodUID                 string `json:"csi.storage.k8s.io/pod.uid"`
	ServiceAccountName     string `json:"csi.storage.k8s.io/serviceAccount.name"`
	Ephemeral              string `json:"csi.storage.k8s.io/ephemeral"`
	CSIProvisionerIdentity string `json:"storage.kubernetes.io/csiProvisionerIdentity"`
	Provisioner            string `json:"volume.kubernetes.io/storage-provisioner"`

	Class  string       `json:"secrets.kubedoop.dev/class"`
	Scope  SecretScope  `json:"secrets.kubedoop.dev/scope"`
	Format SecretFormat `json:"secrets.kubedoop.dev/format"`

	TlsPKCS12Password        string        `json:"secrets.kubedoop.dev/tlsPKCS12Password"`
	AutoTlsCertLifetime      time.Duration `json:"secrets.kubedoop.dev/autoTlsCertLifetime"`
	AutoTlsCertJitterFactor  float64       `json:"secrets.kubedoop.dev/autoTlsCertJitterFactor"`
	AutoTlsCertRestartBuffer time.Duration `json:"secrets.kubedoop.dev/autoTlsCertRestartBuffer"`

	KerberosServiceNames []string `json:"secrets.kubedoop.dev/kerberosServiceNames"`
}

func NewvolumeContextFromMap

func NewvolumeContextFromMap(parameters map[string]string) (*SecretVolumeContext, error)

func (SecretVolumeContext) ToMap

func (v SecretVolumeContext) ToMap() map[string]string