Post revamp readme fixes

README.md

@@ -84,4 +84,4 @@ k8gb is very well tested with the following environment options
 
 ## Contributing
 
-See (CONTRIBUTING.md)[/CONTRIBUTING.md]
+See [CONTRIBUTING.md](/CONTRIBUTING.md)

docs/deploy_route53.md

@@ -42,7 +42,7 @@ cluster, we assume that you switch kubctl context and apply the same command to
 make deploy-test-apps
 ```
 
-* Modify sample [Gslb CR](/docs/examples/route53/k8gb-failover.yaml) to reflect your
+* Modify sample [Gslb CR](/docs/examples/route53/k8gb/gslb-failover.yaml) to reflect your
 `dnsZone`, `edgeDNSZone`, valid `hostedZoneID` and `irsaRole` ARN.
 
 * Apply Gslb CR to *each* cluster
@@ -109,6 +109,7 @@ Notice that traffic is properly failed over to `us-east-1`
 
 * Experiment
 
-Now you can scale `eu-west-1` back and observe that traffic is routed back.
-In addition, you can test `roundRobin` load balancing strategy, which is spreading
-the traffic over the clusters in active-active mode.
+Now you can scale `eu-west-1` back and observe that traffic is routed back to the primary cluster.
+
+In addition, you can test `roundRobin` load balancing strategy, which is spreading the traffic
+over the clusters in active-active mode.

docs/examples/route53/k8gb/gslb-failover.yaml

@@ -0,0 +1,18 @@
+apiVersion: k8gb.absa.oss/v1beta1
+kind: Gslb
+metadata:
+  name: test-gslb-failover
+  namespace: test-gslb
+spec:
+  ingress:
+    rules:
+      - host: failover.test.k8gb.io # Desired GSLB enabled FQDN
+        http:
+          paths:
+          - backend:
+              serviceName: frontend-podinfo # Service name to enable GSLB for
+              servicePort: http
+            path: /
+  strategy:
+    type: failover # Global load balancing strategy
+    primaryGeoTag: eu-west-1 # Primary cluster geo tag

docs/local.md

@@ -64,8 +64,8 @@ eed5a40bbfb6ee97, started, etcd-cluster-xsjmwdkdf8, http://etcd-cluster-xsjmwdkd
 ...
 ```
 
-Cluster [test-gslb1](deploy/kind/cluster.yaml) is exposing external DNS on default port `:5053`
-while [test-gslb2](deploy/kind/cluster2.yaml) on port `:5054`.
+Cluster [test-gslb1](/deploy/kind/cluster.yaml) is exposing external DNS on default port `:5053`
+while [test-gslb2](/deploy/kind/cluster2.yaml) on port `:5054`.
 ```shell script
 dig @localhost localtargets.app3.cloud.example.com -p 5053 && dig -p 5054 @localhost localtargets.app3.cloud.example.com
 ```
@@ -91,8 +91,8 @@ curl localhost:80 -H "Host:app3.cloud.example.com" && curl localhost:81 -H "Host
 
 #### Run integration tests
 
-There is wide range of scenarios which **GSLB** provides and all of them are covered within [tests](terratest).
-To check whether everything is running properly execute [terratests](https://terratest.gruntwork.io/) :
+There is wide range of scenarios which **GSLB** provides and all of them are covered within [tests](/terratest).
+To check whether everything is running properly execute [terratest](https://terratest.gruntwork.io/) :
 
 ```shell script
 make terratest