Skip to content

Commit

Permalink
fix: corrects PACT_BROKER_BASE_URL typo (#69)
Browse files Browse the repository at this point in the history
* fix: corrects PACT_BROKER_BASE_URL typo

Signed-off-by: ChrisJBurns <29541485+ChrisJBurns@users.noreply.github.com>

---------

Signed-off-by: ChrisJBurns <29541485+ChrisJBurns@users.noreply.github.com>
  • Loading branch information
ChrisJBurns authored Oct 19, 2023
1 parent 0be9ce2 commit 6e2b300
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 11 deletions.
2 changes: 1 addition & 1 deletion charts/pact-broker/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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.0
version: 1.0.1
appVersion: 2.107.1
dependencies:
- condition: postgresql.enabled
Expand Down
8 changes: 4 additions & 4 deletions charts/pact-broker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pact-broker

![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.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)
![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)

The Pact Broker is an application for sharing for Pact contracts and verification results.

Expand Down Expand Up @@ -51,8 +51,8 @@ helm upgrade -i <release_name> oci://ghcr.io/pact-foundation/pact-broker-chart/p

| Repository | Name | Version |
|------------|------|---------|
| https://charts.bitnami.com/bitnami | common | 1.x.x |
| https://charts.bitnami.com/bitnami | postgresql | 11.x.x |
| oci://registry-1.docker.io/bitnamicharts | common | 2.11.1 |
| oci://registry-1.docker.io/bitnamicharts | postgresql | 12.11.2 |

## Values

Expand All @@ -66,7 +66,7 @@ helm upgrade -i <release_name> 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.baseUrls | Base URLs can be configured for architectures that use gateways or proxies that allow the same Pact Broker instance to be addressed with different base URLs. 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 | 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` |
Expand Down
6 changes: 3 additions & 3 deletions charts/pact-broker/templates/deployment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,9 @@ spec:
# Resources
- name: PACT_BROKER_PORT
value: {{ .Values.broker.containerPorts.http | quote }}
{{- if .Values.broker.config.baseUrls }}
- name: PACT_BROKER_BASE_URLS
value: {{ .Values.broker.config.baseUrls | quote }}
{{- if .Values.broker.config.baseUrl }}
- name: PACT_BROKER_BASE_URL
value: {{ .Values.broker.config.baseUrl | quote }}
{{- end }}
- name: PACT_BROKER_SHIELDS_IO_BASE_URL
value: {{ .Values.broker.config.shieldsIoBaseUrl | quote }}
Expand Down
8 changes: 5 additions & 3 deletions charts/pact-broker/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -207,10 +207,12 @@ broker:
# -- If set to true, SSL verification will be disabled for the HTTP requests made by the webhooks
disable_ssl: false

# -- Base URLs can be configured for architectures that use gateways or proxies that allow the same Pact Broker instance to be addressed with different base URLs.
# -- 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
baseUrls:
# 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.
baseUrl:

# -- The URL of the shields.io server used to generate the README badges.
shieldsIoBaseUrl: https://img.shields.io
Expand Down

0 comments on commit 6e2b300

Please sign in to comment.