v1

type ClusterPhase string

type ContainerImages struct {
	NodeContainer                      string `json:"nodeContainer,omitempty"`
	InitContainer                      string `json:"initContainer,omitempty"`
	CSINodeDriverRegistrarContainer    string `json:"csiNodeDriverRegistrarContainer,omitempty"`
	CSIClusterDriverRegistrarContainer string `json:"csiClusterDriverRegistrarContainer,omitempty"`
	CSIExternalProvisionerContainer    string `json:"csiExternalProvisionerContainer,omitempty"`
	CSIExternalAttacherContainer       string `json:"csiExternalAttacherContainer,omitempty"`
	CSIExternalResizerContainer        string `json:"csiExternalResizerContainer,omitempty"`
	CSILivenessProbeContainer          string `json:"csiLivenessProbeContainer,omitempty"`
	HyperkubeContainer                 string `json:"hyperkubeContainer,omitempty"`
	KubeSchedulerContainer             string `json:"kubeSchedulerContainer,omitempty"`
	NFSContainer                       string `json:"nfsContainer,omitempty"`
}

type ExportSpec struct {
	// Name of the export
	Name string `json:"name,omitempty"`

	// The NFS server configuration
	Server ServerSpec `json:"server,omitempty"`

	// PVC from which the NFS daemon gets storage for sharing
	PersistentVolumeClaim corev1.PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty"`
}

type Job struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   JobSpec   `json:"spec,omitempty"`
	Status JobStatus `json:"status,omitempty"`
}

type JobList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Job `json:"items"`
}

type JobSpec struct {

	// Image is the container image to run as the job.
	Image string `json:"image"`

	// Args is an array of strings passed as an argument to the job container.
	Args []string `json:"args"`

	// MountPath is the path in the job container where a volume is mounted.
	MountPath string `json:"mountPath"`

	// HostPath is the path in the host that's mounted into a job container.
	HostPath string `json:"hostPath"`

	// CompletionWord is the word that's looked for in the pod logs to find out
	// if a DaemonSet Pod has completed its task.
	CompletionWord string `json:"completionWord"`

	// LabelSelector is the label selector for the job Pods.
	LabelSelector string `json:"labelSelector,omitempty"`

	// NodeSelectorTerms is the set of placement of the job pods using node
	// affinity requiredDuringSchedulingIgnoredDuringExecution.
	NodeSelectorTerms []corev1.NodeSelectorTerm `json:"nodeSelectorTerms,omitempty"`

	// Tolerations is to set the placement of storageos pods using
	// pod toleration.
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
}

type JobStatus struct {

	// Completed indicates the complete status of job.
	Completed bool `json:"completed,omitempty"`
}

type MembersStatus struct {
	// Ready are the storageos cluster members that are ready to serve requests.
	// The member names are the same as the node IPs.
	Ready []string `json:"ready,omitempty"`
	// Unready are the storageos cluster nodes not ready to serve requests.
	Unready []string `json:"unready,omitempty"`
}

type NFSServer struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   NFSServerSpec   `json:"spec,omitempty"`
	Status NFSServerStatus `json:"status,omitempty"`
}

type NFSServerList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []NFSServer `json:"items"`
}

type NFSServerSpec struct {

	// NFSContainer is the container image to use for the NFS server.
	// +optional
	NFSContainer string `json:"nfsContainer,omitempty"`

	// StorageClassName is the name of the StorageClass used by the NFS volume.
	StorageClassName string `json:"storageClassName,omitempty"`

	// Tolerations is to set the placement of NFS server pods using
	// pod toleration.
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

	// Resources represents the minimum resources required
	// +optional
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// The annotations-related configuration to add/set on each Pod related object.
	Annotations map[string]string `json:"annotations,omitempty"`

	// The parameters to configure the NFS export
	Export ExportSpec `json:"export,omitempty"`

	// Reclamation policy for the persistent volume shared to the user's pod.
	PersistentVolumeReclaimPolicy corev1.PersistentVolumeReclaimPolicy `json:"persistentVolumeReclaimPolicy,omitempty"`

	// PV mount options. Not validated - mount of the PVs will simply fail if
	// one is invalid.
	MountOptions []string `json:"mountOptions,omitempty"`

	// PersistentVolumeClaim is the PVC source of the PVC to be used with the
	// NFS Server. If not specified, a new PVC is provisioned and used.
	PersistentVolumeClaim corev1.PersistentVolumeClaimVolumeSource `json:"persistentVolumeClaim,omitempty"`
}

type NFSServerStatus struct {

	// RemoteTarget is the connection string that clients can use to access the
	// shared filesystem.
	RemoteTarget string `json:"remoteTarget,omitempty"`

	// Phase is a simple, high-level summary of where the NFS Server is in its
	// lifecycle. Phase will be set to Ready when the NFS Server is ready for
	// use.  It is intended to be similar to the PodStatus Phase described at:
	// https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.14/#podstatus-v1-core
	//
	// There are five possible phase values:
	//   - Pending: The NFS Server has been accepted by the Kubernetes system,
	//     but one or more of the components has not been created. This includes
	//     time before being scheduled as well as time spent downloading images
	//     over the network, which could take a while.
	//   - Running: The NFS Server has been bound to a node, and all of the
	//     dependencies have been created.
	//   - Succeeded: All NFS Server dependencies have terminated in success,
	//     and will not be restarted.
	//   - Failed: All NFS Server dependencies in the pod have terminated, and
	//     at least one container has terminated in failure. The container
	//     either exited with non-zero status or was terminated by the system.
	//   - Unknown: For some reason the state of the NFS Server could not be
	//     obtained, typically due to an error in communicating with the host of
	//     the pod.
	//
	Phase string `json:"phase,omitempty"`

	// AccessModes is the access modes supported by the NFS server.
	AccessModes string `json:"accessModes,omitempty"`
}

type NodeHealth struct {
	DirectfsInitiator string `json:"directfsInitiator,omitempty"`
	Director          string `json:"director,omitempty"`
	KV                string `json:"kv,omitempty"`
	KVWrite           string `json:"kvWrite,omitempty"`
	Nats              string `json:"nats,omitempty"`
	Presentation      string `json:"presentation,omitempty"`
	Rdb               string `json:"rdb,omitempty"`
}

type ServerSpec struct {
	// Reading and Writing permissions on the export
	// Valid values are "ReadOnly", "ReadWrite" and "none"
	AccessMode string `json:"accessMode,omitempty"`

	// This prevents the root users connected remotely from having root privileges
	// Valid values are "none", "rootid", "root", and "all"
	Squash string `json:"squash,omitempty"`
}

type StorageOSCluster struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StorageOSClusterSpec   `json:"spec,omitempty"`
	Status StorageOSClusterStatus `json:"status,omitempty"`
}

type StorageOSClusterCSI struct {
	Enable                       bool   `json:"enable,omitempty"`
	Version                      string `json:"version,omitempty"`
	Endpoint                     string `json:"endpoint,omitempty"`
	EnableProvisionCreds         bool   `json:"enableProvisionCreds,omitempty"`
	EnableControllerPublishCreds bool   `json:"enableControllerPublishCreds,omitempty"`
	EnableNodePublishCreds       bool   `json:"enableNodePublishCreds,omitempty"`
	EnableControllerExpandCreds  bool   `json:"enableControllerExpandCreds,omitempty"`
	RegistrarSocketDir           string `json:"registrarSocketDir,omitempty"`
	KubeletDir                   string `json:"kubeletDir,omitempty"`
	PluginDir                    string `json:"pluginDir,omitempty"`
	DeviceDir                    string `json:"deviceDir,omitempty"`
	RegistrationDir              string `json:"registrationDir,omitempty"`
	KubeletRegistrationPath      string `json:"kubeletRegistrationPath,omitempty"`
	DriverRegistrationMode       string `json:"driverRegisterationMode,omitempty"`
	DriverRequiresAttachment     string `json:"driverRequiresAttachment,omitempty"`
	DeploymentStrategy           string `json:"deploymentStrategy,omitempty"`
}

type StorageOSClusterIngress struct {
	Enable      bool              `json:"enable,omitempty"`
	Hostname    string            `json:"hostname,omitempty"`
	TLS         bool              `json:"tls,omitempty"`
	Annotations map[string]string `json:"annotations,omitempty"`
}

type StorageOSClusterKVBackend struct {
	Address string `json:"address,omitempty"`
	Backend string `json:"backend,omitempty"`
}

type StorageOSClusterList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []StorageOSCluster `json:"items"`
}

type StorageOSClusterService struct {
	Name         string            `json:"name"`
	Type         string            `json:"type"`
	ExternalPort int               `json:"externalPort,omitempty"`
	InternalPort int               `json:"internalPort,omitempty"`
	Annotations  map[string]string `json:"annotations,omitempty"`
}

type StorageOSClusterSpec struct {

	// Join is the join token used for service discovery.
	Join string `json:"join,omitempty"`

	// CSI defines the configurations for CSI.
	CSI StorageOSClusterCSI `json:"csi,omitempty"`

	// Namespace is the kubernetes Namespace where storageos resources are
	// provisioned.
	Namespace string `json:"namespace,omitempty"`

	// StorageClassName is the name of default StorageClass created for
	// StorageOS volumes.
	StorageClassName string `json:"storageClassName,omitempty"`

	// Service is the Service configuration for the cluster nodes.
	Service StorageOSClusterService `json:"service,omitempty"`

	// SecretRefName is the name of the secret object that contains all the
	// sensitive cluster configurations.
	SecretRefName string `json:"secretRefName"`

	// SecretRefNamespace is the namespace of the secret reference.
	SecretRefNamespace string `json:"secretRefNamespace"`

	// SharedDir is the shared directory to be used when the kubelet is running
	// in a container.
	// Typically: "/var/lib/kubelet/plugins/kubernetes.io~storageos".
	// If not set, defaults will be used.
	SharedDir string `json:"sharedDir,omitempty"`

	// Ingress defines the ingress configurations used in the cluster.
	Ingress StorageOSClusterIngress `json:"ingress,omitempty"`

	// Images defines the various container images used in the cluster.
	Images ContainerImages `json:"images,omitempty"`

	// KVBackend defines the key-value store backend used in the cluster.
	KVBackend StorageOSClusterKVBackend `json:"kvBackend,omitempty"`

	// Pause is to pause the operator for the cluster.
	Pause bool `json:"pause,omitempty"`

	// Debug is to set debug mode of the cluster.
	Debug bool `json:"debug,omitempty"`

	// NodeSelectorTerms is to set the placement of storageos pods using
	// node affinity requiredDuringSchedulingIgnoredDuringExecution.
	NodeSelectorTerms []corev1.NodeSelectorTerm `json:"nodeSelectorTerms,omitempty"`

	// Tolerations is to set the placement of storageos pods using
	// pod toleration.
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`

	// Resources is to set the resource requirements of the storageos containers.
	Resources corev1.ResourceRequirements `json:"resources,omitempty"`

	// Disable Pod Fencing.  With StatefulSets, Pods are only re-scheduled if
	// the Pod has been marked as killed.  In practice this means that failover
	// of a StatefulSet pod is a manual operation.
	//
	// By enabling Pod Fencing and setting the `storageos.com/fenced=true` label
	// on a Pod, StorageOS will enable automated Pod failover (by killing the
	// application Pod on the failed node) if the following conditions exist:
	//
	// - Pod fencing has not been explicitly disabled.
	// - StorageOS has determined that the node the Pod is running on is
	//   offline.  StorageOS uses Gossip and TCP checks and will retry for 30
	//   seconds.  At this point all volumes on the failed node are marked
	//   offline (irrespective of whether fencing is enabled) and volume
	//   failover starts.
	// - The Pod has the label `storageos.com/fenced=true` set.
	// - The Pod has at least one StorageOS volume attached.
	// - Each StorageOS volume has at least 1 healthy replica.
	//
	// When Pod Fencing is disabled, StorageOS will not perform any interaction
	// with Kubernetes when it detects that a node has gone offline.
	// Additionally, the Kubernetes permissions required for Fencing will not be
	// added to the StorageOS role.
	DisableFencing bool `json:"disableFencing,omitempty"`

	// Disable Telemetry.
	DisableTelemetry bool `json:"disableTelemetry,omitempty"`

	// Disable TCMU can be set to true to disable the TCMU storage driver.  This
	// is required when there are multiple storage systems running on the same
	// node and you wish to avoid conflicts.  Only one TCMU-based storage system
	// can run on a node at a time.
	//
	// Disabling TCMU will degrade performance.
	DisableTCMU bool `json:"disableTCMU,omitempty"`

	// Force TCMU can be set to true to ensure that TCMU is enabled or
	// cause StorageOS to abort startup.
	//
	// At startup, StorageOS will automatically fallback to non-TCMU mode if
	// another TCMU-based storage system is running on the node.  Since non-TCMU
	// will degrade performance, this may not always be desired.
	ForceTCMU bool `json:"forceTCMU,omitempty"`

	// TLSEtcdSecretRefName is the name of the secret object that contains the
	// etcd TLS certs. This secret is shared with etcd, therefore it's not part
	// of the main storageos secret.
	TLSEtcdSecretRefName string `json:"tlsEtcdSecretRefName,omitempty"`

	// TLSEtcdSecretRefNamespace is the namespace of the etcd TLS secret object.
	TLSEtcdSecretRefNamespace string `json:"tlsEtcdSecretRefNamespace,omitempty"`

	// K8sDistro is the name of the Kubernetes distribution where the operator
	// is being deployed.  It should be in the format: `name[-1.0]`, where the
	// version is optional and should only be appended if known.  Suitable names
	// include: `openshift`, `rancher`, `aks`, `gke`, `eks`, or the deployment
	// method if using upstream directly, e.g `minishift` or `kubeadm`.
	//
	// Setting k8sDistro is optional, and will be used to simplify cluster
	// configuration by setting appropriate defaults for the distribution.  The
	// distribution information will also be included in the product telemetry
	// (if enabled), to help focus development efforts.
	K8sDistro string `json:"k8sDistro,omitempty"`

	// Disable StorageOS scheduler extender.
	DisableScheduler bool `json:"disableScheduler,omitempty"`
}

type StorageOSClusterStatus struct {
	Phase            ClusterPhase          `json:"phase,omitempty"`
	NodeHealthStatus map[string]NodeHealth `json:"nodeHealthStatus,omitempty"`
	Nodes            []string              `json:"nodes,omitempty"`
	Ready            string                `json:"ready,omitempty"`
	Members          MembersStatus         `json:"members,omitempty"`
}

type StorageOSUpgrade struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   StorageOSUpgradeSpec   `json:"spec,omitempty"`
	Status StorageOSUpgradeStatus `json:"status,omitempty"`
}

type StorageOSUpgradeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []StorageOSUpgrade `json:"items"`
}

type StorageOSUpgradeSpec struct {

	// NewImage is the new StorageOS node container image.
	NewImage string `json:"newImage"`
}

type StorageOSUpgradeStatus struct {

	// Completed is the status of upgrade process.
	Completed bool `json:"completed,omitempty"`
}