Release v1.2.0-beta

Signed-off-by: Subash Dangol <subash.dangol@citrix.com>

Author: subashd

Makefile

@@ -22,6 +22,9 @@ check: check_format lint
 # Run Unit Tests with code-coverage
 utest: unit_test integration_test coverage_report
 
+create_certs:
+	sh tests/create_cert.sh
+
 unit_test:
 	go test -p 1 -race -timeout 1m -cover -coverprofile=unittestcov.out -v citrix-istio-adaptor/nsconfigengine citrix-istio-adaptor/adsclient citrix-istio-adaptor/istio-adaptor
 
@@ -33,6 +36,9 @@ coverage_report:
 	gocovmerge integrationtestcov.out unittestcov.out > combinedcoverage.out
 	go tool cover -func=combinedcoverage.out
 	go tool cover -html=combinedcoverage.out -o combinedcoverage.html
+	go get github.com/axw/gocov/gocov
+	go get github.com/AlekSi/gocov-xml
+	gocov convert combinedcoverage.out | gocov-xml > combinedcoverage.xml
 
 clean:
-	- rm integrationtestcov.out unittestcov.out combinedcoverage.out combinedcoverage.html
+	- rm integrationtestcov.out unittestcov.out combinedcoverage.out combinedcoverage.html combinedcoverage.xml

README.md

@@ -22,12 +22,14 @@ This repository contains various integrations of [Citrix ADC](https://www.citrix
 4. [Architecture](#architecture)
 4. [Deployment Options](#deployment-options)
 5. [Features](#features)
-6. [Release Notes](#release-notes)
-7. [Contributions](#contributions)
-8. [Questions](#questions)
-9. [Issues](#issues)
-10. [Code of Conduct](#code-of-conduct)
-11. [Licensing](#licensing)
+6. [Example: Deploying Bookinfo with Citrix ADC](#example)
+7. [Blogs](#blogs)
+8. [Release Notes](#release-notes)
+9. [Contributions and Development](#contributions)
+10. [Questions](#questions)
+11. [Issues](#issues)
+12. [Code of Conduct](#code-of-conduct)
+13. [Licensing](#licensing)
 
 ## <a name="introduction">Introduction</a>
 
@@ -45,7 +47,7 @@ An Istio ingress gateway acts as an entry point for the incoming traffic and sec
 
 ## <a name="citrix-adc-as-a-sidecar">Citrix ADC as a Sidecar Proxy for Istio</a>
 
-In Istio service mesh, a sidecar proxy runs alongside application pods and it intercepts and manages incoming and outgoing traffic for applications. Citrix ADC CPX can be deployed as the sidecar proxy in application pods. A sidecar proxy applies the configured routing policies or rules to the ingress and egress traffic from the pod.
+In Istio service mesh, a sidecar proxy runs alongside application pods and it intercepts and manages incoming and outgoing traffic for applications. Citrix ADC CPX can be deployed as the sidecar proxy in application pods. A sidecar proxy applies the configured routing policies or rules to the ingress and egress traffic from the pod. This [Citrix ADC CPX](https://www.citrix.com/blogs/2020/02/25/citrix-adc-cpx-for-service-mesh-memory-footprint-and-microservices/) is designed to consume less resources.
 
 
 ## <a name="architecture">Architecture</a>
@@ -66,15 +68,15 @@ You can deploy Citrix ADC with Istio using Kubernetes YAML or Helm charts. To de
 
 To deploy Citrix ADC with Istio using Helm charts, see the following links:
 
-- [Deploy Citrix ADC as an Ingress Gateway using Helm charts](./charts/stable/citrix-adc-istio-ingress-gateway/README.md)
-- [Deploy Citrix ADC CPX as a sidecar using Helm charts](./charts/stable/citrix-cpx-istio-sidecar-injector/README.md)
+- [Deploy Citrix ADC as an Ingress Gateway using Helm charts](https://github.com/citrix/citrix-helm-charts/blob/master/citrix-adc-istio-ingress-gateway/README.md)
+- [Deploy Citrix ADC CPX as a sidecar using Helm charts](https://github.com/citrix/citrix-helm-charts/blob/master/citrix-cpx-istio-sidecar-injector/README.md)
 
 ## <a name="features">Features</a>
 
 Features supported on Citrix ADC in Istio Servicemesh can be broadly categorized in below sections.
 1. Traffic Management
 2. Security
-3. Telemetry
+3. Observability
 
 ### Traffic Management
 
@@ -102,19 +104,50 @@ Few important features supported on Citrix ADC are:
 
 Istio-adaptor monitors the folder where Istio deploys certificates and keys for mutual TLS authentication between Citrix ADC proxies. After an update of certificate and key, Istio-adaptor loads the new certificate and key to Citrix ADC.
 
-### Telemetry
+### Observability
+
+When a service is deployed in the mesh, users are interested in getting insights about service behaviour. Citrix ADC proxy provides a rich set of in-built metrics. When Citrix ADC CPX is deployed as a sidecar, these metrics will represent telemetry data for an application. It helps in reducing the burden of an application developer to program lots of instrumentation code in the application, and instead she can focus on the core application logic. 
+
+Citrix has built couple of auxiliary tools such as [Citrix ADC Metrics Exporter](https://github.com/citrix/citrix-adc-metrics-exporter) and [Citrix Observability Exporter](https://github.com/citrix/citrix-observability-exporter) which help in exporting metrics and/or transactional data to observability tools such as Prometheus, Zipkin, Kafta etc.
+
+Statistical data of Citrix ADC Ingress device can be exported to the Prometheus using [Citrix ADC Metrics Exporter](https://github.com/citrix/citrix-adc-metrics-exporter). 
+
+[Citrix Observability Exporter](https://github.com/citrix/citrix-observability-exporter) (COE) is a microservice designed to collect metrics from Citrix ADCs, and export to observability tools such as Zipkin, Kafka, Prometheus etc.
+To know more about COE, kindly refer this [link](https://github.com/citrix/citrix-observability-exporter).
+
+
+#### Telemetry in Ingress Gateway
+
+[Prometheus](https://prometheus.io) is usually already installed as a part of Istio package. By default, Citrix ADC Metrics Exporter is also deployed along with Citrix ADC Ingress Gateway. Citrix ADC Metrics Exporter fetches statistical data from Citrix ADC and exports it to Prometheus running in Istio service mesh. When you add Prometheus as a data source in Grafana, you can visualize this statistical data in the Grafana dashboard. 
+
+
+#### Telemetry and Distributed Tracing in Sidecar proxies
+
+Citrix ADC CPX in conjunction with the Citrix Observability Exporter (COE) can export metrics to Prometheus deployed in Istio service mesh. This data can also be visualized in Grafana. 
+
+Citrix ADC CPX sends transactional data to COE which eventually exports these trace spans to [Zipkin](https://zipkin.io). This distributed tracing enables users to track a service to service communication within a mesh. It helps in getting deeper understanding about request latency, serialization and parallelism via visualization.
 
-Statistical data of Citrix ADC Ingress device can be exported to the Prometheus using [Citrix ADC Metrics Exporter](https://github.com/citrix/citrix-adc-metrics-exporter). Prometheus already installed as a part of Istio package. By default, Citrix ADC Metrics Exporter is also deployed along with Citrix ADC Ingress Gateway. Citrix ADC Metrics Exporter fetches statistical data from Citrix ADC and exports it to Prometheus running in Istio service mesh. When you add Prometheus as a data source in Grafana, you can visualize this statistical data in the Grafana dashboard. 
 
 The detailed list of fields supported on Citrix ADC as per the Istio CRDs (Destination Rule, Virtual Service, Policy, Gateway, Service Entry) can be found [here](docs/features.md).
 
+## <a name="example">Example: Deploying Bookinfo with Citrix ADC</a>
+Follow this [link](https://github.com/citrix/citrix-helm-charts/blob/master/examples/citrix-adc-in-istio/README.md) to deploy Bookinfo application with Citrix ADC acting as an Istio Ingress Gateway and Citrix ADC CPX as sidecar in application pods.
+
+## <a name="blogs">Blogs</a>
+
+1. [Citrix ADC as an Istio Ingress Gateway: Part 1 Deployment](https://www.citrix.com/blogs/2019/11/13/citrix-adc-as-an-istio-ingress-gateway-part-1-deployment/)
+2. [Citrix ADC as an Istio Ingress Gateway: Part 2 Configuration](https://www.citrix.com/blogs/2019/11/14/citrix-adc-as-an-istio-ingress-gateway-part-2-configuration/)
+3. [Citrix ADC in OpenShift Service Mesh](https://blog.openshift.com/citrix-adc-in-openshift-service-mesh/)
+
 ## <a name="release-notes">Release Notes</a>
 
-Click [here](https://github.com/citrix/citrix-istio-adaptor/releases) for the release notes of the latest Citrix `istio-adaptor`.
+Click [here](docs/release-notes.md) for the release notes of the latest Citrix `istio-adaptor`.
+
+## <a name="contributions">Contributions and Development</a>
 
-## <a name="contributions">Contributions</a>
+Refer [Contributions](CONTRIBUTING.md)
 
-Contributions are always welcome! Please read the [Developer Guide](docs/developer_guide.md).
+Please read the [Developer Guide](docs/developer-guide.md).
 
 ## <a name="questions">Questions</a>
 

Version

@@ -1 +1 @@
-1.1.0
+1.2.0

adsclient/ads_client.go

@@ -15,15 +15,16 @@ package adsclient
 
 import (
 	"context"
+	"log"
+	"strings"
+	"sync"
+	"time"
+
 	xdsapi "github.com/envoyproxy/go-control-plane/envoy/api/v2"
 	envoy_api_v2_core "github.com/envoyproxy/go-control-plane/envoy/api/v2/core"
 	ads "github.com/envoyproxy/go-control-plane/envoy/service/discovery/v2"
 	"github.com/gogo/protobuf/types"
 	"google.golang.org/grpc"
-	"log"
-	"strings"
-	"sync"
-	"time"
 )
 
 const (
@@ -268,7 +269,7 @@ func (client *AdsClient) reloadCds() {
 func NewAdsClient(adsServerURL string, adsServerSpiffeID string, secureConnect bool,
 	nodeID string, applicationName string, netscalerURL string,
 	netscalerUsername string, netscalerPassword string, netscalerVIP string,
-	netProfile string, analyticsServerIP string) (*AdsClient, error) {
+	netProfile string, analyticsServerIP string, logProxyURL string) (*AdsClient, error) {
 	var err error
 	adsClient := new(AdsClient)
 	adsClient.adsServerURL = adsServerURL
@@ -287,7 +288,7 @@ func NewAdsClient(adsServerURL string, adsServerSpiffeID string, secureConnect b
 	if len(s) > 1 {
 		adsServerPort = s[1]
 	}
-	adsClient.nsConfigAdaptor, err = newConfigAdaptor(netscalerURL, netscalerUsername, netscalerPassword, adsServerPort, netscalerVIP, netProfile, analyticsServerIP)
+	adsClient.nsConfigAdaptor, err = newConfigAdaptor(netscalerURL, netscalerUsername, netscalerPassword, adsServerPort, netscalerVIP, netProfile, analyticsServerIP, logProxyURL)
 	if err != nil {
 		return nil, err
 	}

adsclient/ads_client_test.go

@@ -21,15 +21,15 @@ import (
 
 func Test_StartClient(t *testing.T) {
 	t.Logf("ads StartClient with unreachable secure ads grpc server")
-	adsClient, err := NewAdsClient("loaclhost:15011", "", true, "ads_client_node_1", "test-app", env.GetNetscalerURL(), env.GetNetscalerUser(), env.GetNetscalerPassword(), "nsip", "", "")
+	adsClient, err := NewAdsClient("loaclhost:15011", "", true, "ads_client_node_1", "test-app", env.GetNetscalerURL(), env.GetNetscalerUser(), env.GetNetscalerPassword(), "nsip", "", "", "ns-logproxy.citrix-system")
 	if err != nil {
 		t.Errorf("newAdsClient failed with %v", err)
 	}
 	adsClient.StartClient()
 	time.Sleep(3 * time.Second)
 	adsClient.StopClient()
 	t.Logf("ads StartClient with unreachable insecure ads grpc server")
-	adsClient, err = NewAdsClient("localhost:15010", "", false, "ads_client_node_1", "test-app", env.GetNetscalerURL(), env.GetNetscalerUser(), env.GetNetscalerPassword(), "nsip", "", "")
+	adsClient, err = NewAdsClient("localhost:15010", "", false, "ads_client_node_1", "test-app", env.GetNetscalerURL(), env.GetNetscalerUser(), env.GetNetscalerPassword(), "nsip", "", "", "ns-logproxy.citrix-system")
 	if err != nil {
 		t.Errorf("newAdsClient failed with %v", err)
 	}