Merge pull request #16 from alphagov/BAU-remove-samples-directory

BAU - Remove `samples` directory

Author: nimalank7

.gitignore

@@ -6,3 +6,4 @@
 /dist
 /bin
 /crds
+/samples

PROJECT

@@ -3,23 +3,23 @@
 # and allow the plugins properly work.
 # More info: https://book.kubebuilder.io/reference/project-config.html
 cliVersion: 4.14.0
-domain: gov.uk
+domain: publishing.service.gov.uk
 layout:
 - go.kubebuilder.io/v4
 plugins:
   helm.kubebuilder.io/v2-alpha:
     manifests: dist/install.yaml
     output: dist
 projectName: govuk-job-request-operator
-repo: platform/JobRequest
+repo: publishing.service.gov.uk/govuk-job-request-operator
 resources:
 - api:
     crdVersion: v1
     namespaced: true
   controller: true
-  domain: gov.uk
+  domain: publishing.service.gov.uk
   group: platform
   kind: JobRequest
-  path: platform/JobRequest/api/v1
+  path: publishing.service.gov.uk/govuk-job-request-operator/api/v1
   version: v1
 version: "3"

README.md

@@ -15,7 +15,7 @@ brew install k3d
 ### Custom Resource Definition (CRD)
 
 ```
-apiVersion: platform.gov.uk/v1
+apiVersion: platform.service.publishing.gov.uk/v1
 kind: JobRequest
 metadata:
   labels:
@@ -56,21 +56,6 @@ This will run the controller locally and not in the cluster.
 make run
 ```
 
-2. Create a custom resource
-
-Edit `platform_v1_jobrequest.yaml` to the following:
-
-```
-spec:
-    foo: bar
-```
-
-3. Apply the resource
-
-```
-kubectl apply -k config/samples
-```
-
 ### Run the controller in the cluster
 
 1. Build the controller in a docker image
@@ -93,6 +78,28 @@ imagePullPolicy: IfNotPresent
 k3d image import controller:latest -c cluster
 ```
 
+4. Deploy the controller to the cluster
+
+```
+make deploy
+```
+
+### Create an instance of the CRD
+
+```
+cat <<EOF | kubectl apply -f -
+apiVersion: platform.publishing.service.gov.uk/v1
+kind: JobRequest
+metadata:
+  labels:
+    app.kubernetes.io/name: govuk-job-request-operator
+    app.kubernetes.io/managed-by: kustomize
+  name: jobrequest-sample
+spec:
+  foo: bar
+EOF
+```
+
 ### Generate Helm chart
 
 1. Generate a Helm chart

cmd/main.go

@@ -35,8 +35,8 @@ import (
 	metricsserver "sigs.k8s.io/controller-runtime/pkg/metrics/server"
 	"sigs.k8s.io/controller-runtime/pkg/webhook"
 
-	platformv1 "platform/JobRequest/api/v1"
-	"platform/JobRequest/internal/controller"
+	platformv1 "publishing.service.gov.uk/govuk-job-request-operator/api/v1"
+	"publishing.service.gov.uk/govuk-job-request-operator/internal/controller"
 	// +kubebuilder:scaffold:imports
 )
 
@@ -160,7 +160,7 @@ func main() {
 		WebhookServer:          webhookServer,
 		HealthProbeBindAddress: probeAddr,
 		LeaderElection:         enableLeaderElection,
-		LeaderElectionID:       "768c8ed3.gov.uk",
+		LeaderElectionID:       "768c8ed3.publishing.service.gov.uk",
 		// 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

config/crd/bases/platform.gov.uk_jobrequests.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/platform.gov.uk_jobrequests.yaml
+- bases/platform.publishing.service.gov.uk_jobrequests.yaml
 # +kubebuilder:scaffold:crdkustomizeresource
 
 patches:

config/crd/kustomization.yaml

@@ -14,13 +14,13 @@ metadata:
   name: jobrequest-admin-role
 rules:
 - apiGroups:
-  - platform.gov.uk
+  - platform.publishing.service.gov.uk
   resources:
   - jobrequests
   verbs:
   - '*'
 - apiGroups:
-  - platform.gov.uk
+  - platform.publishing.service.gov.uk
   resources:
   - jobrequests/status
   verbs:

config/rbac/jobrequest_admin_role.yaml

@@ -14,7 +14,7 @@ metadata:
   name: jobrequest-editor-role
 rules:
 - apiGroups:
-  - platform.gov.uk
+  - platform.publishing.service.gov.uk
   resources:
   - jobrequests
   verbs:
@@ -26,7 +26,7 @@ rules:
   - update
   - watch
 - apiGroups:
-  - platform.gov.uk
+  - platform.publishing.service.gov.uk
   resources:
   - jobrequests/status
   verbs:

config/rbac/jobrequest_editor_role.yaml

@@ -14,15 +14,15 @@ metadata:
   name: jobrequest-viewer-role
 rules:
 - apiGroups:
-  - platform.gov.uk
+  - platform.publishing.service.gov.uk
   resources:
   - jobrequests
   verbs:
   - get
   - list
   - watch
 - apiGroups:
-  - platform.gov.uk
+  - platform.publishing.service.gov.uk
   resources:
   - jobrequests/status
   verbs: