fix: Change project domain (#96)

Signed-off-by: Mateus Oliveira <[email protected]>
migtools · Nov 14, 2024 · 697ab8f · 697ab8f
1 parent e652b45
commit 697ab8f
Show file tree

Hide file tree

Showing 16 changed files with 47 additions and 32 deletions.
diff --git a/PROJECT b/PROJECT
@@ -2,7 +2,7 @@
 # This file is used to track the info used to scaffold your project
 # and allow the plugins properly work.
 # More info: https://book.kubebuilder.io/reference/project-config.html
-domain: oadp.openshift.io
+domain: openshift.io
 layout:
 - go.kubebuilder.io/v4
 projectName: oadp-nac
@@ -12,8 +12,8 @@ resources:
     crdVersion: v1
     namespaced: true
   controller: true
-  domain: oadp.openshift.io
-  group: nac
+  domain: openshift.io
+  group: oadp
   kind: NonAdminBackup
   path: github.com/migtools/oadp-non-admin/api/v1alpha1
   version: v1alpha1

diff --git a/api/v1alpha1/groupversion_info.go b/api/v1alpha1/groupversion_info.go
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-// Package v1alpha1 contains API Schema definitions for the nac v1alpha1 API group
+// Package v1alpha1 contains API Schema definitions for the oadp v1alpha1 API group
 // +kubebuilder:object:generate=true
-// +groupName=nac.oadp.openshift.io
+// +groupName=oadp.openshift.io
 package v1alpha1
 
 import (
@@ -26,7 +26,7 @@ import (
 
 var (
 	// GroupVersion is group version used to register these objects
-	GroupVersion = schema.GroupVersion{Group: "nac.oadp.openshift.io", Version: "v1alpha1"}
+	GroupVersion = schema.GroupVersion{Group: "oadp.openshift.io", Version: "v1alpha1"}
 
 	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
 	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

diff --git a/cmd/main.go b/cmd/main.go
@@ -114,7 +114,7 @@ func main() {
 		WebhookServer:          webhookServer,
 		HealthProbeBindAddress: probeAddr,
 		LeaderElection:         enableLeaderElection,
-		LeaderElectionID:       "393da43e.oadp.openshift.io",
+		LeaderElectionID:       "393da43e.openshift.io",
 		// LeaderElectionReleaseOnCancel defines if the leader should step down voluntarily
 		// when the Manager ends. This requires the binary to immediately end when the
 		// Manager is stopped, otherwise, this setting is unsafe. Setting this significantly

diff --git a/...ac.oadp.openshift.io_nonadminbackups.yaml → ...es/oadp.openshift.io_nonadminbackups.yaml b/...ac.oadp.openshift.io_nonadminbackups.yaml → ...es/oadp.openshift.io_nonadminbackups.yaml
@@ -4,9 +4,9 @@ kind: CustomResourceDefinition
 metadata:
   annotations:
     controller-gen.kubebuilder.io/version: v0.14.0
-  name: nonadminbackups.nac.oadp.openshift.io
+  name: nonadminbackups.oadp.openshift.io
 spec:
-  group: nac.oadp.openshift.io
+  group: oadp.openshift.io
   names:
     kind: NonAdminBackup
     listKind: NonAdminBackupList

diff --git a/config/crd/kustomization.yaml b/config/crd/kustomization.yaml
@@ -2,7 +2,7 @@
 # since it depends on service name and namespace that are out of this kustomize package.
 # It should be run by config/default
 resources:
-- bases/nac.oadp.openshift.io_nonadminbackups.yaml
+- bases/oadp.openshift.io_nonadminbackups.yaml
 #+kubebuilder:scaffold:crdkustomizeresource
 
 patches:

diff --git a/config/rbac/nonadminbackup_editor_role.yaml b/config/rbac/nonadminbackup_editor_role.yaml
@@ -12,7 +12,7 @@ metadata:
   name: nonadminbackup-editor-role
 rules:
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups
   verbs:
@@ -24,7 +24,7 @@ rules:
   - update
   - watch
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups/status
   verbs:

diff --git a/config/rbac/nonadminbackup_viewer_role.yaml b/config/rbac/nonadminbackup_viewer_role.yaml
@@ -12,15 +12,15 @@ metadata:
   name: nonadminbackup-viewer-role
 rules:
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups
   verbs:
   - get
   - list
   - watch
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups/status
   verbs:

diff --git a/config/rbac/role.yaml b/config/rbac/role.yaml
@@ -5,7 +5,7 @@ metadata:
   name: non-admin-controller-role
 rules:
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups
   verbs:
@@ -17,13 +17,13 @@ rules:
   - update
   - watch
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups/finalizers
   verbs:
   - update
 - apiGroups:
-  - nac.oadp.openshift.io
+  - oadp.openshift.io
   resources:
   - nonadminbackups/status
   verbs:

diff --git a/config/samples/kustomization.yaml b/config/samples/kustomization.yaml
@@ -1,4 +1,4 @@
 ## Append samples of your project ##
 resources:
-- nac_v1alpha1_nonadminbackup.yaml
+- oadp_v1alpha1_nonadminbackup.yaml
 #+kubebuilder:scaffold:manifestskustomizesamples
diff --git a/.../samples/nac_v1alpha1_nonadminbackup.yaml → ...samples/oadp_v1alpha1_nonadminbackup.yaml b/.../samples/nac_v1alpha1_nonadminbackup.yaml → ...samples/oadp_v1alpha1_nonadminbackup.yaml
@@ -1,4 +1,4 @@
-apiVersion: nac.oadp.openshift.io/v1alpha1
+apiVersion: oadp.openshift.io/v1alpha1
 kind: NonAdminBackup
 metadata:
   labels:

diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -137,4 +137,19 @@ If Velero version or its objects needs changes, follow this workflow:
 
 ## Upgrade kubebuilder version
 
-To upgrade kubebuilder version, create kubebuilder structure using the current kubebuilder version and the upgrade version, using the same commands presented in [kubebuilder architecture documentation](architecture.md#kubebuilder), in two different folders. Then generate a `diff` file from the two folders and apply changes to project code.
+To upgrade kubebuilder version, create kubebuilder structure using the current kubebuilder version and the upgrade version (get kubebuilder executables in https://github.com/kubernetes-sigs/kubebuilder/releases), using the same commands presented in [kubebuilder architecture documentation](architecture.md#kubebuilder), in two different folders. Then generate a `diff` file from the two folders and apply changes to project code.
+
+Example
+```sh
+mkdir current
+mkdir new
+cd current
+# Run kubebuilder commands pointing to kubebuilder executable with the current version
+cd ..
+cd new
+# Run kubebuilder commands pointing to kubebuilder executable with the new version
+cd ..
+diff -ruN current new > kubebuilder-upgrade.diff
+patch -p1 --verbose -d ./ -i kubebuilder-upgrade.diff
+# Resolve possible conflicts
+```
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -36,10 +36,10 @@ kubebuilder init \
     --project-version 3 \
     --project-name=oadp-nac \
     --repo=github.com/migtools/oadp-non-admin \
-    --domain=oadp.openshift.io
+    --domain=openshift.io
 kubebuilder create api \
     --plugins go.kubebuilder.io/v4 \
-    --group nac \
+    --group oadp \
     --version v1alpha1 \
     --kind NonAdminBackup \
     --resource --controller

diff --git a/docs/design/Non_Admin_Controller_design.md b/docs/design/Non_Admin_Controller_design.md
@@ -58,7 +58,7 @@ This design intends to enable non-admin users the ability to perform Backup and
     name: nonadminbackup-editor-role
     rules:
     - apiGroups:
-        - nac.oadp.openshift.io
+        - oadp.openshift.io
       resources:
         - nonadminbackups
         - nonadminrestores
@@ -72,7 +72,7 @@ This design intends to enable non-admin users the ability to perform Backup and
         - update
         - watch
     - apiGroups:
-        - nac.oadp.openshift.io
+        - oadp.openshift.io
       resources:
         - nonadminbackups/status
         - nonadminrestores/status
@@ -122,7 +122,7 @@ This design intends to enable non-admin users the ability to perform Backup and
 - **Non-Admin user creates a Non-Admin backup CR:** The user creates a NonAdminBackup custom resource object in the Namespace on which the backup will run within the Kubernetes cluster. The `NonAdminBackup` schema has the `backupSpec`, which is the same as `Backup` CR from the `velero.io/v1` apiVersion.
 
     ```yaml
-    apiVersion: nac.oadp.openshift.io/v1alpha1
+    apiVersion: oadp.openshift.io/v1alpha1
     kind: NonAdminBackup
     metadata:
       name: example

diff --git a/docs/non_admin_user.md b/docs/non_admin_user.md
@@ -39,13 +39,13 @@ Choose one of the authentication method sections to follow.
   oc create namespace <non-admin-user-namespace>
   ```
 - Ensure non admin user have appropriate permissions in its namespace, i.e., non admin user have editor roles for the following objects
-  - `nonadminbackups.nac.oadp.openshift.io`
+  - `nonadminbackups.oadp.openshift.io`
 
   For example
   ```yaml
     # config/rbac/nonadminbackup_editor_role.yaml
     - apiGroups:
-        - nac.oadp.openshift.io
+        - oadp.openshift.io
       resources:
         - nonadminbackups
       verbs:
@@ -57,7 +57,7 @@ Choose one of the authentication method sections to follow.
         - update
         - watch
     - apiGroups:
-        - nac.oadp.openshift.io
+        - oadp.openshift.io
       resources:
         - nonadminbackups/status
       verbs:

diff --git a/hack/samples/backups/file-system.yaml b/hack/samples/backups/file-system.yaml
@@ -3,7 +3,7 @@ kind: Template
 metadata:
   name: fs-nonadminbackup
 objects:
-  - apiVersion: nac.oadp.openshift.io/v1alpha1
+  - apiVersion: oadp.openshift.io/v1alpha1
     kind: NonAdminBackup
     metadata:
       name: nonadminbackup-sample-${SUFFIX}

diff --git a/internal/controller/nonadminbackup_controller.go b/internal/controller/nonadminbackup_controller.go
@@ -64,9 +64,9 @@ const (
 	nameString             = "name"
 )
 
-// +kubebuilder:rbac:groups=nac.oadp.openshift.io,resources=nonadminbackups,verbs=get;list;watch;create;update;patch;delete
-// +kubebuilder:rbac:groups=nac.oadp.openshift.io,resources=nonadminbackups/status,verbs=get;update;patch
-// +kubebuilder:rbac:groups=nac.oadp.openshift.io,resources=nonadminbackups/finalizers,verbs=update
+// +kubebuilder:rbac:groups=oadp.openshift.io,resources=nonadminbackups,verbs=get;list;watch;create;update;patch;delete
+// +kubebuilder:rbac:groups=oadp.openshift.io,resources=nonadminbackups/status,verbs=get;update;patch
+// +kubebuilder:rbac:groups=oadp.openshift.io,resources=nonadminbackups/finalizers,verbs=update
 
 // +kubebuilder:rbac:groups=velero.io,resources=backups,verbs=get;list;watch;create;update;patch;delete
 // +kubebuilder:rbac:groups=velero.io,resources=deletebackuprequests,verbs=get;list;watch;create;update;patch;delete