v1

type AttachType string

type CapacityStats struct {
	// Total bytes in the filesystem
	Total uint64 `json:"total,omitempty"`
	// Free bytes in the filesystem available to root user
	Free uint64 `json:"free,omitempty"`
	// Byte value available to an unprivileged user
	Available uint64 `json:"available,omitempty"`
}

type FSType string

type MasterDeploymentInfo struct {
	// A unique identifier for a volume deployment. The format of this type is
	// undefined and may change but the defined properties will not change.
	ID string `json:"id,omitempty"`
	// A unique identifier for a node. The format of this type is undefined and
	// may change but the defined properties will not change.
	NodeID string `json:"nodeID,omitempty"`
	// Indicates if the volume deployment is eligible for promotion.
	Promotable bool `json:"promotable,omitempty"`
	// Health is the health of the master.
	Health MasterHealth `json:"health,omitempty"`
}

type MasterHealth string

type NFSAcl struct {
	// Identity is the NFS ACL identity.
	Identity NFSAclIdentity `json:"identity,omitempty"`
	// SquashConfig is the NFS ACL squash configuration.
	SquashConfig NFSAclSquashConfig `json:"squashConfig,omitempty"`
	// AccessLevel is the access level this ACL grants - read-only, or
	// read-write.
	AccessLevel string `json:"accessLevel,omitempty"`
}

type NFSAclIdentity struct {
	// The identity type used to identify the nfs client.
	IdentityType string `json:"identityType,omitempty"`
	// NFS identity matcher. For \"cidr\", this should be a valid CIDR block
	// string such as \"10.0.0.0/8\". For \"hostname\", this must be the
	// hostname sent by the client, with ? and * wildcard characters. For
	// netgroup, this must be in the form of \"@netgroup\" with ? and
	// * wildcard characters.
	Matcher string `json:"matcher,omitempty"`
}

type NFSAclSquashConfig struct {
	Uid int64 `json:"uid,omitempty"`
	Gid int64 `json:"gid,omitempty"`
	// SquashConfig defines the root squashing behaviour. When a client creates
	// a file, it sends the user UID from the client. If the client is running
	// as root, this sends uid=0. Root squashing allows the NFS administrator
	// to prevent the client from writing as \"root\" to the NFS share, instead
	// mapping the client to a new UID/GID (usually nfsnobody, -2). \"none\"
	// performs no UID/GID alterations, using the values sent by the client.
	// \"root\" mapps UID & GID 0 to the values specified. \"rootuid\" maps UID
	// 0 and a GID of any value to the value specified. \"all\" maps changes
	// all UID and GID values to those specified.
	Squash string `json:"squash,omitempty"`
}

type NFSConfig struct {
	// Exports is the NFS export configuration.
	Exports []NFSExportConfig `json:"exports,omitempty"`
	// The address to which the NFS server is bound.
	ServiceEndpoint *string `json:"serviceEndpoint,omitempty"`
}

type NFSExportConfig struct {
	// ID for this export
	ExportID uint64 `json:"exportID,omitempty"`
	// The path relative to the volume root to serve as the export root
	Path string `json:"path,omitempty"`
	// The configured pseudo path in the NFS virtual filesystem. This is the
	// path clients will see when traversing to this export on the NFS share.
	PseudoPath string `json:"pseudoPath,omitempty"`
	// Acls is the NFS Access Control List.
	Acls []NFSAcl `json:"acls,omitempty"`
}

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

	Spec   NodeSpec   `json:"spec,omitempty"`
	Status NodeStatus `json:"status,omitempty"`
}

type NodeHealth string

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

type NodeSpec struct {
	// Endpoint at which we operate our dataplane's dfs service. (used for IO
	// operations) This value is set on startup by the corresponding environment
	// variable (IO_ADVERTISE_ADDRESS).
	IoEndpoint string `json:"ioEndpoint,omitempty"`

	// Endpoint at which we operate our dataplane's supervisor service (used for
	// sync). This value is set on startup by the corresponding environment
	// variable (SUPERVISOR_ADVERTISE_ADDRESS).
	SupervisorEndpoint string `json:"supervisorEndpoint,omitempty"`

	// Endpoint at which we operate our health checking service. This value is
	// set on startup by the corresponding environment variable
	// (GOSSIP_ADVERTISE_ADDRESS).
	GossipEndpoint string `json:"gossipEndpoint,omitempty"`

	// Endpoint at which we operate our clustering GRPC API. This value is set
	// on startup by the corresponding environment variable
	// (INTERNAL_API_ADVERTISE_ADDRESS).
	ClusteringEndpoint string `json:"clusteringEndpoint,omitempty"`
}

type NodeStatus struct {
	// Health of the node.
	Health NodeHealth `json:"health,omitempty"`

	// Capacity of the node.
	Capacity CapacityStats `json:"capacity,omitempty"`
}

type PlacementStrategy int

type ReplicaDeploymentInfo struct {
	// A unique identifier for a volume deployment. The format of this type is
	// undefined and may change but the defined properties will not change.
	ID string `json:"id,omitempty"`
	// A unique identifier for a node. The format of this type is undefined and
	// may change but the defined properties will not change.
	NodeID string `json:"nodeID,omitempty"`
	// Indicates if the volume deployment is eligible for promotion.
	Promotable bool `json:"promotable,omitempty"`
	// Health is the health of the replica.
	Health ReplicaHealth `json:"health,omitempty"`
	// SyncProgress is the sync progress of the replica.
	SyncProgress SyncProgress `json:"syncProgress,omitempty"`
}

type ReplicaHealth string

type SyncProgress struct {
	// Number of bytes left remaining to complete the sync.
	BytesRemaining uint64 `json:"bytesRemaining,omitempty"`
	// The average throughput of the sync given as bytes per  second.
	ThroughputBytes uint64 `json:"throughputBytes,omitempty"`
	// The estimated time left for the sync to complete, given in seconds.
	// When this field has a value of 0 either the  sync is complete or no
	// duration estimate could be made. The values reported for bytesRemaining
	// and throughputBytes provide the client with the information needed to
	// choose what to display.
	EstimatedSecondsRemaining uint64 `json:"estimatedSecondsRemaining,omitempty"`
}

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

	Spec   VolumeSpec   `json:"spec,omitempty"`
	Status VolumeStatus `json:"status,omitempty"`
}

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

type VolumeSpec struct {
	// Description is an optional and can describe the volume.
	Description string `json:"description,omitempty"`

	// Replicas is the number of volume replicas.
	Replicas *int32 `json:"replicas,omitempty"`

	// NFS holds configuration for NFS-based shared volumes.
	NFS NFSConfig `json:"nfs,omitempty"`

	// FSType is the requested filesystem type. Once set it can't be changed.
	FSType FSType `json:"fsType,omitempty"`

	// SizeBytes is the volume's size in bytes. The size can be increased via
	// CSI.
	SizeBytes uint64 `json:"sizeBytes,omitempty"`

	// ConfigLabels are the volume configurations stored as labels in the
	// control plane.
	// NOTE: Since the k8s labels and annotations have certain naming rules,
	// this field helps store the key-value configuration data without any
	// naming restrictions. This can also be used to introduce new volume
	// configurations which can later be moved to dedicated fields in the spec.
	ConfigLabels map[string]string `json:"configLabels,omitempty"`

	// Strategy is the volume placement strategy.
	Strategy PlacementStrategy `json:"strategy,omitempty"`
}

type VolumeStatus struct {
	AttachedOn     string                  `json:"attachedOn,omitempty"`
	AttachmentType AttachType              `json:"attachmentType,omitempty"`
	Master         MasterDeploymentInfo    `json:"master,omitempty"`
	Replicas       []ReplicaDeploymentInfo `json:"replicas,omitempty"`
	ConsumerCount  uint64                  `json:"consumerCount,omitempty"`
}