From f0b5f037fa118816f911b57a6255e4485f2b3812 Mon Sep 17 00:00:00 2001 From: shanehull Date: Thu, 22 Aug 2024 14:28:41 +1000 Subject: [PATCH] feat: ability to set svc annotations --- charts/pact-broker/Chart.yaml | 2 +- charts/pact-broker/README.md | 5 +++-- charts/pact-broker/templates/service.yaml | 7 +++++++ charts/pact-broker/values.yaml | 3 +++ 4 files changed, 14 insertions(+), 3 deletions(-) diff --git a/charts/pact-broker/Chart.yaml b/charts/pact-broker/Chart.yaml index 0092758..f47c97d 100644 --- a/charts/pact-broker/Chart.yaml +++ b/charts/pact-broker/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 name: pact-broker description: The Pact Broker is an application for sharing for Pact contracts and verification results. type: application -version: 1.0.1 +version: 1.1.0 appVersion: 2.107.1 dependencies: - condition: postgresql.enabled diff --git a/charts/pact-broker/README.md b/charts/pact-broker/README.md index 3459c62..03242f9 100644 --- a/charts/pact-broker/README.md +++ b/charts/pact-broker/README.md @@ -1,6 +1,6 @@ # pact-broker -![Version: 1.0.1](https://img.shields.io/badge/Version-1.0.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.107.1](https://img.shields.io/badge/AppVersion-2.107.1-informational?style=flat-square) +![Version: 1.1.0](https://img.shields.io/badge/Version-1.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.107.1](https://img.shields.io/badge/AppVersion-2.107.1-informational?style=flat-square) The Pact Broker is an application for sharing for Pact contracts and verification results. @@ -66,7 +66,7 @@ helm upgrade -i oci://ghcr.io/pact-foundation/pact-broker-chart/p | broker.config.autoMigrateDb | Whether or not to run the database schema migrations on start up. It is recommended to set this to true. | bool | `true` | | broker.config.autoMigrateDbData | Whether or not to run the database data migrations on start up. It is recommended to set this to true. | bool | `true` | | broker.config.badgeProviderMode | The method by which the badges are generated. Allowed values: redirect, proxy | string | `"redirect"` | -| broker.config.baseUrl | Base URL can be configured for architectures that use gateways or proxies that allow the same Pact Broker instance to be addressed with a different base URL. The application may run correctly without this attribute, however, it is strongly recommended to set it when deploying the Pact Broker to production as it prevents cache poisoning security vulnerabilities. If you find that the URLs generated by the API are using an IP instead of a hostname, you can set this environment variable to force the desired base URL. Must include the port if it's a non-standard one. eg. https://my-broker:9292. Is not currently used for links in the UI. | string | `nil` | +| broker.config.baseUrl | Base URL can be configured for architectures that use gateways or proxies that allow the same Pact Broker instance to be addressed with a different base URL. The application may run correctly without this attribute, however, it is strongly recommended to set it when deploying the Pact Broker to production as it prevents cache poisoning security vulnerabilities. If you find that the URLs generated by the API are using an IP instead of a hostname, you can set this environment variable to force the desired base URL. Must include the port if it's a non-standard one. eg. https://my-broker:9292. Is not currently used for links in the UI. | string | `nil` | | broker.config.basicAuth.allowPublicRead | Set to true if you want public read access, but still require credentials for writing. | bool | `false` | | broker.config.basicAuth.enablePublicBadgeAccess | Set this to true to allow status badges to be embedded in README files without requiring a hardcoded password. | bool | `false` | | broker.config.basicAuth.enabled | Set to true if you basic authentication to be enabled | bool | `false` | @@ -178,6 +178,7 @@ helm upgrade -i oci://ghcr.io/pact-foundation/pact-broker-chart/p | postgresql.auth.secretKeys.userPasswordKey | The key in which Postgres well look for, for the user password, in the existing Secret | string | `"user-password"` | | postgresql.auth.username | Name for a custom user to create | string | `"bn_broker"` | | postgresql.enabled | Switch to enable or disable the PostgreSQL helm chart | bool | `true` | +| service.annotations | service.annotations Additional annotations for the Service resource | object | `{}` | | service.clusterIP | Pact Broker service clusterIP | string | `""` | | service.loadBalancerIP | Pact Broker Service [loadBalancerIP](https://kubernetes.io/docs/user-guide/services/#type-loadbalancer) | string | `""` | | service.nodePorts.http | http nodePort | string | `""` | diff --git a/charts/pact-broker/templates/service.yaml b/charts/pact-broker/templates/service.yaml index 3f3cdbd..fca7971 100644 --- a/charts/pact-broker/templates/service.yaml +++ b/charts/pact-broker/templates/service.yaml @@ -9,6 +9,13 @@ metadata: helm.sh/chart: {{ .Chart.Name }} app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/managed-by: {{ .Release.Service }} + annotations: + {{- if .Values.service.annotations }} + {{- include "common.tplvalues.render" ( dict "value" .Values.service.annotations "context" $) | nindent 4 }} + {{- end }} + {{- if .Values.commonAnnotations }} + {{- include "common.tplvalues.render" ( dict "value" .Values.commonAnnotations "context" $ ) | nindent 4 }} + {{- end }} spec: type: {{ .Values.service.type }} {{- if and .Values.service.clusterIP (eq .Values.service.type "ClusterIP") }} diff --git a/charts/pact-broker/values.yaml b/charts/pact-broker/values.yaml index d1f3a00..3e1976f 100644 --- a/charts/pact-broker/values.yaml +++ b/charts/pact-broker/values.yaml @@ -380,6 +380,9 @@ service: # type: "ClusterIP" + # -- service.annotations Additional annotations for the Service resource + annotations: {} + # Service port configuration ports: