kubernetes

Documentation

Overview

Package kubernetes contains functions to obtain standard and recommended deployment artifacts for Kubernetes. These artifacts can be used by automation tools that want to deploy Ceph-CSI.

Index

• type CSIProvisionerRBAC
• type CSIProvisionerRBACValues
• type CephFS
• type ClusterInfo
• type NFS
• type RBD
• type ReadAffinity

Types

type CSIProvisionerRBAC

type CSIProvisionerRBAC interface {
	GetServiceAccount() *corev1.ServiceAccount
	GetClusterRole() *rbacv1.ClusterRole
	GetClusterRoleBinding() *rbacv1.ClusterRoleBinding
	GetRole() *rbacv1.Role
	GetRoleBinding() *rbacv1.RoleBinding
}

CSIProvisionerRBAC describes the interface that is provided by different provisioner backends to get details about the required RBAC.

type CSIProvisionerRBACValues

type CSIProvisionerRBACValues struct {
	Namespace      string
	ServiceAccount string
}

CSIProvisionerRBACValues contains values that can be passed to NewCSIProvisionerRBAC() functions for different provisioner backends.

type CephFS

type CephFS struct {
	// symlink filepath for the network namespace where we need to execute commands.
	NetNamespaceFilePath string `json:"netNamespaceFilePath"`
	// SubvolumeGroup contains the name of the SubvolumeGroup for CSI volumes
	SubvolumeGroup string `json:"subvolumeGroup"`
	// KernelMountOptions contains the kernel mount options for CephFS volumes
	KernelMountOptions string `json:"kernelMountOptions"`
	// FuseMountOptions contains the fuse mount options for CephFS volumes
	FuseMountOptions string `json:"fuseMountOptions"`
}

type ClusterInfo

type ClusterInfo struct {
	// ClusterID is used for unique identification
	ClusterID string `json:"clusterID"`
	// Monitors is monitor list for corresponding cluster ID
	Monitors []string `json:"monitors"`
	// CephFS contains CephFS specific options
	CephFS CephFS `json:"cephFS"`
	// RBD Contains RBD specific options
	RBD RBD `json:"rbd"`
	// NFS contains NFS specific options
	NFS NFS `json:"nfs"`
	// Read affinity map options
	ReadAffinity ReadAffinity `json:"readAffinity"`
}

type NFS

type NFS struct {
	// symlink filepath for the network namespace where we need to execute commands.
	NetNamespaceFilePath string `json:"netNamespaceFilePath"`
}

type RBD

type RBD struct {
	// symlink filepath for the network namespace where we need to execute commands.
	NetNamespaceFilePath string `json:"netNamespaceFilePath"`
	// RadosNamespace is a rados namespace in the pool
	RadosNamespace string `json:"radosNamespace"`
	// RBD mirror daemons running in the ceph cluster.
	MirrorDaemonCount int `json:"mirrorDaemonCount"`
}

type ReadAffinity

type ReadAffinity struct {
	Enabled             bool     `json:"enabled"`
	CrushLocationLabels []string `json:"crushLocationLabels"`
}