diff --git a/PROJECT b/PROJECT index ae1ee81..e452980 100644 --- a/PROJECT +++ b/PROJECT @@ -23,4 +23,13 @@ resources: group: labellers kind: NodeLabeller version: v1 +- api: + crdVersion: v1 + namespaced: true + controller: true + domain: edge-net.io + group: multitenancy + kind: SubNamespace + path: github.com/edgenet-project/edgenet/api/multitenancy/v1 + version: v1 version: "3" diff --git a/api/multitenancy/v1/subnamespace_types.go b/api/multitenancy/v1/subnamespace_types.go new file mode 100644 index 0000000..9699400 --- /dev/null +++ b/api/multitenancy/v1/subnamespace_types.go @@ -0,0 +1,64 @@ +/* +Copyright 2024 Contributors to EdgeNet Project. + +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 v1 + +import ( + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" +) + +// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN! +// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized. + +// SubNamespaceSpec defines the desired state of SubNamespace +type SubNamespaceSpec struct { + // INSERT ADDITIONAL SPEC FIELDS - desired state of cluster + // Important: Run "make" to regenerate code after modifying this file + + // Foo is an example field of SubNamespace. Edit subnamespace_types.go to remove/update + Foo string `json:"foo,omitempty"` +} + +// SubNamespaceStatus defines the observed state of SubNamespace +type SubNamespaceStatus struct { + // INSERT ADDITIONAL STATUS FIELD - define observed state of cluster + // Important: Run "make" to regenerate code after modifying this file +} + +//+kubebuilder:object:root=true +//+kubebuilder:subresource:status + +// SubNamespace is the Schema for the subnamespaces API +type SubNamespace struct { + metav1.TypeMeta `json:",inline"` + metav1.ObjectMeta `json:"metadata,omitempty"` + + Spec SubNamespaceSpec `json:"spec,omitempty"` + Status SubNamespaceStatus `json:"status,omitempty"` +} + +//+kubebuilder:object:root=true + +// SubNamespaceList contains a list of SubNamespace +type SubNamespaceList struct { + metav1.TypeMeta `json:",inline"` + metav1.ListMeta `json:"metadata,omitempty"` + Items []SubNamespace `json:"items"` +} + +func init() { + SchemeBuilder.Register(&SubNamespace{}, &SubNamespaceList{}) +} diff --git a/api/multitenancy/v1/zz_generated.deepcopy.go b/api/multitenancy/v1/zz_generated.deepcopy.go index 0b73eba..08a6c57 100644 --- a/api/multitenancy/v1/zz_generated.deepcopy.go +++ b/api/multitenancy/v1/zz_generated.deepcopy.go @@ -26,6 +26,95 @@ import ( runtime "k8s.io/apimachinery/pkg/runtime" ) +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SubNamespace) DeepCopyInto(out *SubNamespace) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ObjectMeta.DeepCopyInto(&out.ObjectMeta) + out.Spec = in.Spec + out.Status = in.Status +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubNamespace. +func (in *SubNamespace) DeepCopy() *SubNamespace { + if in == nil { + return nil + } + out := new(SubNamespace) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *SubNamespace) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SubNamespaceList) DeepCopyInto(out *SubNamespaceList) { + *out = *in + out.TypeMeta = in.TypeMeta + in.ListMeta.DeepCopyInto(&out.ListMeta) + if in.Items != nil { + in, out := &in.Items, &out.Items + *out = make([]SubNamespace, len(*in)) + for i := range *in { + (*in)[i].DeepCopyInto(&(*out)[i]) + } + } +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubNamespaceList. +func (in *SubNamespaceList) DeepCopy() *SubNamespaceList { + if in == nil { + return nil + } + out := new(SubNamespaceList) + in.DeepCopyInto(out) + return out +} + +// DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object. +func (in *SubNamespaceList) DeepCopyObject() runtime.Object { + if c := in.DeepCopy(); c != nil { + return c + } + return nil +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SubNamespaceSpec) DeepCopyInto(out *SubNamespaceSpec) { + *out = *in +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubNamespaceSpec. +func (in *SubNamespaceSpec) DeepCopy() *SubNamespaceSpec { + if in == nil { + return nil + } + out := new(SubNamespaceSpec) + in.DeepCopyInto(out) + return out +} + +// DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. +func (in *SubNamespaceStatus) DeepCopyInto(out *SubNamespaceStatus) { + *out = *in +} + +// DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubNamespaceStatus. +func (in *SubNamespaceStatus) DeepCopy() *SubNamespaceStatus { + if in == nil { + return nil + } + out := new(SubNamespaceStatus) + in.DeepCopyInto(out) + return out +} + // DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil. func (in *Tenant) DeepCopyInto(out *Tenant) { *out = *in diff --git a/cmd/main.go b/cmd/main.go index d6e8f31..4a3e8c6 100644 --- a/cmd/main.go +++ b/cmd/main.go @@ -176,6 +176,13 @@ func main() { os.Exit(1) } } + if err = (&multitenancycontroller.SubNamespaceReconciler{ + Client: mgr.GetClient(), + Scheme: mgr.GetScheme(), + }).SetupWithManager(mgr); err != nil { + setupLog.Error(err, "unable to create controller", "controller", "SubNamespace") + os.Exit(1) + } //+kubebuilder:scaffold:builder if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil { diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml index 224d353..f3b1478 100644 --- a/config/crd/kustomization.yaml +++ b/config/crd/kustomization.yaml @@ -6,17 +6,20 @@ resources: # - edgenet_system_namespace.yaml - secrets/maxmind_secret.yaml - bases/multitenancy.edge-net.io_tenants.yaml +- bases/multitenancy.edge-net.io_subnamespaces.yaml #+kubebuilder:scaffold:crdkustomizeresource patches: # [WEBHOOK] To enable webhook, uncomment all the sections with [WEBHOOK] prefix. # patches here are for enabling the conversion webhook for each CRD #- path: patches/webhook_in_multitenancy_tenants.yaml +#- path: patches/webhook_in_multitenancy_subnamespaces.yaml #+kubebuilder:scaffold:crdkustomizewebhookpatch # [CERTMANAGER] To enable cert-manager, uncomment all the sections with [CERTMANAGER] prefix. # patches here are for enabling the CA injection for each CRD #- path: patches/cainjection_in_multitenancy_tenants.yaml +#- path: patches/cainjection_in_multitenancy_subnamespaces.yaml #+kubebuilder:scaffold:crdkustomizecainjectionpatch # [WEBHOOK] To enable webhook, uncomment the following section diff --git a/config/rbac/multitenancy_subnamespace_editor_role.yaml b/config/rbac/multitenancy_subnamespace_editor_role.yaml new file mode 100644 index 0000000..f060d49 --- /dev/null +++ b/config/rbac/multitenancy_subnamespace_editor_role.yaml @@ -0,0 +1,31 @@ +# permissions for end users to edit subnamespaces. +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + labels: + app.kubernetes.io/name: clusterrole + app.kubernetes.io/instance: subnamespace-editor-role + app.kubernetes.io/component: rbac + app.kubernetes.io/created-by: edgenet + app.kubernetes.io/part-of: edgenet + app.kubernetes.io/managed-by: kustomize + name: subnamespace-editor-role +rules: +- apiGroups: + - multitenancy.edge-net.io + resources: + - subnamespaces + verbs: + - create + - delete + - get + - list + - patch + - update + - watch +- apiGroups: + - multitenancy.edge-net.io + resources: + - subnamespaces/status + verbs: + - get diff --git a/config/rbac/multitenancy_subnamespace_viewer_role.yaml b/config/rbac/multitenancy_subnamespace_viewer_role.yaml new file mode 100644 index 0000000..4d25893 --- /dev/null +++ b/config/rbac/multitenancy_subnamespace_viewer_role.yaml @@ -0,0 +1,27 @@ +# permissions for end users to view subnamespaces. +apiVersion: rbac.authorization.k8s.io/v1 +kind: ClusterRole +metadata: + labels: + app.kubernetes.io/name: clusterrole + app.kubernetes.io/instance: subnamespace-viewer-role + app.kubernetes.io/component: rbac + app.kubernetes.io/created-by: edgenet + app.kubernetes.io/part-of: edgenet + app.kubernetes.io/managed-by: kustomize + name: subnamespace-viewer-role +rules: +- apiGroups: + - multitenancy.edge-net.io + resources: + - subnamespaces + verbs: + - get + - list + - watch +- apiGroups: + - multitenancy.edge-net.io + resources: + - subnamespaces/status + verbs: + - get diff --git a/config/samples/kustomization.yaml b/config/samples/kustomization.yaml index ab07ebf..480d308 100644 --- a/config/samples/kustomization.yaml +++ b/config/samples/kustomization.yaml @@ -1,4 +1,5 @@ ## Append samples of your project ## resources: - multitenancy_v1_tenant.yaml +- multitenancy_v1_subnamespace.yaml #+kubebuilder:scaffold:manifestskustomizesamples diff --git a/config/samples/multitenancy_v1_subnamespace.yaml b/config/samples/multitenancy_v1_subnamespace.yaml new file mode 100644 index 0000000..708b7c3 --- /dev/null +++ b/config/samples/multitenancy_v1_subnamespace.yaml @@ -0,0 +1,12 @@ +apiVersion: multitenancy.edge-net.io/v1 +kind: SubNamespace +metadata: + labels: + app.kubernetes.io/name: subnamespace + app.kubernetes.io/instance: subnamespace-sample + app.kubernetes.io/part-of: edgenet + app.kubernetes.io/managed-by: kustomize + app.kubernetes.io/created-by: edgenet + name: subnamespace-sample +spec: + # TODO(user): Add fields here diff --git a/internal/controller/multitenancy/subnamespace_controller.go b/internal/controller/multitenancy/subnamespace_controller.go new file mode 100644 index 0000000..eca6531 --- /dev/null +++ b/internal/controller/multitenancy/subnamespace_controller.go @@ -0,0 +1,62 @@ +/* +Copyright 2024 Contributors to EdgeNet Project. + +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 multitenancy + +import ( + "context" + + "k8s.io/apimachinery/pkg/runtime" + ctrl "sigs.k8s.io/controller-runtime" + "sigs.k8s.io/controller-runtime/pkg/client" + "sigs.k8s.io/controller-runtime/pkg/log" + + multitenancyv1 "github.com/edgenet-project/edgenet/api/multitenancy/v1" +) + +// SubNamespaceReconciler reconciles a SubNamespace object +type SubNamespaceReconciler struct { + client.Client + Scheme *runtime.Scheme +} + +//+kubebuilder:rbac:groups=multitenancy.edge-net.io,resources=subnamespaces,verbs=get;list;watch;create;update;patch;delete +//+kubebuilder:rbac:groups=multitenancy.edge-net.io,resources=subnamespaces/status,verbs=get;update;patch +//+kubebuilder:rbac:groups=multitenancy.edge-net.io,resources=subnamespaces/finalizers,verbs=update + +// Reconcile is part of the main kubernetes reconciliation loop which aims to +// move the current state of the cluster closer to the desired state. +// TODO(user): Modify the Reconcile function to compare the state specified by +// the SubNamespace object against the actual cluster state, and then +// perform operations to make the cluster state reflect the state specified by +// the user. +// +// For more details, check Reconcile and its Result here: +// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.17.0/pkg/reconcile +func (r *SubNamespaceReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) { + _ = log.FromContext(ctx) + + // TODO(user): your logic here + + return ctrl.Result{}, nil +} + +// SetupWithManager sets up the controller with the Manager. +func (r *SubNamespaceReconciler) SetupWithManager(mgr ctrl.Manager) error { + return ctrl.NewControllerManagedBy(mgr). + For(&multitenancyv1.SubNamespace{}). + Complete(r) +} diff --git a/internal/controller/multitenancy/subnamespace_controller_test.go b/internal/controller/multitenancy/subnamespace_controller_test.go new file mode 100644 index 0000000..2318210 --- /dev/null +++ b/internal/controller/multitenancy/subnamespace_controller_test.go @@ -0,0 +1,84 @@ +/* +Copyright 2024 Contributors to EdgeNet Project. + +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 multitenancy + +import ( + "context" + + . "github.com/onsi/ginkgo/v2" + . "github.com/onsi/gomega" + "k8s.io/apimachinery/pkg/api/errors" + "k8s.io/apimachinery/pkg/types" + "sigs.k8s.io/controller-runtime/pkg/reconcile" + + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" + + multitenancyv1 "github.com/edgenet-project/edgenet/api/multitenancy/v1" +) + +var _ = Describe("SubNamespace Controller", func() { + Context("When reconciling a resource", func() { + const resourceName = "test-resource" + + ctx := context.Background() + + typeNamespacedName := types.NamespacedName{ + Name: resourceName, + Namespace: "default", // TODO(user):Modify as needed + } + subnamespace := &multitenancyv1.SubNamespace{} + + BeforeEach(func() { + By("creating the custom resource for the Kind SubNamespace") + err := k8sClient.Get(ctx, typeNamespacedName, subnamespace) + if err != nil && errors.IsNotFound(err) { + resource := &multitenancyv1.SubNamespace{ + ObjectMeta: metav1.ObjectMeta{ + Name: resourceName, + Namespace: "default", + }, + // TODO(user): Specify other spec details if needed. + } + Expect(k8sClient.Create(ctx, resource)).To(Succeed()) + } + }) + + AfterEach(func() { + // TODO(user): Cleanup logic after each test, like removing the resource instance. + resource := &multitenancyv1.SubNamespace{} + err := k8sClient.Get(ctx, typeNamespacedName, resource) + Expect(err).NotTo(HaveOccurred()) + + By("Cleanup the specific resource instance SubNamespace") + Expect(k8sClient.Delete(ctx, resource)).To(Succeed()) + }) + It("should successfully reconcile the resource", func() { + By("Reconciling the created resource") + controllerReconciler := &SubNamespaceReconciler{ + Client: k8sClient, + Scheme: k8sClient.Scheme(), + } + + _, err := controllerReconciler.Reconcile(ctx, reconcile.Request{ + NamespacedName: typeNamespacedName, + }) + Expect(err).NotTo(HaveOccurred()) + // TODO(user): Add more specific assertions depending on your controller's reconciliation logic. + // Example: If you expect a certain status condition after reconciliation, verify it here. + }) + }) +})