The highest tagged major version is
README
¶
Ambassador 
Ambassador is an open source Kubernetes-native API Gateway built on Envoy, designed for microservices. Ambassador serves as an Envoy-based ingress controller, but with many more features.
Key features include:
- Self-service configuration, via Kubernetes CRDs or annotations
- Support for gRPC and HTTP/2, TCP, and WebSockets
- Support for CORS, timeouts, weighted round robin (canary), sticky sessions, rate limiting
- Consul, Linkerd, and Istio service mesh integration
- Authentication
- Robust TLS support, including TLS client-certificate authentication and SNI
- Knative serverless integration
- Comprehensive metrics support
Architecture
Ambassador deploys the Envoy Proxy for L7 traffic management. Configuration of Ambassador is via Kubernetes annotations. Ambassador relies on Kubernetes for scaling and resilience. For more on Ambassador's architecture and motivation, read this blog post.
Getting Started
You can get Ambassador up and running in less than a minute by running it locally with Docker. Follow the instructions here: https://www.getambassador.io#get-started.
For production usage, Ambassador runs in Kubernetes. For a Kubernetes deployment, follow the instructions at https://www.getambassador.io/user-guide/getting-started.
If you are looking for a Kubernetes ingress controller, Ambassador provides a superset of the functionality of a typical ingress controller. (It does the traditional routing, and layers on a raft of configuration options.) This blog post covers Kubernetes ingress.
You can also use Helm to install Ambassador. For more information, see the instructions in the Helm installation documentation.
Community
Ambassador is an open source project, and welcomes any and all contributors. To get started:
- Join our Slack channel
- Read the developer guide
- Check out the Ambassador documentation
If you're interested in contributing, here are some ways:
- Write a blog post for our blog
- Investigate an open issue
- Add more tests
The Ambassador Edge Stack is a superset of the Ambassador API Gateway that provides additional functionality including OAuth/OpenID Connect, advanced rate limiting, Swagger/OpenAPI support, integrated ACME support for automatic TLS certificate management, and a UI. For more information, visit https://www.getambassador.io/editions/.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
ambassador
Ambassador combines the various Golang binaries used in the Ambassador container, dispatching on os.Args[0] like BusyBox.
|
Ambassador combines the various Golang binaries used in the Ambassador container, dispatching on os.Args[0] like BusyBox. |
|
internal
|
|
|
pkg
|
|
|
dexec
nolint Package dexec is a logging variant of os/exec.
|
nolint Package dexec is a logging variant of os/exec. |
|
dlog
Package dlog implements a generic logger facade.
|
Package dlog implements a generic logger facade. |
|
envoy-control-plane/cache
Package cache defines a configuration cache for the server.
|
Package cache defines a configuration cache for the server. |
|
envoy-control-plane/conversion
Package conversion contains shared utility functions for converting xDS resources.
|
Package conversion contains shared utility functions for converting xDS resources. |
|
envoy-control-plane/log
Package log provides a logging interface for use in this library.
|
Package log provides a logging interface for use in this library. |
|
envoy-control-plane/server
Package server provides an implementation of a streaming xDS server.
|
Package server provides an implementation of a streaming xDS server. |
|
envoy-control-plane/test
Package test contains test utilities
|
Package test contains test utilities |
|
envoy-control-plane/test/main
Package main contains the test driver for testing xDS manually.
|
Package main contains the test driver for testing xDS manually. |
|
envoy-control-plane/test/resource
Package resource creates test xDS resources
|
Package resource creates test xDS resources |
|
envoy-control-plane/wellknown
Package wellknown contains common names for filters, listeners, etc.
|
Package wellknown contains common names for filters, listeners, etc. |
|
k8s
Package k8s is a facade over (super-terrible, very difficult to understand) client-go to provide a higher-level interface to Kubernetes, with support for simple, high-level APIs for watching resources (including from stable, long-running processes) and implementing basic controllers.
|
Package k8s is a facade over (super-terrible, very difficult to understand) client-go to provide a higher-level interface to Kubernetes, with support for simple, high-level APIs for watching resources (including from stable, long-running processes) and implementing basic controllers. |
|
metriton
Package metriton implements submitting telemetry data to the Metriton database.
|
Package metriton implements submitting telemetry data to the Metriton database. |