From 8e7885b65b2b60cb8d3479426f5859d17a79130c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?B=E1=B4=87=CA=80=C9=B4=E1=B4=85=20S=E1=B4=84=CA=9C?= =?UTF-8?q?=E1=B4=8F=CA=80=C9=A2=E1=B4=87=CA=80s?= Date: Fri, 24 Dec 2021 11:08:05 +0100 Subject: [PATCH] [focalboard] Add serviceLinks docs (#1324) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs --- charts/stable/focalboard/Chart.yaml | 2 +- charts/stable/focalboard/README.md | 17 +++++++++++++++-- .../focalboard/README_CHANGELOG.md.gotmpl | 8 ++++++++ .../stable/focalboard/README_CONFIG.md.gotmpl | 7 ++++++- 4 files changed, 30 insertions(+), 4 deletions(-) diff --git a/charts/stable/focalboard/Chart.yaml b/charts/stable/focalboard/Chart.yaml index 5229a742..608d6577 100644 --- a/charts/stable/focalboard/Chart.yaml +++ b/charts/stable/focalboard/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v2 appVersion: 0.9.0 description: Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana. name: focalboard -version: 4.1.0 +version: 4.1.1 kubeVersion: ">=1.16.0-0" keywords: - focalboard diff --git a/charts/stable/focalboard/README.md b/charts/stable/focalboard/README.md index c7c7b22a..73399c3b 100644 --- a/charts/stable/focalboard/README.md +++ b/charts/stable/focalboard/README.md @@ -1,6 +1,6 @@ # focalboard -![Version: 4.1.0](https://img.shields.io/badge/Version-4.1.0-informational?style=flat-square) ![AppVersion: 0.9.0](https://img.shields.io/badge/AppVersion-0.9.0-informational?style=flat-square) +![Version: 4.1.1](https://img.shields.io/badge/Version-4.1.1-informational?style=flat-square) ![AppVersion: 0.9.0](https://img.shields.io/badge/AppVersion-0.9.0-informational?style=flat-square) Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana. @@ -69,7 +69,12 @@ helm install focalboard k8s-at-home/focalboard -f values.yaml ## Custom configuration -N/A +By default Kubernetes will create several environment variables called service links (see [here](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) for more information). + +Focalboard can be configured with environment variables, so when you deploy this Helm release with a name of `focalboard`, +these service links will conflict with the application. + +In order to prevent this, you can disable the creation of these service links by setting `enableServiceLinks: false` in your `values.yaml. ## Values @@ -92,6 +97,12 @@ All notable changes to this application Helm chart will be documented in this fi The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [4.1.1] + +#### Changed + +- Added information about disablin serviceLinks to the documentation. + ### [4.0.0] #### Changed @@ -132,6 +143,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - First version of the helm chart for Focalboard +[4.1.1]: #411 +[4.0.0]: #400 [3.0.0]: #300 [2.0.0]: #200 [1.0.2]: #102 diff --git a/charts/stable/focalboard/README_CHANGELOG.md.gotmpl b/charts/stable/focalboard/README_CHANGELOG.md.gotmpl index 960110d9..d51b4c9c 100644 --- a/charts/stable/focalboard/README_CHANGELOG.md.gotmpl +++ b/charts/stable/focalboard/README_CHANGELOG.md.gotmpl @@ -9,6 +9,12 @@ All notable changes to this application Helm chart will be documented in this fi The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +### [4.1.1] + +#### Changed + +- Added information about disablin serviceLinks to the documentation. + ### [4.0.0] #### Changed @@ -50,6 +56,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - First version of the helm chart for Focalboard +[4.1.1]: #411 +[4.0.0]: #400 [3.0.0]: #300 [2.0.0]: #200 [1.0.2]: #102 diff --git a/charts/stable/focalboard/README_CONFIG.md.gotmpl b/charts/stable/focalboard/README_CONFIG.md.gotmpl index e93d80bf..d7ac8296 100644 --- a/charts/stable/focalboard/README_CONFIG.md.gotmpl +++ b/charts/stable/focalboard/README_CONFIG.md.gotmpl @@ -5,5 +5,10 @@ {{- define "custom.custom.configuration" -}} {{ template "custom.custom.configuration.header" . }} -N/A +By default Kubernetes will create several environment variables called service links (see [here](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/#accessing-the-service) for more information). + +Focalboard can be configured with environment variables, so when you deploy this Helm release with a name of `focalboard`, +these service links will conflict with the application. + +In order to prevent this, you can disable the creation of these service links by setting `enableServiceLinks: false` in your `values.yaml. {{- end -}}