WIP: Waiting on Share Newtwork dependency to be made available as it is a required dependency.

Signed-off-by: Daniel Lawton <dlawton@redhat.com>

Author: dlaw4608

PROJECT

@@ -144,6 +144,14 @@ resources:
   kind: Service
   path: github.com/k-orc/openstack-resource-controller/api/v1alpha1
   version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  domain: k-orc.cloud
+  group: openstack
+  kind: Share
+  path: github.com/k-orc/openstack-resource-controller/api/v1alpha1
+  version: v1alpha1
 - api:
     crdVersion: v1
     namespaced: true

README.md

@@ -86,6 +86,7 @@ kubectl delete -f $ORC_RELEASE
 | server                      |         |    ◐    |     ◐    |
 | server group                |         |    ✔    |     ✔    |
 | service                     |         |    ✔    |     ✔    |
+| share                       |         |    ◐    |     ◐    |
 | subnet                      |         |    ◐    |     ◐    |
 | trunk                       |         |    ✔    |     ✔    |
 | volume                      |         |    ◐    |     ◐    |

api/v1alpha1/share_types.go

@@ -16,6 +16,8 @@ limitations under the License.
 
 package v1alpha1
 
+import metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
 // ShareResourceSpec contains the desired state of the resource.
 type ShareResourceSpec struct {
 	// name will be the name of the created resource. If not specified, the
@@ -29,13 +31,34 @@ type ShareResourceSpec struct {
 	// +optional
 	Description *string `json:"description,omitempty"`
 
-	// TODO(scaffolding): Add more types.
-	// To see what is supported, you can take inspiration from the CreateOpts structure from
-	// github.com/gophercloud/gophercloud/v2/openstack/sharedfilesystems/v2/shares
-	//
-	// Until you have implemented mutability for the field, you must add a CEL validation
-	// preventing the field being modified:
-	// `// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="<fieldname> is immutable"`
+	// size is the size of the share, in gibibytes (GiB).
+	// +kubebuilder:validation:Minimum=1
+	// +required
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="size is immutable"
+	Size int32 `json:"size,omitempty"`
+
+	// shareProto is the file system protocol for the share.
+	// Valid values are NFS, CIFS, GlusterFS, HDFS, CephFS, or MAPRFS.
+	// +kubebuilder:validation:Enum=NFS;CIFS;GlusterFS;HDFS;CephFS;MAPRFS
+	// +required
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="shareProto is immutable"
+	ShareProto string `json:"shareProto,omitempty"`
+
+	// availabilityZone is the availability zone in which to create the share.
+	// +kubebuilder:validation:MaxLength:=255
+	// +optional
+	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="availabilityZone is immutable"
+	AvailabilityZone string `json:"availabilityZone,omitempty"`
+
+	// metadata key and value pairs to be associated with the share.
+	// +kubebuilder:validation:MaxItems:=64
+	// +listType=atomic
+	// +optional
+	Metadata []ShareMetadata `json:"metadata,omitempty"`
+
+	// isPublic defines whether the share is publicly visible.
+	// +optional
+	IsPublic *bool `json:"isPublic,omitempty"`
 }
 
 // ShareFilter defines an existing resource by its properties
@@ -51,9 +74,19 @@ type ShareFilter struct {
 	// +optional
 	Description *string `json:"description,omitempty"`
 
-	// TODO(scaffolding): Add more types.
-	// To see what is supported, you can take inspiration from the ListOpts structure from
-	// github.com/gophercloud/gophercloud/v2/openstack/sharedfilesystems/v2/shares
+	// shareProto is the file system protocol to filter by
+	// +kubebuilder:validation:Enum=NFS;CIFS;GlusterFS;HDFS;CephFS;MAPRFS
+	// +optional
+	ShareProto *string `json:"shareProto,omitempty"`
+
+	// status is the share status to filter by
+	// +kubebuilder:validation:Enum=creating;available;deleting;error;error_deleting;manage_starting;manage_error;unmanage_starting;unmanage_error;extending;extending_error;shrinking;shrinking_error
+	// +optional
+	Status *string `json:"status,omitempty"`
+
+	// isPublic filters by public visibility
+	// +optional
+	IsPublic *bool `json:"isPublic,omitempty"`
 }
 
 // ShareResourceStatus represents the observed state of the resource.
@@ -68,7 +101,82 @@ type ShareResourceStatus struct {
 	// +optional
 	Description string `json:"description,omitempty"`
 
-	// TODO(scaffolding): Add more types.
-	// To see what is supported, you can take inspiration from the Share structure from
-	// github.com/gophercloud/gophercloud/v2/openstack/sharedfilesystems/v2/shares
+	// size is the size of the share in GiB.
+	// +optional
+	Size *int32 `json:"size,omitempty"`
+
+	// shareProto is the file system protocol.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	ShareProto string `json:"shareProto,omitempty"`
+
+	// status represents the current status of the share.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	Status string `json:"status,omitempty"`
+
+	// availabilityZone is which availability zone the share is in.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	AvailabilityZone string `json:"availabilityZone,omitempty"`
+
+	// exportLocations contains paths for accessing the share.
+	// +kubebuilder:validation:MaxItems:=32
+	// +listType=atomic
+	// +optional
+	ExportLocations []ShareExportLocation `json:"exportLocations,omitempty"`
+
+	// metadata key and value pairs associated with the share.
+	// +kubebuilder:validation:MaxItems:=64
+	// +listType=atomic
+	// +optional
+	Metadata []ShareMetadataStatus `json:"metadata,omitempty"`
+
+	// isPublic indicates whether the share is publicly visible.
+	// +optional
+	IsPublic *bool `json:"isPublic,omitempty"`
+
+	// createdAt shows the date and time when the resource was created. The date and time stamp format is ISO 8601.
+	// +optional
+	CreatedAt *metav1.Time `json:"createdAt,omitempty"`
+
+	// projectID is the ID of the project that owns the share.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	ProjectID string `json:"projectID,omitempty"`
+}
+
+type ShareMetadata struct {
+	// name is the name of the metadata
+	// +kubebuilder:validation:MaxLength:=255
+	// +required
+	Name string `json:"name"`
+
+	// value is the value of the metadata
+	// +kubebuilder:validation:MaxLength:=255
+	// +required
+	Value string `json:"value"`
+}
+
+type ShareMetadataStatus struct {
+	// name is the name of the metadata
+	// +kubebuilder:validation:MaxLength:=255
+	// +optional
+	Name string `json:"name,omitempty"`
+
+	// value is the value of the metadata
+	// +kubebuilder:validation:MaxLength:=255
+	// +optional
+	Value string `json:"value,omitempty"`
+}
+
+type ShareExportLocation struct {
+	// path is the export path for accessing the share
+	// +kubebuilder:validation:MaxLength:=1024
+	// +optional
+	Path string `json:"path,omitempty"`
+
+	// preferred indicates if this is the preferred export location
+	// +optional
+	Preferred *bool `json:"preferred,omitempty"`
 }