2020-06-24 22:39:17 +08:00
|
|
|
# Installation Guide
|
|
|
|
|
|
|
|
|
|
- [Installation Guide](#installation-guide)
|
|
|
|
|
- [Ambassador](#ambassador)
|
|
|
|
|
- [Ambassador Operator](#ambassador-operator)
|
|
|
|
|
- [Configuration](#configuration)
|
|
|
|
|
- [Ingress annotations](#ingress-annotations)
|
|
|
|
|
|
|
|
|
|
## Ambassador
|
|
|
|
|
|
|
|
|
|
The Ambassador API Gateway provides all the functionality of a traditional ingress controller
|
|
|
|
|
(e.g., path-based routing) while exposing many additional capabilities such as authentication,
|
|
|
|
|
URL rewriting, CORS, rate limiting, and automatic metrics collection.
|
|
|
|
|
|
|
|
|
|
## Ambassador Operator
|
|
|
|
|
|
|
|
|
|
This addon deploys the Ambassador Operator, which in turn will install Ambassador in
|
|
|
|
|
a kubespray cluster.
|
|
|
|
|
|
|
|
|
|
The Ambassador Operator is a Kubernetes Operator that controls Ambassador's complete lifecycle
|
|
|
|
|
in your cluster, automating many of the repeatable tasks you would otherwise have to perform
|
|
|
|
|
yourself. Once installed, the Operator will complete installations and seamlessly upgrade to new
|
|
|
|
|
versions of Ambassador as they become available.
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
|
|
2020-12-30 21:07:49 +08:00
|
|
|
- `ingress_ambassador_namespace` (default `ambassador`): namespace for installing Ambassador.
|
|
|
|
|
- `ingress_ambassador_update_window` (default `0 0 * * SUN`): _crontab_-like expression
|
2020-06-24 22:39:17 +08:00
|
|
|
for specifying when the Operator should try to update the Ambassador API Gateway.
|
2020-12-30 21:07:49 +08:00
|
|
|
- `ingress_ambassador_version` (defaulkt: `*`): SemVer rule for versions allowed for
|
2020-06-24 22:39:17 +08:00
|
|
|
installation/updates.
|
2021-04-22 15:22:31 +08:00
|
|
|
- `ingress_ambassador_multi_namespaces` (default `false`): By default, Ambassador will only
|
|
|
|
|
watch the `ingress_ambassador_namespace` namespace for `AmbassadorInstallation` CRD resources.
|
|
|
|
|
When set to `true`, this value will tell the Ambassador Operator to watch **all** namespaces
|
|
|
|
|
for CRDs. If you want to run multiple Ambassador ingress instances, set this to `true`.
|
2020-06-24 22:39:17 +08:00
|
|
|
|
|
|
|
|
## Ingress annotations
|
|
|
|
|
|
|
|
|
|
The Ambassador API Gateway will automatically load balance `Ingress` resources
|
|
|
|
|
that include the annotation `kubernetes.io/ingress.class=ambassador`. All the other
|
|
|
|
|
resources will be just ignored.
|
