Git Product home page Git Product logo

envoy-operator's Introduction

Envoy operator

The Envoy Operator project is a Kubernetes Operator. Its purpose is to enable easy deployment of Envoy proxies using a high level declarative API.

The Envoy Operator currently supports deploying proxies as standalone pods, but will soon support injecting Envoy proxies as sidecar containers into existing pods to serve as transparent proxies for use in a service mesh such as Istio.

The Envoy Operator was built using the operator sdk.

Quick usage

Deploy the Operator:

kubectl create -f https://raw.githubusercontent.com/solo-io/envoy-operator/master/deploy/rbac.yaml
kubectl create -f https://raw.githubusercontent.com/solo-io/envoy-operator/master/deploy/crd.yaml
kubectl create -f https://raw.githubusercontent.com/solo-io/envoy-operator/master/deploy/operator.yaml

Create an Envoy pod configured to use ads-service.default.svc.cluster.local as its xDS server:

cat <<EOF | kubectl create -f -
apiVersion: "envoy.solo.io/v1alpha1"
kind: "Envoy"
metadata:
  name: "myingress"
spec:
  adsServer: ads-service.default.svc.cluster.local
  adsPort: 8081
  clusterIdTemplate: ingress
  nodeIdTemplate: "ingress-{{.PodName}}"
EOF

How does it work?

The operator transforms the Envoy spec defined here to a deployment and a configmap that contains Envoy's static config file.

Note that some of the parameters are templates. these templates can be filled with the kube downward api. Example:

apiVersion: "envoy.solo.io/v1alpha1"
kind: "Envoy"
metadata:
  name: "myingress"
spec:
  ...
  nodeIdTemplate: "{{.PodName}}"

The node id given to each Envoy will match its pod name.

The full template interpolation interface is defined here and should cover all of the downward API (labels and annotations included).

Use cases

This operator's main uses case is with an ADS-enabled xDS server such as Gloo. We are looking to hear more from the community about what other uses cases are of interest.

Road Map

  • SSL \ mTLS configuration
  • Pod Injection
  • Provide Locality information for zone aware routing.
  • Hot Restarts

Help

Please join us on our slack channel https://slack.solo.io/ with any questions, feedback, or suggestions.

envoy-operator's People

Contributors

arianaw66 avatar eitanya avatar ilackarms avatar ilevine avatar yuval-k avatar

Watchers

 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.