Merge pull request #543 from citrix/cic-release-1.26.7

sreejithgs · web-flow · commit 683c63c08ee0 · 2022-07-05T17:16:32.000+05:30
updates for cic release 1.26.7
diff --git a/canary/README.md b/canary/README.md
@@ -765,7 +765,11 @@ You can configure canary deployment based on the HTTP request header which is co
 
 ### Canary deployment based on the HTTP request header value
 
-You can also configure canary deployment based on the value of the HTTP request header which is an extension of canary by header. In this deployment, along with the `ingress.citrix.com/canary-by-header:` annotation, you also specify the `ingress.citrix.com/canary-by-header-value:` annotation. When the request header value matches with the value specified in the Ingress annotation `ingress.citrix.com/canary-by-header-value:` the request is routed to the service specified in the canary Ingress.  
+You can also configure canary deployment based on values of the HTTP request header which is an extension of canary by header. In this deployment, along with the `ingress.citrix.com/canary-by-header:` annotation, you also specify the `ingress.citrix.com/canary-by-header-value:` annotation. When the request header value matches with the value specified in the Ingress annotation `ingress.citrix.com/canary-by-header-value:` the request is routed to the service specified in the canary Ingress.  You can specify multiple header values as a list of strings.
+
+Following is a sample annotation for canary deployment based on the HTTP request header values:
+
+ingress.citrix.com/canary-by-header-value: '["value1","value2","value3","value4"]'
 
 ### Configure canary deployment using Ingress annotations
 
@@ -828,3 +832,6 @@ Perform the following steps to deploy a sample application as a canary release.
 For deploying the HTTP header based canary using the Citrix ingress controller, replace the canary annotation `ingress.citrix.com/canary-weight:` with the `ingress.citrix.com/canary-by-header:`  annotation in the `canary-ingress.yaml` file.
 
 For deploying the HTTP header value based canary using the Citrix ingress controller, replace the `ingress.citrix.com/canary-weight:` annotation with the `ingress.citrix.com/canary-by-header:` and `ingress.citrix.com/canary-by-header-value:` annotations in the `canary-ingress.yaml` file.
+
+**Note:**
+You can see the [Canary example YAMLs](https://github.com/citrix/citrix-k8s-ingress-controller/tree/master/example/simple-canary) for achieving canary based on the header and canary based on the header value.
diff --git a/deployment/baremetal/README.md b/deployment/baremetal/README.md
@@ -204,11 +204,20 @@ Perform the following steps to deploy the Citrix ingress controller as a stand-a
 
         Specifies the Citrix ADM IP address for collecting analytics.
        </details>
+       <details>
+       <summary>NS_DNS_NAMESERVER</summary>
+        Enables adding DNS nameservers on Citrix ADC VPX.
+       </details>
+
        <details>
        <summary>NS_CONFIG_DNS_REC</summary>
-        Enables the DNS server configuration on Citrix ADC. This variable is configured at the boot time and cannot be changed at runtime. Possible values are true or false. The default value is `false`. 
+        Enables adding DNS records on Citrix ADC for Ingress resources. This variable is configured at the boot time and cannot be changed at runtime. Possible values are true or false. The default value is `false` and you need to set it as `true` to enable the DNS server configuration.
+       </details>
+       
+       <details>
+       <summary>NS_SVC_LB_DNS_REC</summary>
+        Enables adding DNS records on Citrix ADC for services of type LoadBalancer. Possible values are true or false. This variable is configured at the boot time and cannot be changed at runtime. The default value is `false` and you need to set it as `true` to enable the DNS server configuration.
        </details>
-     
 
 1. Deploy the Citrix ingress controller using the `kubectl create` command.
         
diff --git a/docs/canary/canary.md b/docs/canary/canary.md
@@ -763,9 +763,13 @@ For deploying weight based canary using the Citrix ingress controller, create a
 
 You can configure canary deployment based on the HTTP request header which is controlled by clients. The request header notifies the Ingress to route the request to the service specified in the canary Ingress. When the request header contains the value mentioned in the Ingress annotation `ingress.citrix.com/canary-by-header:`, the request is routed to the service specified in the canary Ingress.
 
-### Canary deployment based on the HTTP request header value
+### Canary deployment based on the HTTP request header values
 
-You can also configure canary deployment based on the value of the HTTP request header which is an extension of canary by header. In this deployment, along with the `ingress.citrix.com/canary-by-header:` annotation, you also specify the `ingress.citrix.com/canary-by-header-value:` annotation. When the request header value matches with the value specified in the Ingress annotation `ingress.citrix.com/canary-by-header-value:` the request is routed to the service specified in the canary Ingress.  
+You can also configure canary deployment based on values of the HTTP request header which is an extension of canary by header. In this deployment, along with the `ingress.citrix.com/canary-by-header:` annotation, you also specify the `ingress.citrix.com/canary-by-header-value:` annotation. When the request header value matches with the value specified in the Ingress annotation `ingress.citrix.com/canary-by-header-value:` the request is routed to the service specified in the canary Ingress.  You can specify multiple header values as a list of strings.
+
+Following is a sample annotation for canary deployment based on the HTTP request header values:
+
+ingress.citrix.com/canary-by-header-value: '["value1","value2","value3","value4"]'
 
 ### Configure canary deployment using Ingress annotations
 
@@ -828,5 +832,5 @@ For deploying the HTTP header based canary using the Citrix ingress controller,
 
 For deploying the HTTP header value based canary using the Citrix ingress controller, replace the `ingress.citrix.com/canary-weight:` annotation with the `ingress.citrix.com/canary-by-header:` and `ingress.citrix.com/canary-by-header-value:` annotations in the `canary-ingress.yaml` file.
 
-**Note:** 
-You can see the [Canary example YAMLs](https://github.com/citrix/citrix-k8s-ingress-controller/tree/master/example/simple-canary) for achieving canary based on header and canary based on header value.
+**Note:**
+You can see the [Canary example YAMLs](https://github.com/citrix/citrix-k8s-ingress-controller/tree/master/example/simple-canary) for achieving canary based on the header and canary based on the header value.
diff --git a/docs/configure/add-dns-records.md b/docs/configure/add-dns-records.md
@@ -0,0 +1,44 @@
+# Add DNS records using Citrix ADC ingress controller
+
+A DNS address record is a mapping of the domain name to the IP address.
+When you want to use Citrix ADC as a DNS resolver, you can add the DNS records on Citrix ADC using Citrix ingress controller.
+
+For more information on creating DNS records on Citrix ADC, see the [Citrix ADC documentation](https://docs.citrix.com/en-us/citrix-adc/current-release/dns/configure-dns-resource-records/create-address-records.html).
+
+## Adding DNS records for Ingress resources
+
+You need to enable the following environment variable during the Citrix ingress controller deployment to add DNS records for an Ingress resource.
+
+`NS_CONFIG_DNS_REC`: This variable is configured at the boot time and cannot be changed at runtime. Possible values are `true` or `false`. The default value is false and you need to set it as true to enable the DNS server configuration. When you set the value as `true`, an address record is created on Citrix ADC.
+
+## Adding DNS records for services of type LoadBalancer
+
+You need to perform the following tasks to add DNS records for services of type LoadBalancer:
+
+-  Enable the `NS_SVC_LB_DNS_REC` environment variable by setting the value as `True` for adding DNS records for a service of type LoadBalancer.
+-  Specify the DNS host name using the `service.citrix.com/dns-hostname` annotation.
+
+When you create a service of type LoadBalancer with the  `service.citrix.com/dns-hostname` annotation, Citrix ingress controller adds the DNS record on Citrix ADC. The DNS record is configured using the domain name specified in the annotation and the external IP address assigned to the service.
+
+When you delete a service of type LoadBalancer with the `service.citrix.com/dns-hostname` annotation, Citrix ADC ingress controller removes the DNS records from the Citrix ADC.
+Citrix ingress controller also removes the stale entries of DNS records during boot up if the service is not available.
+
+The following example shows a sample service of type LoadBalancer with the annotation configuration to add DNS records to Citrix ADC:
+
+```yml
+apiVersion: v1
+kind: Service
+metadata:
+  name: guestbook
+  annotations:
+      service.citrix.com/dns-hostname: "guestbook.com"
+spec:
+  loadBalancerIP: "192.2.212.16"
+  type: LoadBalancer
+  ports:
+  - port: 9006
+    targetPort: 80
+    protocol: TCP
+  selector:
+    app: guestbook
+```
diff --git a/docs/configure/config-map.md b/docs/configure/config-map.md
@@ -22,8 +22,6 @@ The values for the following environment variables in the Citrix ingress control
 
 - NS_DNS_NAMESERVER: Enables adding DNS nameservers on Citrix ADC VPX.
 
-- NS_CONFIG_DNS_REC: Enables addding DNS address records on the Citrix ADC to configure Citrix ADC as a DNS server.
-
 - POD_IPS_FOR_SERVICEGROUP_MEMBERS: Specifies to add the IP address of the pod and port as service group members instead of `NodeIP` and `NodePort` while configuring services of type `LoadBalancer` or `NodePort` on an external tier-1 Citrix ADC.
 
 - IGNORE_NODE_EXTERNAL_IP: Specifies to ignore an external IP address and add an internal IP address for NodeIP while configuring NodeIP for services of type `LoadBalancer` or `NodePort` on an external tier-1 Citrix ADC.
diff --git a/docs/deploy/deploy-cic-yaml.md b/docs/deploy/deploy-cic-yaml.md
@@ -99,8 +99,10 @@ Perform the following:
     | NAMESPACE               | Optional              | While running a Citrix ingress controller with Role based RBAC, you must provide the namespace which you want to listen or get events. This namespace must be same as the one used for creating the service account. Using the service account, the Citrix ingress controller can listen on a namespace. You can use the  `NAMESPACE` environment variable to specify the namespace. For more information, see [Deploy the Citrix ingress controller for a namespace](#Deploy-the-Citrix-ingress-controller-for-a-namespace). |
     | POD_IPS_FOR_SERVICEGROUP_MEMBERS| Optional| By default, while configuring services of type LoadBalancer and NodePort on an external tier-1 Citrix ADC the Citrix ingress controller adds NodeIP and NodePort as service group members. If this variable is set as `True`, pod IP address and port are added instead of NodeIP and NodePort as service group members.|
     |IGNORE_NODE_EXTERNAL_IP| Optional |While adding NodeIP for services of type LoadBalancer or NodePort on an external tier-1 Citrix ADC, the Citrix ingress controller prioritizes an external IP address over an internal IP address. When you want to prefer an internal IP address over an external IP address for NodeIP, you can set this variable to `True`.|
-    | NS_CONFIG_DNS_REC | Optional| Enables the DNS server configuration on Citrix ADC. This variable is configured at the boot time and cannot be changed at runtime. Possible values are true or false. The default value is `false` and you need to set it as `true` to enable the DNS server configuration. When you set the value as 'true', the corresponding command `add dns addrec <abc.com 1.1.1.1>` is executed on Citrix ADC and an address record (mapping of the domain name to IP address)  is created. For more information, see [Create address records for a domain name](https://docs.citrix.com/en-us/citrix-adc/current-release/dns/configure-dns-resource-records/create-address-records.html#:~:text=Add%20an%20Address%20record%20by%20using%20the%20GUI,and%20create%20an%20Address%20record). |
-
+    |NS_DNS_NAMESERVER | Optional | Enables adding DNS nameservers on Citrix ADC VPX. |
+    | NS_CONFIG_DNS_REC | Optional| Enables adding DNS records on Citrix ADC for Ingress resources. This variable is configured at the boot time and cannot be changed at runtime. Possible values are true or false. The default value is `false` and you need to set it as `true` to enable the DNS server configuration. When you set the value as 'true', the corresponding command `add dns addrec <abc.com 1.1.1.1>` is executed on Citrix ADC and an address record (mapping of the domain name to IP address)  is created. For more information, see [Create address records for a domain name](https://docs.citrix.com/en-us/citrix-adc/current-release/dns/configure-dns-resource-records/create-address-records.html#:~:text=Add%20an%20Address%20record%20by%20using%20the%20GUI,and%20create%20an%20Address%20record). |
+  
+   | NS_SVC_LB_DNS_REC | Optional| Enables adding DNS records on Citrix ADC for services of type LoadBalancer. This variable is configured at the boot time and cannot be changed at runtime. Possible values are true or false. The default value is `false` and you need to set it as `true` to enable the DNS server configuration. |
 
 2.  Once you update the environment variables, save the YAML file and deploy it using the following command:
 
diff --git a/example/simple-canary/canary-by-multiple-header-values.yml b/example/simple-canary/canary-by-multiple-header-values.yml
@@ -0,0 +1,21 @@
+apiVersion: networking.k8s.io/v1
+kind: Ingress
+metadata:
+ name: guestbook
+ annotations:
+   kubernetes.io/ingress.class: “citrix”
+   ingress.citrix.com/frontend-ip: 192.0.2.179
+   ingress.citrix.com/canary-by-header: “header-name”
+   ingress.citrix.com/canary-by-header-value: '[“value1”,“value2",“value3”,“value4"]'
+spec:
+ rules:
+ - host: guestbook.com
+   http:
+     paths:
+     - path: /
+       pathType: Prefix
+       backend:
+         service:
+           name: frontend
+           port:
+             number: 80
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -123,6 +123,7 @@ nav:
     - Profile support for the Listener CRD: configure/profiles-for-listener-crd.md
     - IP address management using the Citrix IPAM controller for Ingress resources: configure/ipam-for-ingress.md
     - Apply CRDs using annotations: configure/crds-annotations.md 
+    - Add DNS records using Citrix ADC ingress controller: configure/add-dns-records.md
   - Network: 
     - Static routing: network/staticrouting.md
     - Establish network between K8s nodes and Ingress Citrix ADC using Citrix node controller: network/node-controller.md
