update steps to run controllers

basic-k8s/go/readme.md

@@ -6,17 +6,20 @@ Make sure you are inside `basic-k8s/go` directory.
 
 ### Do it yourself
 
-Apply the crd present in `deploy` folder.
+Apply the crd.
 ```bash
 kubectl apply -f ../deploy/crd.yaml
 ```
 
-Apply the controller for `Ping`. I am deploying it in `metacontroller` namespace. You can deploy it in any namespace. For that, you have to edit `controller.yaml`.
+Apply the controller for `Ping`. I am deploying it in `metacontroller` namespace. You can deploy it in any namespace.
 ```bash
 kubectl apply -f controller.yaml
 ```
 
 Wait for controller pod to come in running state.
+```bash
+kubectl get pod -n metacontroller
+```
 
 Create a ping cr. Find the sample `Ping` is [here](https://github.com/shovanmaity/metacontroller-by-example/blob/master/basic-k8s/deploy/ping.yaml).
 ```bash
@@ -30,7 +33,7 @@ spec:
 EOF
 ```
 
-Check `Pong` is created or not and validate the `spec.message`. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
+Check the `Pong` cr and validate the message. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
 ```bash
 kubectl get pong -A
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'

basic-k8s/js/readme.md

@@ -6,17 +6,20 @@ Make sure you are inside `basic-k8s/js` directory.
 
 ### Do it yourself
 
-Apply the crd present in `deploy` folder.
+Apply the crd.
 ```bash
 kubectl apply -f ../deploy/crd.yaml
 ```
 
-Apply the controller for `Ping`. I am deploying it in `metacontroller` namespace. You can deploy it in any namespace. For that, you have to edit `controller.yaml`.
+Apply the controller for `Ping`. I am deploying it in `metacontroller` namespace. You can deploy it in any namespace.
 ```bash
 kubectl apply -f controller.yaml
 ```
 
 Wait for controller pod to come in running state.
+```bash
+kubectl get pod -n metacontroller
+```
 
 Create a ping cr. Find the sample `Ping` is [here](https://github.com/shovanmaity/metacontroller-by-example/blob/master/basic-k8s/deploy/ping.yaml).
 ```bash
@@ -30,7 +33,7 @@ spec:
 EOF
 ```
 
-Check `Pong` is created or not and validate the `spec.message`. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
+Check the `Pong` cr and validate the message. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
 ```bash
 kubectl get pong -A
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'

basic-k8s/python/readme.md

@@ -6,17 +6,20 @@ Make sure you are inside `basic-k8s/python` directory.
 
 ### Do it yourself
 
-Apply the crd and controller present in `deploy` folder.
+Apply the crd and controller.
 ```bash
 kubectl apply -f ../deploy/crd.yaml
 ```
 
-Apply the controller for `Ping`. I am deploying it in `metacontroller` namespace. You can deploy it in any namespace. For that, you have to edit `controller.yaml`.
+Apply the controller for `Ping`. I am deploying it in `metacontroller` namespace. You can deploy it in any namespace.
 ```bash
 kubectl apply -f controller.yaml
 ```
 
 Wait for controller pod to come in running state.
+```bash
+kubectl get pod -n metacontroller
+```
 
 Create a ping cr. Find the sample `Ping` is [here](https://github.com/shovanmaity/metacontroller-by-example/blob/master/basic-k8s/deploy/ping.yaml).
 ```bash
@@ -30,7 +33,7 @@ spec:
 EOF
 ```
 
-Check `Pong` is created or not and validate the `spec.message`. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
+Check the `Pong` cr and validate the message. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
 ```bash
 kubectl get pong -A
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'

basic/go/readme.md

@@ -15,7 +15,7 @@ spec:
         url: http://192.168.1.15:8080/sync
 ```
 
-Apply the crd and controller present in `deploy` folder.
+Apply the crd and controller.
 ```bash
 kubectl apply -f ../deploy/controller.yaml
 kubectl apply -f ../deploy/crd.yaml
@@ -38,7 +38,7 @@ spec:
 EOF
 ```
 
-Check `Pong` is created or not and validate the `spec.message`. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
+Check the `Pong` cr and validate the message. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
 ```bash
 kubectl get pong -A
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'

basic/js/readme.md

@@ -15,7 +15,7 @@ spec:
         url: http://192.168.1.15:8080/sync
 ```
 
-Apply the crd and controller present in `deploy` folder.
+Apply the crd and controller.
 ```bash
 kubectl apply -f ../deploy/controller.yaml
 kubectl apply -f ../deploy/crd.yaml
@@ -39,7 +39,7 @@ spec:
 EOF
 ```
 
-Check `Pong` is created or not and validate the `spec.message`. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
+Check the `Pong` cr and validate the message. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
 ```bash
 kubectl get pong -A
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'

basic/python/readme.md

@@ -15,7 +15,7 @@ spec:
         url: http://192.168.1.15:8080/sync
 ```
 
-Apply the crd and controller present in `deploy` folder.
+Apply the crd and controller.
 ```bash
 kubectl apply -f ../deploy/controller.yaml
 kubectl apply -f ../deploy/crd.yaml
@@ -38,7 +38,7 @@ spec:
 EOF
 ```
 
-Check `Pong` is created or not and validate the `spec.message`. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
+Check the `Pong` cr and validate the message. `Pong` cr will be created in the same namespace in which `Ping` cr is present.
 ```bash
 kubectl get pong -A
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'

composite-controller/generate-selector/readme.md

@@ -13,11 +13,6 @@ Make sure you are inside `composite-controller/generate-selector` directory.
 
 ### Do it yourself
 
-Apply the crd.
-```bash
-kubectl apply -f deploy/crd.yaml
-```
-
 ### Case-1
 
 Edit the `deploy/case-1/controller.yaml` file and update the URL.
@@ -34,6 +29,11 @@ Apply the controller.
 kubectl apply -f deploy/case-1/controller.yaml
 ```
 
+Apply the crd.
+```bash
+kubectl apply -f deploy/crd.yaml
+```
+
 Create a ping cr using -
 ```bash
 cat <<EOF | kubectl apply -f -
@@ -77,6 +77,11 @@ Apply the controller.
 kubectl apply -f deploy/case-2/controller.yaml
 ```
 
+Apply the crd.
+```bash
+kubectl apply -f deploy/crd.yaml
+```
+
 Create a ping cr using -
 ```bash
 cat <<EOF | kubectl apply -f -

composite-controller/resync-period/readme.md

@@ -39,9 +39,7 @@ spec:
 EOF
 ```
 
-Try the below processes -
-
-- Check the logs of python file execution.
+Check the logs of python file execution.
 
 ### Cleanup
 

composite-controller/spec-selector/readme.md

@@ -75,7 +75,10 @@ Execute python file.
 python3 python/case-1/sync.py
 ```
 
-Check for pong cr `kubectl get pong -A`. You will not find any pong as we are not setting label in pong cr in python code `case-1/sync.py`.
+Check for pong cr. You will not find any pong as we are not setting label in pong cr in python code `case-1/sync.py`.
+```bash
+kubectl get pong -A
+```
 
 ### Case-2
 
@@ -84,7 +87,10 @@ Stop the python file execution and execute another python file
 python3 python/case-2/sync.py
 ```
 
-Check for pong cr `kubectl get pong -A`. You will find one pong.
+Check for pong cr. You will find one pong.
+```bash
+kubectl get pong -A
+```
 
 Run the below command and saw the output
 ```
@@ -113,15 +119,21 @@ kubectl get pong -A -o=jsonpath='{range .items[*]}{@.metadata.ownerReferences}{"
 kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status.replicas}{"\n"}{end}'
 ```
 
-Remove the label from newly created pong cr `kubectl label pong shovan-tmp name-`.
+Remove the label from newly created pong cr
+```bash
+kubectl label pong shovan-tmp name-
+```
 
 Run the below command and saw the output
 ```
 kubectl get pong -A -o=jsonpath='{range .items[*]}{@.metadata.ownerReferences}{"\n"}{end}'
 kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status.replicas}{"\n"}{end}'
 ```
 
-Delete the new pong cr `kubectl delete pong shovan-tmp`.
+Delete the new pong cr
+```bash
+kubectl delete pong shovan-tmp
+```
 
 ### Case-3
 
@@ -130,9 +142,15 @@ Stop the python file execution and execute another python file
 python3 python/case-3/sync.py
 ```
 
-Check the pong cr `kubectl get pong -A`
+Check the pong cr
+```bash
+kubectl get pong -A
+```
 
-Check the ping cr's replicas `kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status.replicas}{"\n"}{end}'`
+Check the ping cr's replicas
+```bash
+kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status.replicas}{"\n"}{end}'
+```
 
 Create a new pong with same label
 ```bash
@@ -149,7 +167,10 @@ spec:
 EOF
 ```
 
-Check the ping cr's replicas `kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status.replicas}{"\n"}{end}'`
+Check the ping cr's replicas
+```bash
+kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status.replicas}{"\n"}{end}'
+```
 
 It will be 1, newly created pong cr will be deleted as python code in `case-3/ping.py` declines to list that cr.
 

composite-controller/sync-finalize-hook/readme.md

@@ -71,11 +71,20 @@ spec:
 EOF
 ```
 
-Try the below processes -
+Get the `metadata.finalizers` of the ping cr.
+```bash
+kubectl get ping -o=jsonpath='{range .items[*]}{@.metadata.finalizers}{"\n"}{end}'
+```
 
-- Get the `metadata.finalizers` of the ping cr using `kubectl get ping -o=jsonpath='{range .items[*]}{@.metadata.finalizers}{"\n"}{end}'`.
-- Delete the `Ping` cr using `kubectl delete ping -A --all`.
-- List `Pong` cr using `kubectl get ping -A`.
+Delete the `Ping` cr.
+```bash
+kubectl delete ping -A --all
+```
+
+List `Pong` cr.
+```bash
+kubectl get ping -A
+```
 
 ### Cleanup
 

composite-controller/target-status/readme.md

@@ -1,5 +1,6 @@
 ### Concept
 
+A JSON object that will completely replace the status field within the target object. Leave unspecified or null to avoid changing status You can specify this in the response of sync hook.
 
 ### Prerequisite
 
@@ -39,7 +40,7 @@ spec:
 EOF
 ```
 
-Check the status of ping cr -
+Check the status of ping cr
 ```yaml
 kubectl get ping -A -o=jsonpath='{range .items[*]}{@.status}{"\n"}{end}'
 ```

composite-controller/update-strategy-inplace/readme.md

@@ -8,6 +8,8 @@ Make sure metacontroller is [installed](https://github.com/shovanmaity/metacontr
 
 Make sure you are inside `composite-controller/update-strategy-inplace` directory.
 
+### Do it yourself
+
 Edit the `deploy/controller.yaml` file and update the webhook URL.
 ```yaml
 spec:
@@ -40,10 +42,15 @@ spec:
 EOF
 ```
 
-Try the below processes -
+Get the `metadata.uid` of the pong cr.
+```bash
+kubectl get pong -o=jsonpath='{range .items[*]}{@.metadata.uid}{"\n"}{end}'
+```
 
-- Get the `metadata.uid` of the pong object using `kubectl get pong -o=jsonpath='{range .items[*]}{@.metadata.uid}{"\n"}{end}'`.
-- Edit the ping and change the `spec.name` then check `metadata.uid` of the pong object it should be same and message should contain updated name. Get the message using `kubectl get pong -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'`.
+Edit the ping and change the `spec.name` then check `metadata.uid` of the pong cr. It should be same and message should contain updated name.
+```bash
+kubectl get pong -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'
+```
 
 ### Cleanup
 

composite-controller/update-strategy-ondelete/readme.md

@@ -2,12 +2,14 @@
 
 Metacontroller allows define upgrade strategy for chieldren. For `OnDelete` - it does not update existing children unless they get deleted by some other agent.
 
-Make sure metacontroller is [installed](https://github.com/shovanmaity/metacontroller-by-example/tree/master/metacontroller).
-
 ### Prerequisite
 
+Make sure metacontroller is [installed](https://github.com/shovanmaity/metacontroller-by-example/tree/master/metacontroller).
+
 Make sure you are inside `composite-controller/update-strategy-ondelete` directory.
 
+### Do it yourself
+
 Edit the `deploy/controller.yaml` file and update the webhook URL.
 ```yaml
 spec:
@@ -17,8 +19,6 @@ spec:
         url: http://192.168.1.15:8080/sync
 ```
 
-### Do it yourself
-
 Apply the crd and controller.
 ```bash
 kubectl apply -f deploy/crd.yaml
@@ -42,10 +42,12 @@ spec:
 EOF
 ```
 
-Try the below processes -
+Edit the ping and change the `spec.name` then check the pong object it's message should not contain updated name
+```bash
+kubectl get pong -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'
+```
 
-- Edit the ping and change the `spec.name` then check the pong object it's message should not contain updated name. Get the message using `kubectl get pong -o=jsonpath='{range .items[*]}{@.spec.message}{"\n"}{end}'`.
-- Delete the pong object then check the pong object it's message should contain updated name.
+Delete the pong object then check the pong object it's message should contain updated name.
 
 ### Cleanup