build: step2

issue #2

Author: smhmayboudi

.doc/5-tutorial.md

@@ -7,9 +7,9 @@ https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/
 ```shell
 mkdir -p $HOME/Developer/custom-kubernetes-controller
 cd $HOME/Developer/custom-kubernetes-controller
-# we'll use a domain of smhmayboudi.github.io
-# so all API groups will be <group>.smhmayboudi.github.io
-operator-sdk init --domain=smhmayboudi.github.io --repo=github.com/smhmayboudi/custom-kubernetes-controller
+# we'll use a domain of interview.com
+# so all API groups will be <group>.interview.com
+operator-sdk init --domain interview.com --repo github.com/smhmayboudi/custom-kubernetes-controller
 ```
 
 ### MacOS
@@ -19,9 +19,9 @@ https://kubebuilder.io/plugins/available-plugins
 ```shell
 mkdir -p $HOME/Developer/custom-kubernetes-controller
 cd $HOME/Developer/custom-kubernetes-controller
-# we'll use a domain of smhmayboudi.github.io
-# so all API groups will be <group>.smhmayboudi.github.io
-operator-sdk init --domain=smhmayboudi.github.io --repo=github.com/smhmayboudi/custom-kubernetes-controller --plugins=go/v4
+# we'll use a domain of interview.com
+# so all API groups will be <group>.interview.com
+operator-sdk init --domain interview.com --repo github.com/smhmayboudi/custom-kubernetes-controller --plugins go/v4
 ```
 
 ## Manager
@@ -80,6 +80,78 @@ The above example will change the scope of your project to a single Namespace. I
 
 Also, it is possible to use the [DefaultNamespaces](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options) from cache.Options{} to cache objects in a specific set of namespaces. For further information see [cache.Options{}](https://pkg.go.dev/sigs.k8s.io/controller-runtime/pkg/cache#Options)
 
+## Create a new API and Controller
+
+[Deploy Image plugin](https://book.kubebuilder.io/plugins/deploy-image-plugin-v1-alpha.html)
+[Single Group to Multi-Group](https://book.kubebuilder.io/migration/multi-group.html)
+[Understanding Kubernetes APIs](https://book.kubebuilder.io/cronjob-tutorial/gvks.html)
+[Controller Runtime](https://github.com/kubernetes-sigs/controller-runtime)
+
+```shell
+operator-sdk create api --group cache --version v1alpha1 --kind Memcached --resource --controller
+# OR
+operator-sdk create api --group cache --version v1alpha1 --kind Memcached --plugins "deploy-image/v1-alpha" --image=kind-registry:5000/library/memcached:1.6.23-alpine3.19 --image-container-command="memcached,-m=64,-o,modern,-v" --run-as-user="1001"
+```
+
+In general, it’s recommended to have one controller responsible for managing each API created for the project to properly follow the design goals set by [controller-runtime](https://github.com/kubernetes-sigs/controller-runtime).
+
+## Define the API
+
+modify memcached_types
+
+```shell
+make generate
+```
+
+## Generating CRD manifests
+
+```shell
+make manifests
+```
+
+## Docker
+
+```shell
+./.script/kind-with-registry.sh
+```
+
+```shell
+docker tag memcached:1.6.23-alpine3.19 localhost:5001/library/memcached:1.6.23-alpine3.19
+docker push localhost:5001/library/memcached:1.6.23-alpine3.19
+```
+
+```shell
+make docker-build docker-push IMG=localhost:5001/library/controller:latest
+# OR
+make docker-build docker-push
+docker tag controller:latest localhost:5001/library/controller:latest
+docker push localhost:5001/library/controller:latest
+```
+
+## Run the Operator
+
+### Run locally outside the cluster
+
+```shell
+make install run MEMCACHED_IMAGE="memcached:1.6.23-alpine3.19"
+```
+
+```shell
+export
+make deploy IMG=kind-registry:5000/library/controller:latest
+```
+
+```shell
+kubectl -n custom-kubernetes-controller-system get deployment
+kubectl -n custom-kubernetes-controller-system describe deployment/custom-kubernetes-controller-controller-manager
+kubectl -n custom-kubernetes-controller-system describe pod custom-kubernetes-controller-controller-manager
+kubectl -n custom-kubernetes-controller-system logs deployment/custom-kubernetes-controller-controller-manager
+
+kubectl get pods --all-namespaces
+kubectl get deployments --all-namespaces
+kubectl get services --all-namespaces
+```
+
 ```shell
-operator-sdk create api --group=cache --version=v1alpha1 --kind=Memcached --resource --controller
+kubectl delete namespace custom-kubernetes-controller-system
 ```

.doc/README.md

@@ -5,3 +5,48 @@
 3. https://kubernetes.io/docs/concepts/extend-kubernetes/operator/
 4. https://sdk.operatorframework.io/docs/installation/
 5. https://sdk.operatorframework.io/docs/building-operators/golang/tutorial/
+
+# Run & Test & Clean
+
+## Localy
+
+```shell
+make install run
+
+kubectl apply -f config/samples/
+
+make uninstall
+make undeploy
+```
+
+## Docker
+
+```shell
+./.script/kind-with-registry.sh
+
+# Docker Hub
+make docker-build docker-push IMG=smhmayboudi/custom-kubernetes-controller:latest
+make deploy IMG=smhmayboudi/custom-kubernetes-controller:latest
+
+# Local Registry
+make docker-build docker-push IMG=localhost:5001/smhmayboudi/custom-kubernetes-controller:latest
+make deploy IMG=http://kind-registry:5000/smhmayboudi/custom-kubernetes-controller:latest
+
+kubectl apply -f config/samples/
+
+make uninstall
+make undeploy
+```
+
+## OLM
+
+```shell
+operator-sdk olm install
+make bundle IMG=smhmayboudi/custom-kubernetes-controller:v0.0.1
+make bundle-build bundle-push BUNDLE_IMG=smhmayboudi/custom-kubernetes-controller-bundle:v0.0.1
+operator-sdk run bundle smhmayboudi/custom-kubernetes-controller-bundle:v0.0.1
+
+kubectl apply -f config/samples/
+
+operator-sdk cleanup custom-kubernetes-controller
+```