GithubHelp home page GithubHelp logo

apoorva-05 / citrix-k8s-node-controller Goto Github PK

View Code? Open in Web Editor NEW

This project forked from netscaler/netscaler-k8s-node-controller

0.0 0.0 0.0 10.43 MB

Integrates the hardware/virtualized Citrix ADC with the Kubernetes overlay / underlay

citrix-k8s-node-controller's Introduction

Build Status codecov License Go Report Card Docker Repository on Quay GitHub stars HitCount


Citrix k8s node controller

Citrix k8s node controller is a micro service provided by Citrix that creates network between the Kubernetes cluster and ingress device.

Contents

Overview

In Kubernetes environments, when you expose the services for external access through the Ingress device, to route the traffic into the cluster, you need to appropriately configure the network between the Kubernetes nodes and the Ingress device. Configuring the network is challenging as the pods use private IP addresses based on the CNI framework. Without proper network configuration, the Ingress device cannot access these private IP addresses. Also, manually configuring the network to ensure such reachability is cumbersome in Kubernetes environments.

Citrix provides a microservice called as Citrix k8s node controller that you can use to create the network between the cluster and the Ingress device.

Architecture

The following diagram provides the high-level architecture of the Citrix k8s node controller:

The are the main components of the Citrix k8s node controller:

Ingress Interface The Ingress interface component is responsible for the interaction with Citrix ADC through NITRO REST API. It maintains the NITRO sessions and invokes it when required.
K8s Interface This K8s Interface component interacts with the Kube API server through K8s Go client. It ensures the availability of the client and maintains a healthy client session.
Input Feeder The Input Feeder component provides inputs to the config decider. Some of the inputs are auto detected and the rest are taken from the Citrix k8s node controller deployment YAML file.
Core The Core component interacts with the node watcher and updates the corresponding config engine. It is responsible for starting the best config engine for the corresponding cluster.
Config Maps The Config Maps component controls the Citrix k8s node controller. It allows you to define Citrix k8s node controller to automatically create, apply, and delete routing configuration on Citrix ADC.

How it works

Citrix k8s node controller monitors the node events and establishes a route between the node to Citrix ADC using VXLAN. Citrix k8s node controller adds route on the Citrix ADC when a new node joins to the cluster. Similarly when a node leaves the cluster, Citrix k8s node controller removes the associated route from the Citrix ADC. Citrix k8s node controller uses VXLAN overlay between the Kubernetes cluster and Citrix ADC for service routing.

Get started

You can run Citrix k8s node controller as a microservice inside the Kubernetes cluser. Refer the deployment page for running Citrix k8s node controller as a microservice inside the Kubernetes cluster.

Supported CNIs

  • flannel
  • calico (Vxlan/IPIP modes)
  • cilium
  • weave
  • canal

TroubleShoot

After deploying CNC, in case of any issue, refer the troubleshooting page

Questions

For questions and support the following channels are available:

Issues

Describe the Issue in Details, Collects the logs and Use the discussion forum to raise the issue.

Code of conduct

This project adheres to the Kubernetes Community Code of Conduct. By participating in this project you agree to abide by its terms.

License

Apache License 2.0

citrix-k8s-node-controller's People

Contributors

apoorva-05 avatar aroraharsh23 avatar asparshk avatar chorusio avatar janraj avatar janrajc avatar nirmalkn avatar subashd avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.