provisioner

const (
	//KeyPVNFSServerType defines if the NFS PV should be launched
	// using kernel or ganesha
	KeyPVNFSServerType = "NFSServerType"

	//KeyPVBackendStorageClass defines default provisioner to be used
	// to create the data(export) directory for NFS server
	KeyPVBackendStorageClass = "BackendStorageClass"

	//CustomServerConfig defines the server configuration to use,
	// if it is set. Otherwise, use the default NFS server configuration.
	CustomServerConfig = "CustomServerConfig"

	// LeaseTime defines the renewal period(in seconds) for client state
	// if not set then default value(90s) will be used
	LeaseTime        = "LeaseTime"
	DefaultLeaseTime = 90

	// GraceTime defines the recovery period(in seconds) to reclaim locks
	// If it is not set then default value(90s) will be used
	GraceTime        = "GraceTime"
	DefaultGraceTime = 90

	// FSGroupID defines the permissions of nfs share volume
	// -----------------------------------------------------
	// NOTE: This feature has been deprecated
	//       Alternative: Use FilePermission 'cas.openebs.io/config' annotation
	//                    key on the backend volume PVC. Sample FilePermissions
	//      	      for FSGID-like configuration --
	//
	//                    name: FilePermissions
	//                    data:
	//                      GID: <group-ID>
	//                      mode: "g+s"
	// -----------------------------------------------------
	FSGroupID = "FSGID"

	// This is the cas-template key for all file permission 'data' keys
	FilePermissions = "FilePermissions"

	// FsUID defines the user owner of the shared directory
	FsUID = "UID"

	// FsGID defines the group owner of the shared directory
	FsGID = "GID"

	// FSMode defines the file permission mode of the shared directory
	FsMode = "mode"

	// NFSServerResourceRequests holds key name that represent NFS Resource Requests
	NFSServerResourceRequests = "NFSServerResourceRequests"

	// NFSServerResourceLimits holds key name that represent NFS Resource Limits
	NFSServerResourceLimits = "NFSServerResourceLimits"

	// HookConfigFileName represent file name for hook configuration
	HookConfigFileName = "hook-config"

	// ConfigDirectory defines directory to store config files specific to NFS provisioner
	ConfigDirectory = "/etc/nfs-provisioner"

	// HookConfigFilePath defines path for hook config file
	HookConfigFilePath = ConfigDirectory + "/" + HookConfigFileName
)

const (
	// ProvisionerNFSServerType is the environment variable that
	// allows user to specify the default NFS Server type to be used.
	ProvisionerNFSServerType menv.ENVKey = "OPENEBS_IO_NFS_SERVER_TYPE"

	// ProvisionerExportsSC is the environment variable that provides the
	// default storage class to be used for exports PVC mount used by NFS Server.
	ProvisionerExportsSC menv.ENVKey = "OPENEBS_IO_EXPORTS_SC"

	// ProvisionerNFSServerUseClusterIP is the environment variable that
	// allows user to specify if ClusterIP should be used in NFS K8s Service
	ProvisionerNFSServerUseClusterIP menv.ENVKey = "OPENEBS_IO_NFS_SERVER_USE_CLUSTERIP"

	// NFSServerImageKey is the environment variable that
	// store the container image name to be used for nfs-server deployment
	//
	// Note: If image name is not mentioned then provisioner.ProvisionerNFSServerImage
	//
	NFSServerImageKey menv.ENVKey = "OPENEBS_IO_NFS_SERVER_IMG"

	// NFSServerNamespace defines the namespace for nfs server objects
	// Default value is menv.OpenEBSNamespace(operator namespace)
	NFSServerNamespace menv.ENVKey = "OPENEBS_IO_NFS_SERVER_NS"

	// NodeAffinityKey holds the env name representing Node affinity rules
	NodeAffinityKey menv.ENVKey = "OPENEBS_IO_NFS_SERVER_NODE_AFFINITY"

	// NFSBackendPvcTimeout defines env name to store BackendPvcBoundTimeout value
	NFSBackendPvcTimeout menv.ENVKey = "OPENEBS_IO_NFS_SERVER_BACKEND_PVC_TIMEOUT"

	// The NFSGarbageCollectionEnable environment variable is the switch for the garbage collector.(default true)
	NFSGarbageCollectionEnable menv.ENVKey = "OPENEBS_IO_NFS_SERVER_GARBAGE_COLLECTION_ENABLED"

	// NFSServerImagePullSecret defines the env name to store the name of the image pull secret
	NFSServerImagePullSecret menv.ENVKey = "OPENEBS_IO_NFS_SERVER_IMAGE_PULL_SECRET"
)

const (

	// NFSPVFinalizer represents finalizer string used by NFSPV
	NFSPVFinalizer = "nfs.openebs.io/finalizer"

	//NFSServerPort set the NFS Server Port
	NFSServerPort = 2049

	//RPCBindPort set the RPC Bind Port
	RPCBindPort = 111

	// DefaultBackendPvcBoundTimeout defines the timeout for PVC Bound check.
	// set to 60 seconds
	DefaultBackendPvcBoundTimeout = 60
)

const (
	// Ping message
	Ping string = "ping"
	// DefaultCASType Event application name constant for volume event
	DefaultCASType string = "nfs"
	// Default replica count unknown action
	DefaultUnknownReplicaCount string = "replica:<N/A>"
)