Merge pull request #2 from alphagov/add-codeowners-and-README

Add `CODEOWNERS` and README

Author: nimalank7

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# Platform Engineering review required
+* @alphagov/gov-uk-platform-engineering

README.md

@@ -1,14 +1,104 @@
 # GOV.UK Job Request Operator
 
-This is a k8s operator that is used to make job requests built with [operator-sdk](https://sdk.operatorframework.io/).
+This is a k8s operator that is used to make job requests built with [kube-builder](https://github.com/kubernetes-sigs/kubebuilder).
 
 ## Usage
 
-To install the required dependencies::
+To install the required dependencies:
 
 ```shell
-brew install operator-sdk
+brew install kubebuilder
 brew install helm
+brew install k3d
+```
+
+### Custom Resource Definition (CRD)
+
+```
+apiVersion: platform.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
+```
+
+### Create and generate the manifests
+
+1. Create the manifests
+
+```
+make manifests
+```
+
+2. Start a k3d cluster
+
+```
+k3d cluster create cluster --api-port 6550
+```
+
+3. Install the CRDs into the cluster
+
+```
+make install
+```
+
+### Run the controller locally
+
+1. Run the controller locally
+
+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
+
+```
+make docker-build
+```
+
+2. Modify the `manager` manifest
+
+Edit the `manager` Deployment in `config/manager/manager.yaml` to include the following:
+
+```
+imagePullPolicy: IfNotPresent
+```
+
+3. Load the image into the cluster
+
+```
+k3d image import controller:latest -c cluster
+```
+
+### Generate Helm chart
+
+1. Generate a Helm chart
+
+```
+kubebuilder edit --plugins=helm/v2-alpha
 ```
 
 ## Team