Keystone: Role Controller

PROJECT

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

README.md

@@ -80,7 +80,7 @@ kubectl delete -f $ORC_RELEASE
 | subnet                      |         |    ◐    |     ◐    |
 | volume                      |         |    ◐    |     ◐    |
 | volume type                 |         |    ◐    |     ◐    |
-
+| role                        |         |    ◐    |     ◐    |
 ✔: mostly implemented
 
 ◐: partially implemented

api/v1alpha1/role_types.go

@@ -0,0 +1,83 @@
+/*
+Copyright 2025 The ORC Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+	http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+package v1alpha1
+
+// RoleResourceSpec contains the desired state of the resource.
+type RoleResourceSpec struct {
+	// name will be the name of the created resource. If not specified, the
+	// name of the ORC object will be used.
+	// +optional
+	Name *OpenStackName `json:"name,omitempty"`
+
+	// TODO(dlawton): Waiting on Gophercloud release to include description.
+	// Will update this field when description field is available.
+	// description is a human-readable description for the resource.
+	// +kubebuilder:validation:MinLength:=1
+	// +kubebuilder:validation:MaxLength:=255
+	// +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/identity/v3/roles
+	//
+	// 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"`
+}
+
+// RoleFilter defines an existing resource by its properties
+// +kubebuilder:validation:MinProperties:=1
+type RoleFilter struct {
+	// name of the existing resource
+	// +optional
+	Name *OpenStackName `json:"name,omitempty"`
+
+	// TODO(dlawton): Waiting on Gophercloud release to include description.
+	// Will update this field when description field is available.
+	// description of the existing resource
+	// +kubebuilder:validation:MinLength:=1
+	// +kubebuilder:validation:MaxLength:=255
+	// +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/identity/v3/roles
+}
+
+// RoleResourceStatus represents the observed state of the resource.
+type RoleResourceStatus struct {
+	// name is a Human-readable name for the resource. Might not be unique.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	Name string `json:"name,omitempty"`
+
+	// TODO(dlawton): Waiting on Gophercloud release to include description.
+	// Will update this field when description field is available.
+	// description is a human-readable description for the resource.
+	// +kubebuilder:validation:MaxLength=1024
+	// +optional
+	// Description string `json:"description,omitempty"`
+
+	// TODO(dlawton): Will update when Domain Controller is built
+	// DomainID string `json:"domainID,omitempty"`
+
+	// TODO(scaffolding): Add more types.
+	// To see what is supported, you can take inspiration from the Role structure from
+	// github.com/gophercloud/gophercloud/v2/openstack/identity/v3/roles
+}