Update README.md

README.md

@@ -2,42 +2,66 @@
 
 ## What is kube-loxilb ?
 
-kube-loxilb is loxilb's implementation of kubernetes service load-balancer spec which includes support for load-balancer class, IPAM (shared or exclusive) etc.
+[kube-loxilb](https://github.com/loxilb-io/kube-loxilb) is loxilb's implementation of kubernetes service load-balancer spec which includes support for load-balancer class, advanced IPAM (shared or exclusive), lb services on multus pods etc. kube-loxilb runs as a deloyment set in kube-system namespace. 
 
 ## How is kube-loxilb different from loxi-ccm ?
 
-[loxi-ccm](https://github.com/loxilb-io/loxi-ccm) also provides implementation of kubernetes load-balancer spec but it runs as a part of cloud-provider and provides load-balancer life-cycle management as part of it. If one does not have a cloud-provider or wants to integrate loxilb with their existing cloud-provider, one can use or include loxi-ccm as a part of it
+Another loxilb component known as [loxi-ccm](https://github.com/loxilb-io/loxi-ccm) also provides implementation of kubernetes load-balancer spec but it runs as a part of cloud-provider and provides load-balancer life-cycle management as part of it. If one does not need a cloud-provider or wants to integrate loxilb with their existing cloud-provider, one can use or include loxi-ccm as a part of it. If not kube-loxilb is the right component to use.
 
 kube-loxilb is a standalone implementation of kubernetes load-balancer spec which does not depend on cloud-provider. It runs as a kube-system deployment and provisions load-balancer based on load-balancer class. It only acts on load-balancers for the LB classes that is provided by itself. This also allows us to have different load-balancers working together in the same K8s environment.
 
 ## How to use kube-loxilb ?
 
-Download the loxilb config yaml :
+1.Make sure loxilb docker is downloaded and installed properly. One can follow guides [here](https://loxilb-io.github.io/loxilbdocs/run/) or refer to various other [documentation](https://loxilb-io.github.io/loxilbdocs/#how-to-guides)
+
+2.Download the loxilb config yaml :
+
 ```
 wget https://github.com/loxilb-io/kube-loxilb/raw/main/manifest/kube-loxilb.yaml
 ```
 
-Modify arguments as per user's needs :
+3.Modify arguments as per user's needs :
 ```
 args:
         - --loxiURL=http://12.12.12.1:11111
         - --externalCIDR=123.123.123.1/24
-
+        #- --monitor
+        #- --setBGP=false
+        #- --setLBMode=1
+        #- --setUniqueIP=false
 ```
 
-Apply the following :
+The arguments have the following meaning :    
+- loxiURL : API server address of loxilb. This is the docker IP address loxilb docker of Step 1.   
+- externalCIDR : CIDR or IPAddress range to allocate addresses from. By default address allocated are shared for different services(shared Mode)    
+- monitor : Enable liveness probe for the LB end-points (default : unset)    
+- setBGP : Use BGP to advertise this service (default :false). Please check [here](https://github.com/loxilb-io/loxilbdocs/blob/main/docs/integrate_bgp_eng.md) how it works.    
+- setLBMode : 0, 1, 2   
+  0 - default (only DNAT, preserves source-IP)       
+  1 - onearm (source IP is changed to load balancer’s interface IP)     
+  2 - fullNAT (sourceIP is changed to virtual IP)    
+- setUniqueIP : Allocate unique service-IP per LB service (default : false)   
+
+4. Apply the following :
 ```
 kubectl apply -f kube-loxilb.yaml
 ```
 
-The above should make sure kube-loxilb is successfully running. Finally to create service LB, we can use and apply the following template yaml (with loadBalancerClass) :
+5. The above should make sure kube-loxilb is successfully running. Check kube-loxilb is running :
+
+```
+kubectl get pods -A | grep kube-loxilb
+```
+
+
+6. Finally to create service LB, we can use and apply the following template yaml 
+(<b>Note</b> -  Check *loadBalancerClass* annotation) :
 ```
 apiVersion: v1
 kind: Service
 metadata:
   name: iperf-service
 spec:
-  externalTrafficPolicy: Local
   loadBalancerClass: loxilb.io/loxilb
   selector:
     what: perf-test
@@ -64,6 +88,7 @@ spec:
 ```
 Users can change the above as per their needs.
 
-
-
-
+7. Verify LB service is created
+```
+kubectl get svc
+```