boomerang-io/charts

Helm charts for Boomerang Projects

Boomerang Helm Charts

Helm charts for Boomerang-io projects ready to launch on Kubernetes using Helm.

All our charts are Helm v3 charts.

The containers are available on DockerHub

Available Charts

• Boomerang Bosun
• Boomerang Flow
• Boomerang oauth2-proxy (forked from oauth2-proxy)
• Boomerang Common (library chart for common template functions)

Pre-requisites

• Kubernetes 1.13+
• Helm v3

Plus any additional dependencies by chart. For example Boomerang Flow depends on MongoDB. Please read the individual charts READMEs.

Image Policies

If you are kubernetes cluster uses ClusterImagePolicy or ImagePolicy you may need to add docker.io/boomerangio/*:* to your policies to be able to retrieve the images.

Getting Started

To quickly get started, install into a kubernetes cluster of 1.13+ via Helm using the following commands

Step 1

Make sure you have the helm repository available

helm repo add boomerang-io https://raw.githubusercontent.com/boomerang-io/charts/index

Step 2

Install or upgrade the helm chart using the relevant helm commands and passing in any properties

helm install --namespace <namespace> --set database.mongodb.host=<service_name> --set database.mongodb.secretName=<mongodb_secret> boomerang-io/bmrg-bosun

Or Manually

Extract the values.yaml from the helm chart and update the values in detail

helm inspect values boomerang-io/bmrg-bosun > bmrg-bosun-values.yaml
vi bmrg-bosun-values.yaml
helm install --namespace <namespace> -f bmrg-bosun-values.yaml boomerang-io/bmrg-bosun

Repository Structure

This helm repository services dual purposes as both the source control of the raw charts, and also the helm repository.

The helm repository uses the tgz files from the repositories Releases but also the index.yaml in the index branch. This branch is protected and only used by the CICD system.

CICD

The CICD for this repository is currently using an instance of Boomerang CICD inside of IBM. This automation will package the charts and push them back to this repository as mentioned in the repositroy structure above.

charts's Issues

Updated Flow Chart README for MongoDB TLS

Changes

• Update the README with example kubectl command for generating the MongoDB TLS secret
• Update the example Secret file
• Update the Installation Docs

[bmrg-auth-proxy] Basic Auth - Incorrect redirection after sign in

Describe the bug
The user is redirected to / instead of the home path parameter set for that application

To Reproduce

1. Deploy bmrg-auth-proxy chart version 3.3.1 using basic auth
2. Deploy an application that is integrated with auth-proxy
3. Sign in

Expected behavior
The user should be redirected to the sign_in rd parameter instead of /

Screenshots
N/A

Environment (please complete the following information):

• OS: macOS
• Browser: firefox
• Version: 83.0

Additional context
N/A

Add hostAlias section to data loader in helm chart

Need to cater for hostAliases in data loader

#59

NGINX Ingress Controller 0.32.0

error message : could not build optimal proxy_headers_hash, you should increase either proxy_headers_hash_max_size: 512 or proxy_headers_hash_bucket_size: 64; ignoring proxy_headers_hash_bucket_size
nginx: [warn] could not build optimal proxy_headers_hash, you should increase either proxy_headers_hash_max_size: 512 or proxy_headers_hash_bucket_size: 64; ignoring proxy_headers_hash_bucket_size
2022/01/07 03:22:23 [warn] 967#967: could not build optimal proxy_headers_hash, you should increase either proxy_headers_hash_max_size: 512 or proxy_headers_hash_bucket_size: 64; ignoring proxy_headers_hash_bucket_size
nginx: [warn] could not build optimal proxy_headers_hash, you should increase either proxy_headers_hash_max_size: 512 or proxy_headers_hash_bucket_size: 64; ignoring proxy_headers_hash_bucket_size
2022/01/07 03:22:23 [emerg] 967#967: "proxy_cache" zone "authentication" is unknown in /tmp/nginx-cfg218567592:1259
nginx: [emerg] "proxy_cache" zone "authentication" is unknown in /tmp/nginx-cfg218567592:1259
nginx: configuration file /tmp/nginx-cfg218567592 test failed

I want to know which nginx-ingress-cotroller version can be installed successfully?
My environment:
kubernetes: v1.19.16
helm: 3.5.4
nginx-ingress-controller: 0.32.0

[bmrg-auth-proxy] Basic-auth configuration is failing, with 403 to the backend services

Describe the bug
Deploying the auth-proxy using basic authentication configuration fails in the application UI with 403 when invoking the backend services.

To Reproduce

1. Deploy the auth-proxy with basic configuration as per documentation
2. Secure an application with the auth-proxy instance
3. Invoke a secure page
4. Login with the configured credentials

Expected behavior
After step 4, the expectation is for the back-end services to respond.
Currently we get a 403 error for each back-end invocation.

Environment (please complete the following information):

• OS: [all]
• Browser [all]
• Version [3.1.10]

Additional context
NA

Helm Chart - Cannot install pointed to MongoDB secret from latest Bitnami mongodb chart

In the latest mongodb chart from Bitnami the mongodb secret no longer has a key of mongodb-password instead it has the key mongodb-passwords

This affects the chart when installing via secret ref

Add Instana support

[bmrg-auth-proxy] The documentation is not clear on the configuration for each IDP

Describe the bug
The auth-proxy chart needs to describe how to be configured for the various supported IDPs.

To Reproduce

NA

Expected behavior
A clear way in describing how to use the auth-proxy

Screenshots
If applicable, add screenshots to help explain your problem.

Environment (please complete the following information):

• OS: NA
• Browser NA
• Version [3.1.9]

Additional context
Add any other context about the problem here.

Add helper functions to support nodeSelector, affinity and tolerations

Is your request related to a problem? Please describe.
There is a need for helper functions to define nodeSelector, affinity and tolerations based on the release values.

Describe the solution you'd like
Create common helper functions that would define the 3 properties in the deployments.

Describe the benefits or justification for this request
Standard and useful functions.

Would help the users to have Jaeger multi-agent configuration

Is your request related to a problem? Please describe.
Offer support for multi Jaeger agent deployment.

Describe the solution you'd like
Define common helpers to support the deployment of a list of Jaeger agents as side-car to the business container. In addition configure the application.properties file to provide to the Jaeger framework the configuration data.

Describe the benefits or justification for this request

Additional context

Helm Chart - Loader job only references MongoDB Secret

Loader job only references MongoDB Secret and does not handle referencing internal secret if password specified

[auth-proxy]Param - --cookie-expire is hardcoded to 24h0m0s

Describe the bug
The parameter of auth-proxy for cookie expiration is hard coded to 24 hourrs, which breaks some implementations.

To Reproduce
Some automation team have JWT expiration problems.

Expected behavior
Allow the end-user to configure the cookie-expire, remove the default from the deployment.

Environment (please complete the following information):

• rtp4/dev

[bmrg-auth-proxy] Deploying 6.0.0-bmrg.5 image version fails due to email token missing

Describe the bug
Versrion 6.0.0 of auth-proxy comes with a configurable email token. It needs to be configured with the correct version in the helm chart.

To Reproduce
Deploy auth-proxy version 6.0.0-bmrg.5 with auth-proxy helm version v3.1.x and it will fail.

Environment (please complete the following information):

• OS: [NA]
• Browser [NA]
• Version [3.1.11]

Additional context
Add any other context about the problem here.

Add support for new core service: Metering

Is your request related to a problem? Please describe.
Add support for the metering service in bmrg-common for an easier integration with the metering framework.

Describe the solution you'd like
Add the metering option to the bmrg.core.services helper.

Describe the benefits or justification for this request
Ease of integration with the metering framework and also maintaining the same strategy as all the other core services.

Additional context

[bmrg-auth-proxy] Authentication fails when using basic-auth mode

Describe the bug
Authentication fails when auth.displayHtpasswdForm is set to true

To Reproduce

1. Install bmrg-auth-proxy chart using basic-auth
2. Install bmrg-bosun chart
3. Access bmrg-bosun's launchpad
4. Login using the configured basic-auth credentials

Actual result: authentication fails

Expected behavior
Authentication is successful when using basic-auth mode.

Screenshots

Additional context
deployment.yaml file contains an extra - (dash) at the end of the if statement line, thus, when the pod is created it will inherit the value inline (as seen in the screenshot above) and not as an auth.args list item.

[bmrg-auth-proxy] Update the container version to the correct one

Describe the bug
Update the default docker image in the chart to the latest Dockerhub one.

To Reproduce
NA

Expected behavior
The helm chart needs to have the correct public image version so it can be installed with minimal changes in the values.

Environment (please complete the following information):

• OS: [NA]
• Browser [NA]
• Version [3.1.9]

Additional context
Increase the chart version with the latest docker image available.

Helm chart incorrect references eventing.nats. instead of eventing.jetstream

Describe the bug
Helm chart may have incorrect references eventing.nats. instead of eventing.jetstream

To Reproduce

1. Look at the configmap in the Flow chart

Screenshots

Helm chart does not work with latest NGINX Ingress Controller and Kube 1.22+

Testing this in AKS 1.22+ with Ingress Controller 1.2.0

With Kube 1.22 and above, the kubernetes.io/ingress.class: annotation has been deprecated and replaced with .spec.ingressClassName which was introduced in 1.18 or 1.19

Additionally, in AKS (not sure if this holds true for elsewhere), as the annotation has been deprecated, you now need to put nginx in the ingress annotation prefix to make nginx.ingress.kubernetes.io