From 3af68322bbd252e1bade8f2929692045273b0e26 Mon Sep 17 00:00:00 2001 From: Flynn Date: Thu, 14 Feb 2019 10:43:05 -0500 Subject: [PATCH] Update Ambassador default replicas and fix README Markdown (#11398) * Restore default replicas == 3 Signed-off-by: Flynn * Fix some markdown Signed-off-by: Flynn * Bump chart version, and switch my name to Flynn. :) Signed-off-by: Flynn * Add icon. Signed-off-by: Flynn --- stable/ambassador/Chart.yaml | 5 ++-- stable/ambassador/README.md | 45 +++++++++++++++++++---------------- stable/ambassador/values.yaml | 2 +- 3 files changed, 28 insertions(+), 24 deletions(-) diff --git a/stable/ambassador/Chart.yaml b/stable/ambassador/Chart.yaml index e35c8bc38b..8f16908616 100644 --- a/stable/ambassador/Chart.yaml +++ b/stable/ambassador/Chart.yaml @@ -2,7 +2,8 @@ apiVersion: v1 appVersion: 0.50.1 description: A Helm chart for Datawire Ambassador name: ambassador -version: 1.1.0 +version: 1.1.1 +icon: https://www.getambassador.io/images/logo.png home: https://www.getambassador.io/ sources: - https://github.com/datawire/ambassador @@ -15,6 +16,6 @@ keywords: maintainers: - name: flydiverny email: markus@maga.se - - name: kflynn + - name: Flynn email: flynn@datawire.io engine: gotpl diff --git a/stable/ambassador/README.md b/stable/ambassador/README.md index a4f188882e..112e8b8459 100755 --- a/stable/ambassador/README.md +++ b/stable/ambassador/README.md @@ -62,12 +62,11 @@ The following tables lists the configurable parameters of the Ambassador chart a | `prometheusExporter.repository` | Prometheus exporter image | `prom/statsd-exporter` | | `prometheusExporter.tag` | Prometheus exporter image | `v0.8.1` | | `rbac.create` | If `true`, create and use RBAC resources | `true` | -| `rbac.namespaced` | If `true`, permissions are namespace-scoped rather than cluster-scoped | `false` | - -| `replicaCount` | Number of Ambassador replicas | `1` | +| `rbac.namespaced` | If `true`, permissions are namespace-scoped rather than cluster-scoped | `false` | +| `replicaCount` | Number of Ambassador replicas | `3` | | `resources` | CPU/memory resource requests/limits | `{}` | -| `securityContext` | Set security context for pod | `{ "runAsUser": "8888" }` | -| `service.annotations` | Annotations to apply to Ambassador service | `{"getambassador.io/config":"---\napiVersion: ambassador/v1\nkind: Module\nname: ambassador\nconfig:\n service_port: 8080"}` | +| `securityContext` | Set security context for pod | `{ "runAsUser": "8888" }` | +| `service.annotations` | Annotations to apply to Ambassador service | See "Annotations" below | | `service.externalTrafficPolicy` | Sets the external traffic policy for the service | `""` | | `service.http.enabled` | if port 80 should be opened for service | `true` | | `service.http.nodePort` | If explicit NodePort is required | None | @@ -85,28 +84,32 @@ The following tables lists the configurable parameters of the Ambassador chart a | `volumeMounts` | Volume mounts for the ambassador service | `[]` | | `volumes` | Volumes for the ambassador service | `[]` | + **NOTE:** Make sure the configured `service.http.targetPort` and `service.https.targetPort` ports match your [Ambassador Module's](https://www.getambassador.io/reference/modules/#the-ambassador-module) `service_port` and `redirect_cleartext_from` configurations. -If you intend to use `service.annotations`, remember to include the annotation key, for example: +### Annotations + +The default annotation applied to the Ambassador service is ``` -service: - type: LoadBalancer - - http: - port: 80 - targetPort: 8080 - - annotations: - getambassador.io/config: | - --- - apiVersion: ambassador/v1 - kind: Module - name: ambassador - config: - redirect_cleartext_from: 8080 +getambassador.io/config: | + --- + apiVersion: ambassador/v1 + kind: Module + name: ambassador + config: + service_port: 8080 ``` +If you intend to use `service.annotations`, remember to include the `getambassador.io/config` annotation key as above, +and remember that you'll have to escape newlines. For example, the annotation above could be defined as + +``` +service.annotations: { "getambassador.io/config": "---\napiVersion: ambassador/v1\nkind: Module\nname: ambassador\nconfig:\n service_port: 8080" } +``` + +### Specifying Values + Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, ```console diff --git a/stable/ambassador/values.yaml b/stable/ambassador/values.yaml index e9c1f1a1d8..c85cc6f7bf 100644 --- a/stable/ambassador/values.yaml +++ b/stable/ambassador/values.yaml @@ -2,7 +2,7 @@ # This is a YAML-formatted file. # Declare variables to be passed into your templates. -replicaCount: 1 +replicaCount: 3 daemonSet: false ambassador: