feat: Add Non Admin Restore controller

Signed-off-by: Mateus Oliveira <[email protected]>

PROJECT

@@ -17,4 +17,13 @@ resources:
   kind: NonAdminBackup
   path: github.com/migtools/oadp-non-admin/api/v1alpha1
   version: v1alpha1
+- api:
+    crdVersion: v1
+    namespaced: true
+  controller: true
+  domain: oadp.openshift.io
+  group: nac
+  kind: NonAdminRestore
+  path: github.com/migtools/oadp-non-admin/api/v1alpha1
+  version: v1alpha1
 version: "3"

README.md

@@ -232,6 +232,12 @@ kubebuilder create api \
     --version v1alpha1 \
     --kind NonAdminBackup \
     --resource --controller
+kubebuilder create api \
+    --plugins go.kubebuilder.io/v4 \
+    --group nac \
+    --version v1alpha1 \
+    --kind NonAdminRestore \
+    --resource --controller
 make manifests
 ```
 > **NOTE:** The information about plugin and project version, as well as project name, repo and domain, is stored in [PROJECT](PROJECT) file

api/v1alpha1/nonadminrestore_types.go

@@ -0,0 +1,64 @@
+/*
+Copyright 2024.
+
+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
+
+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.
+
+// NonAdminRestoreSpec defines the desired state of NonAdminRestore
+type NonAdminRestoreSpec 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 NonAdminRestore. Edit nonadminrestore_types.go to remove/update
+	Foo string `json:"foo,omitempty"`
+}
+
+// NonAdminRestoreStatus defines the observed state of NonAdminRestore
+type NonAdminRestoreStatus 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
+
+// NonAdminRestore is the Schema for the nonadminrestores API
+type NonAdminRestore struct {
+	metav1.TypeMeta   `json:",inline"`
+	metav1.ObjectMeta `json:"metadata,omitempty"`
+
+	Spec   NonAdminRestoreSpec   `json:"spec,omitempty"`
+	Status NonAdminRestoreStatus `json:"status,omitempty"`
+}
+
+//+kubebuilder:object:root=true
+
+// NonAdminRestoreList contains a list of NonAdminRestore
+type NonAdminRestoreList struct {
+	metav1.TypeMeta `json:",inline"`
+	metav1.ListMeta `json:"metadata,omitempty"`
+	Items           []NonAdminRestore `json:"items"`
+}
+
+func init() {
+	SchemeBuilder.Register(&NonAdminRestore{}, &NonAdminRestoreList{})
+}

cmd/main.go

@@ -26,6 +26,7 @@ import (
 	"k8s.io/apimachinery/pkg/runtime"
 	utilruntime "k8s.io/apimachinery/pkg/util/runtime"
 	clientgoscheme "k8s.io/client-go/kubernetes/scheme"
+
 	// Import all Kubernetes client auth plugins (e.g. Azure, GCP, OIDC, etc.)
 	// to ensure that exec-entrypoint and run can make use of them.
 	_ "k8s.io/client-go/plugin/pkg/client/auth"
@@ -131,6 +132,13 @@ func main() {
 		setupLog.Error(err, "unable to create controller", "controller", "NonAdminBackup")
 		os.Exit(1)
 	}
+	if err = (&controller.NonAdminRestoreReconciler{
+		Client: mgr.GetClient(),
+		Scheme: mgr.GetScheme(),
+	}).SetupWithManager(mgr); err != nil {
+		setupLog.Error(err, "unable to create controller", "controller", "NonAdminRestore")
+		os.Exit(1)
+	}
 	// +kubebuilder:scaffold:builder
 
 	if err := mgr.AddHealthzCheck("healthz", healthz.Ping); err != nil {

config/crd/kustomization.yaml

@@ -3,17 +3,20 @@
 # It should be run by config/default
 resources:
 - bases/nac.oadp.openshift.io_nonadminbackups.yaml
+- bases/nac.oadp.openshift.io_nonadminrestores.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_nonadminbackups.yaml
+#- path: patches/webhook_in_nonadminrestores.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_nonadminbackups.yaml
+#- path: patches/cainjection_in_nonadminrestores.yaml
 #+kubebuilder:scaffold:crdkustomizecainjectionpatch
 
 # [WEBHOOK] To enable webhook, uncomment the following section

config/rbac/nonadminrestore_editor_role.yaml

@@ -0,0 +1,31 @@
+# permissions for end users to edit nonadminrestores.
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: clusterrole
+    app.kubernetes.io/instance: nonadminrestore-editor-role
+    app.kubernetes.io/component: rbac
+    app.kubernetes.io/created-by: oadp-nac
+    app.kubernetes.io/part-of: oadp-nac
+    app.kubernetes.io/managed-by: kustomize
+  name: nonadminrestore-editor-role
+rules:
+- apiGroups:
+  - nac.oadp.openshift.io
+  resources:
+  - nonadminrestores
+  verbs:
+  - create
+  - delete
+  - get
+  - list
+  - patch
+  - update
+  - watch
+- apiGroups:
+  - nac.oadp.openshift.io
+  resources:
+  - nonadminrestores/status
+  verbs:
+  - get

config/rbac/nonadminrestore_viewer_role.yaml

@@ -0,0 +1,27 @@
+# permissions for end users to view nonadminrestores.
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  labels:
+    app.kubernetes.io/name: clusterrole
+    app.kubernetes.io/instance: nonadminrestore-viewer-role
+    app.kubernetes.io/component: rbac
+    app.kubernetes.io/created-by: oadp-nac
+    app.kubernetes.io/part-of: oadp-nac
+    app.kubernetes.io/managed-by: kustomize
+  name: nonadminrestore-viewer-role
+rules:
+- apiGroups:
+  - nac.oadp.openshift.io
+  resources:
+  - nonadminrestores
+  verbs:
+  - get
+  - list
+  - watch
+- apiGroups:
+  - nac.oadp.openshift.io
+  resources:
+  - nonadminrestores/status
+  verbs:
+  - get

config/samples/kustomization.yaml

@@ -1,4 +1,5 @@
 ## Append samples of your project ##
 resources:
 - nac_v1alpha1_nonadminbackup.yaml
+- nac_v1alpha1_nonadminrestore.yaml
 #+kubebuilder:scaffold:manifestskustomizesamples

config/samples/nac_v1alpha1_nonadminrestore.yaml

@@ -0,0 +1,12 @@
+apiVersion: nac.oadp.openshift.io/v1alpha1
+kind: NonAdminRestore
+metadata:
+  labels:
+    app.kubernetes.io/name: nonadminrestore
+    app.kubernetes.io/instance: nonadminrestore-sample
+    app.kubernetes.io/part-of: oadp-nac
+    app.kubernetes.io/managed-by: kustomize
+    app.kubernetes.io/created-by: oadp-nac
+  name: nonadminrestore-sample
+spec:
+  # TODO(user): Add fields here

internal/controller/nonadminrestore_controller.go

@@ -0,0 +1,62 @@
+/*
+Copyright 2024.
+
+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 controller
+
+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"
+
+	nacv1alpha1 "github.com/migtools/oadp-non-admin/api/v1alpha1"
+)
+
+// NonAdminRestoreReconciler reconciles a NonAdminRestore object
+type NonAdminRestoreReconciler struct {
+	client.Client
+	Scheme *runtime.Scheme
+}
+
+//+kubebuilder:rbac:groups=nac.oadp.openshift.io,resources=nonadminrestores,verbs=get;list;watch;create;update;patch;delete
+//+kubebuilder:rbac:groups=nac.oadp.openshift.io,resources=nonadminrestores/status,verbs=get;update;patch
+//+kubebuilder:rbac:groups=nac.oadp.openshift.io,resources=nonadminrestores/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 NonAdminRestore 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/[email protected]/pkg/reconcile
+func (r *NonAdminRestoreReconciler) 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 *NonAdminRestoreReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	return ctrl.NewControllerManagedBy(mgr).
+		For(&nacv1alpha1.NonAdminRestore{}).
+		Complete(r)
+}