https://github.com/netscaler/netscaler-xds-adaptor
citrix-xds-adaptor
https://github.com/netscaler/netscaler-xds-adaptor
citrix citrix-adc-cpx citrix-adc-proxies citrix-istio-adaptor citrix-netscaler citrix-xds-adaptor egress-gateway ingress-gateway istio istio-ingress-gateway k8s kubernetes netscaler service-mesh servicemesh sidecar sidecar-proxy xds xds-api
Last synced: about 2 months ago
JSON representation
citrix-xds-adaptor
- Host: GitHub
- URL: https://github.com/netscaler/netscaler-xds-adaptor
- Owner: netscaler
- Created: 2019-07-17T14:36:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-25T22:02:34.000Z (almost 2 years ago)
- Last Synced: 2025-04-08T10:11:12.397Z (6 months ago)
- Topics: citrix, citrix-adc-cpx, citrix-adc-proxies, citrix-istio-adaptor, citrix-netscaler, citrix-xds-adaptor, egress-gateway, ingress-gateway, istio, istio-ingress-gateway, k8s, kubernetes, netscaler, service-mesh, servicemesh, sidecar, sidecar-proxy, xds, xds-api
- Language: Go
- Homepage: https://github.com/citrix/citrix-xds-adaptor
- Size: 12.4 MB
- Stars: 81
- Watchers: 16
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: license/LICENSE
Awesome Lists containing this project
README
# Citrix ADC integration with xDS-based service mesh
[](https://quay.io/repository/citrix/citrix-istio-adaptor)
[](./license/LICENSE)
[](https://github.com/citrix/citrix-istio-adaptor/issues)
[](https://github.com/citrix/citrix-istio-adaptor/stargazers)
[](http://hits.dwyl.io/citrix/citrix-istio-adaptor)
---
## Description
This repository contains an integration of [Citrix ADC](https://www.citrix.com/products/citrix-adc/platforms.html) with the [xDS-API](https://github.com/envoyproxy/data-plane-api) based service mesh.
# Table of contents
1. [Introduction](#introduction)
5. [Features](#features)
7. [Blogs](#blogs)
8. [Release Notes](#release-notes)
9. [Contributions](#contributions)
10. [Questions](#questions)
11. [Issues](#issues)
12. [Code of Conduct](#code-of-conduct)
13. [Licensing](#licensing)
## Introduction
A service mesh is an infrastructure layer that manages communication between microservices. It provides capabilities such as service discovery, load balancing, security, and monitoring. A service mesh helps to connect, monitor, and secure microservices. [Citrix ADC](https://www.citrix.com/products/citrix-adc/platforms.html) has advanced traffic management capabilities for enhancing application performance and it provides comprehensive security. Citrix ADC integration with service meshes allows you to secure and optimize the traffic for applications in a service mesh using Citrix ADC features.
The `xDS-adaptor` is a container provided by Citrix for integrating Citrix ADC with service mesh control plane implementations based on xDS APIs (Istio, Consul, and so on). It communicates with the service mesh control plane and listens for updates by acting as a gRPC client to the control plane API server. Based on the updates from the control plane, the xDS-Adaptor generates the equivalent Citrix ADC configuration.
## Citrix ADC integration with Istio
Citrix ADC integration with Istio allows you to secure and optimize traffic for applications in the service mesh using the Citrix ADC features.
For more information on how to integrate Citrix ADC with Istio, see [Citrix ADC integration with Istio](./docs/istio-integration/README.md).
## Features
The features which are supported on a Citrix ADC in a service mesh can be broadly categorized into the following:
- Traffic management
- Security
- Observability
### Traffic management
Citrix ADC supports the following traffic management features in a service mesh.
- Service discovery
- Load balancing
- Secure ingress
- Weighted clusters
- HTTP rewrite
- HTTP redirect
### Security
Some important security features, which are supported on the Citrix ADC, are the following:
- Authentication policy
- Monitoring of service mesh certificates and keys
#### Authentication policy
- Transport authentication or service-to-service authentication using mutual TLS.
#### Monitoring of service mesh certificates and keys
The `xDS-adaptor` monitors the folder where a service mesh deploys certificates and keys for mutual TLS authentication between Citrix ADC proxies. After an update of certificate and key, the `xDS-adaptor` loads the new certificate and key to the Citrix ADC.
### Observability
When a service is deployed in a service mesh, users may be interested to get insights about the service behavior. Citrix ADC proxy provides a rich set of in-built metrics to provide insights about the service behavior. When Citrix ADC CPX is deployed as a sidecar, these metrics represent the telemetry data for an application. It helps to reduce the burden of application developers by eliminating the need to include a lot of instrumentation code in the application. Instead, the developer can focus on the core application logic.
Citrix has built a couple of auxiliary tools such as [Citrix ADC Metrics Exporter](https://github.com/citrix/citrix-adc-metrics-exporter) and [Citrix ADC Observability Exporter](https://github.com/citrix/citrix-observability-exporter) which help to export metrics and transactional data to observability tools such as Prometheus, Zipkin, Kafka, and so on.
The statistical data of a Citrix ADC ingress device can be exported to the Prometheus using [Citrix ADC Metrics Exporter](https://github.com/citrix/citrix-adc-metrics-exporter).
[Citrix ADC Observability Exporter](https://github.com/citrix/citrix-observability-exporter) is a microservice designed to collect metrics from Citrix ADCs, and export them to observability tools such as Zipkin, Kafka, and Prometheus.
For more information about Citrix ADC Observability Exporter, see this [link](https://github.com/citrix/citrix-observability-exporter).
## Blogs
Following is a list of blogs which explains the integration of Citrix ADC with service mesh.
- [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/)
- [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/)
- [Citrix ADC in OpenShift Service Mesh](https://blog.openshift.com/citrix-adc-in-openshift-service-mesh/)
- [Traffic Mirroring: Risk-free app upgrades in Istio with Citrix ADC](https://www.citrix.com/blogs/2020/04/29/traffic-mirroring-risk-free-app-upgrades-in-istio-with-citrix-adc/)
- [End-user authentication in an Istio service mesh with Citrix](https://www.citrix.com/blogs/2020/03/19/end-user-authentication-in-istio-service-mesh-with-citrix/)
- [Outlier detection using Citrix ADC in Istio service mesh](https://www.citrix.com/blogs/2020/07/15/outlier-detection-using-citrix-adc-in-istio-service-mesh/)
Click [here](docs/release-notes.md) for the release notes of the latest Citrix ADC `xDS-adaptor`.
Contributions are always welcome! Read the [Developer Guide](docs/developer-guide.md).
## Questions
For questions and support, the following channels are available:
- [Citrix Discussion Forum](https://discussions.citrix.com/)
- [Citrix ADC CPX Slack Channel](https://citrixadccloudnative.slack.com/)
To request an invitation to participate in the Slack channel, provide your email address using this form: [https://podio.com/webforms/22979270/1633242](https://podio.com/webforms/22979270/1633242)
## Issues
Report issues in detail. You can use the following command to collect the logs:
Get Logs: kubectl logs -c xds-adaptor -n > log_file
This project adheres to the [Kubernetes Community Code of Conduct](https://github.com/kubernetes/community/blob/master/code-of-conduct.md). By participating in this project, you agree to abide by its terms.
## Licensing
The Citrix ADC `xDS-adaptor` is licensed with [Apache License 2.0](license/LICENSE)