Fix for documentation broken links (#3447)

Author: vklohiya

docs/RELEASE-NOTES.rst

@@ -24,7 +24,7 @@ From CIS > 2.0, AS3 >= 3.18 is required.
 https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/userguide/installation.html
 
 * Get the required YAML files for the repo and update the files to the setup environment.
-https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/openshift for YAML files to use moving forward.
+https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/openshift for YAML files to use moving forward.
 
 ## 3. Adding BIG-IP to OpenShift Cluster
 
@@ -34,7 +34,7 @@ Create one HostSubnet for each BIG-IP device.
 These will handle health monitor traffic. 
 Also create one HostSubnet to pass data traffic using floating IP address. 
 
-**Note** Refer YAML files at https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/openshift/HA
+**Note** Refer YAML files at https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/openshift/HA
 Clone, the repo and update appropriately as per the environment.
 
 ```

docs/config_examples/Install/openshift/HA/README.md

@@ -14,7 +14,7 @@ From CIS > 2.0, AS3 >= 3.18 is required.
   https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/userguide/installation.html
 
 * Get the required YAML files for the repo and update the files to the setup environment.
-  https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/openshift for YAML files to use moving forward.
+  https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/openshift for YAML files to use moving forward.
 
 ## 3. Adding BIG-IP to OpenShift Cluster
 

docs/config_examples/Install/openshift/StandAlone/README.md

@@ -25,7 +25,7 @@ From CIS > 2.0, AS3 >= 3.18 is required.
   https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/userguide/installation.html
 
 * Get the required YAML files for the repo and update the files to the setup environment.
-  https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/configmap/user-defined-configmap for YAML files to use moving forward.
+  https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/configmap/user-defined-configmap for YAML files to use moving forward.
 
 CIS uses the partition defined in the CIS configuration by default to communicate with the F5 BIG-IP when adding static ARPs and forwarding entries for VXLAN. CIS managed partitions **<partition_AS3>** and **<partition>** should not be used in ConfigMap as Tenants. If CIS is deployed with **bigip-partition=cis**, then **<cis_AS3>** and **<cis>** are not supposed to be used as a tenant in AS3 declaration. Below is a proper declaration which would be correctly processed by CIS. Using **<k8s>** for the AS3 tenant in AS3. 
 

docs/config_examples/configmap/user-defined-configmap/README.md

@@ -40,7 +40,7 @@ This page is created to document the behaviour of CIS in CRD Mode.
    * Schema Validation
      - OpenAPI Schema Validation
 
-        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
+        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
 
 
 **VirtualServer Components**
@@ -198,15 +198,15 @@ This page is created to document the behaviour of CIS in CRD Mode.
 
 ### Examples
 
-   https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/VirtualServer
+   https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/VirtualServer
 
 ## TLSProfile
    * TLSProfile is used to specify the TLS termination for a single/list of services in a VirtualServer Custom Resource. TLS termination relies on SNI. Any non-SNI traffic received on port 443 may result in connection issues. 
    * TLSProfile can be created either with certificates stored as k8s secrets or can be referenced to profiles existing in BIG-IP
    * Schema Validation
      - OpenAPI Schema Validation
 
-        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
+        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
 
 
 **TLSProfile Components**
@@ -249,14 +249,14 @@ different terminations(for same domain), one with edge and another with re-encry
 
 ### Examples
 
-   https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/VirtualServerWithTLSProfile
+   https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/VirtualServerWithTLSProfile
 
 ## TransportServer
    * TransportServer resource expose non-HTTP traffic configuration for a virtual server address in BIG-IP.
    * Schema Validation
      - OpenAPI Schema Validation
 
-        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
+        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
 
 
 **TransportServer Components**
@@ -336,14 +336,14 @@ different terminations(for same domain), one with edge and another with re-encry
 
 ### Examples
 
-   https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/TransportServer
+   https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/TransportServer
 
 ## ExternalDNS
    * ExternalDNS CRD's allows you to control DNS records dynamically via Kubernetes/OSCP resources in a DNS provider-agnostic way.
    * Schema Validation
      - OpenAPI Schema Validation
 
-        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
+        https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResourceDefinitions/customresourcedefinitions.yml
 
 
 **ExternalDNS Components**
@@ -395,16 +395,16 @@ Known Issues:
 
 ### Examples
 
-   https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/ExternalDNS
+   https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/ExternalDNS
 
 
 ## IngressLink
 
-Refer https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/IngressLink/README.md
+Refer https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/IngressLink/README.md
 
 ## Policy CRD 
 
-Refer https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/Policy
+Refer https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/Policy
 
 
 # Note

docs/config_examples/customResource/CustomResource.md

@@ -32,7 +32,7 @@ Create IngressLink Custom Resource definition as follows:
 * On the Main tab, click **Local Traffic > iRules**.
 * Click **Create**.
 * In the Name field, type name as "Proxy_Protocol_iRule".
-* In the Definition field, Copy the definition from [Proxy_Protocol_iRule](https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResource/IngressLink/Proxy_Protocol_iRule) file.
+* In the Definition field, Copy the definition from [Proxy_Protocol_iRule](https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResource/IngressLink/Proxy_Protocol_iRule) file.
 * Click **Finished**.
 
 ### 3. Install the CIS Controller.
@@ -48,7 +48,7 @@ Create IngressLink Custom Resource definition as follows:
 
 * Download the sample IngressLink Resource:
 
-  ```curl -OL https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResource/IngressLink/ingresslink.yaml```
+  ```curl -OL https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResource/IngressLink/ingresslink.yaml```
 
 * Update the "virtualServerAddress" parameter in the ingresslink.yaml resource. This IP address will be used to configure the BIG-IP device. It will be used to accept traffic and load balance it among the NGINX Ingress Controller pods.
 
@@ -62,9 +62,9 @@ Create IngressLink Custom Resource definition as follows:
 
 To test the integration, deploy a sample application:
 
-    kubectl apply -f https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResource/IngressLink/ingress-example/cafe.yaml
-    kubectl apply -f https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResource/IngressLink/ingress-example/cafe-secret.yaml
-    kubectl apply -f https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/master/docs/config_examples/customResource/IngressLink/ingress-example/cafe-ingress.yaml
+    kubectl apply -f https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResource/IngressLink/ingress-example/cafe.yaml
+    kubectl apply -f https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResource/IngressLink/ingress-example/cafe-secret.yaml
+    kubectl apply -f https://raw.githubusercontent.com/F5Networks/k8s-bigip-ctlr/2.x-master/docs/config_examples/customResource/IngressLink/ingress-example/cafe-ingress.yaml
 
 The Ingress Controller pods are behind the IP configured in Step 5 (virtualServerAddress parameter).
 

docs/config_examples/customResource/IngressLink/README.md

@@ -0,0 +1,28 @@
+# Virtual Server with http2 Profile
+
+This section demonstrates the option to configure http2 Profile in virtual server.
+
+Option which can use to refer http2 Profile:
+
+```
+#Examples
+#1
+profiles:
+  http2: 
+    client: /Common/samplehttp2Client
+
+#2
+profiles:
+  http2: 
+    server: /Common/samplehttp2server
+#3
+profiles:
+  http2: 
+    client: /Common/samplehttp2Client
+    server: /Common/samplehttp2server
+```
+
+## vs-with-profilehttp2.yaml
+
+By deploying this yaml file in your cluster, CIS will create a Virtual Server containing http2 Profile on BIG-IP.
+Here client corresponds to ingress http2 profile and Server refers to egress http2 profile.

docs/config_examples/customResource/VirtualServer/http2/README.md

@@ -0,0 +1,20 @@
+apiVersion: "cis.f5.com/v1"
+kind: VirtualServer
+metadata:
+  name: my-new-virtual-server
+  labels:
+    f5cr: "true"
+spec:
+  # This is an insecure virtual, Please use TLSProfile to secure the virtual
+  # check out tls examples to understand more.
+  host: cafe.example.com
+  virtualServerAddress: "172.16.3.4"
+  botDefense: /Common/bot-defense
+  profiles:
+    http2:
+      client: /Common/Samplehttp2client
+      server: /Common/Samplehttp2Server
+  pools:
+    - path: /coffee
+      service: svc-1
+      servicePort: 80

docs/config_examples/customResource/VirtualServer/http2/vs-with-profilehttp2.yaml

@@ -682,7 +682,7 @@ spec:
 | A/B Deployment             | YES           | YES             | 
 | Policy CR                  | NO            | YES             | 
 
-Please refer to the [examples](https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/next-gen-routes) for more details.
+Please refer to the [examples](https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/next-gen-routes) for more details.
 
 
 ## Known issues
@@ -736,7 +736,7 @@ Yes you can continue using the rewriteAppRoot in route annotations.
 ### Any changes in RBAC? 
 No.
 ### How do I use policy CR with routes?
-You can define the policy CR in Extended ConfigMap [See Example](https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/Policy). </br>
+You can define the policy CR in Extended ConfigMap [See Example](https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/Policy). </br>
 Make sure that Policy CR is created in a namespace which CIS is monitoring.
 ### How do I apply different policies/profiles to HTTP and HTTPS virtual servers?
 You can use both PolicyCR and httpServerPolicyCR in route group to apply different policies/profiles to HTTP and HTTPS VS.</br>

docs/config_examples/next-gen-routes/README.md

@@ -15,7 +15,7 @@
 
 ## Overview
 NextGenRoute Controller uses extendedConfigMap for extending the native resources (routes). All the routes are group by namespaces or namespace-labels into RouteGroups. Each RouteGroup shares the same vsAddress, vsName and policy CR  which is specified in extendedConfigMap. 
-In order to migrate to nextGen we first need to create an extended ConfigMap and policy CR then modify the CIS deployment accordingly. Refer [NextGen Route Documentation](https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/next-gen-routes) for more details
+In order to migrate to nextGen we first need to create an extended ConfigMap and policy CR then modify the CIS deployment accordingly. Refer [NextGen Route Documentation](https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/next-gen-routes) for more details
 
 ## Migration using defaultRouteGroup
 Currently, RouteGroup are expected to define per namespace or namespace label as follows:
@@ -171,7 +171,7 @@ Sample Route:
 
 #### Step-2 Creating Extended ConfigMap using defaultRouteGroup
 
-Extended ConfigMap is a must-use with the nextGen Route Controller. Refer [Documentation](https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/next-gen-routes) for more details          
+Extended ConfigMap is a must-use with the nextGen Route Controller. Refer [Documentation](https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/next-gen-routes) for more details          
 
 You can create an extended ConfigMap for given example as follows:
 * You can define the vserverAddr same as "route-vserver-addr" parameter in CIS deployment.
@@ -222,7 +222,7 @@ spec:
 
 **Note**:
     * If WAF/AllowSourceRange is defined in both route annotation & policy CR, route annotation takes the priority by default.  
-    * You can use the Policy CR to extend the virtual server capabilities even more. [See Details](https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/Policy).
+    * You can use the Policy CR to extend the virtual server capabilities even more. [See Details](https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/Policy).
     * Make sure the namespace where we created the policy CR monitored by CIS.   
  
 #### Step-4 Update the CIS deployment parameters and start
@@ -248,7 +248,7 @@ spec:
 
 * Remove "tls-version", "cipher-group" & "ciphers" parameters from CIS deployment and define them under "baseRouteSpec" in extendedConfigMap. See Step-2 above.
 
-* Remove "override-as3-declaration" parameter as it's no more supported with NextGen Routes. You can use the Policy CR to extend the virtual server capabilities. [See Example](https://github.com/F5Networks/k8s-bigip-ctlr/tree/master/docs/config_examples/customResource/Policy).
+* Remove "override-as3-declaration" parameter as it's no more supported with NextGen Routes. You can use the Policy CR to extend the virtual server capabilities. [See Example](https://github.com/F5Networks/k8s-bigip-ctlr/tree/2.x-master/docs/config_examples/customResource/Policy).
 
 ```
     args: [