The Bitnami Library for Kubernetes

Popular applications, provided by Bitnami, ready to launch on Kubernetes using Kubernetes Helm.

Looking to use our applications in production? Try VMware Tanzu Application Catalog, the enterprise edition of Bitnami Application Catalog.

TL;DR

helm install my-release oci://registry-1.docker.io/bitnamicharts/<chart>

Vulnerabilities scanner

Each Helm chart contains one or more containers. Those containers use images provided by Bitnami through its test & release pipeline and whose source code can be found at bitnami/containers.

As part of the container releases, the images are scanned for vulnerabilities, here you can find more info about this topic.

Since the container image is an immutable artifact that is already analyzed, as part of the Helm chart release process we are not looking for vulnerabilities in the containers but running different verifications to ensure the Helm charts work as expected, see the testing strategy defined at TESTING.md.

Before you begin

Prerequisites

Kubernetes 1.23+
Helm 3.8.0+

Setup a Kubernetes Cluster

The quickest way to set up a Kubernetes cluster to install Bitnami Charts is by following the "Bitnami Get Started" guides for the different services:

For setting up Kubernetes on other cloud platforms or bare-metal servers refer to the Kubernetes getting started guide.

Install Helm

Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.

To install Helm, refer to the Helm install guide and ensure that the helm binary is in the PATH of your shell.

Using Helm

Once you have installed the Helm client, you can deploy a Bitnami Helm Chart into a Kubernetes cluster.

Please refer to the Quick Start guide if you wish to get running in just a few commands, otherwise, the Using Helm Guide provides detailed instructions on how to use the Helm client to manage packages on your Kubernetes cluster.

Useful Helm Client Commands:

Install a chart: helm install my-release oci://registry-1.docker.io/bitnamicharts/<chart>
Upgrade your application: helm upgrade my-release oci://registry-1.docker.io/bitnamicharts/<chart>

Creating a new chart

To make a chart that follows the same structure/patterns that the rest of the Bitnami charts, the basic scaffolding is provided in the template directory. To make a new chart from the template, first run:

make new_chart

This will create a copy in /draft/<chart-name> and a /draft/<chart-name>/placeholder.yaml file. Populate the /draft/<chart-name>/placeholder.yaml file with values for your chart, then run:

make render_template

This will replace all the placeholders throughout the chart with your values. You will still likely need to modify the chart further to meet your needs.

The new chart can then be moved from /draft/<chart-name> to your own repo/location. If you wish to add the chart to this Bitnami repository, then refer to Adding a new chart to the repository

A chart in the draft directory can be recreated from the template by running:

make recreate_chart

This will overwrite all existing files in the draft chart, except for the /draft/<chart-name>/placeholder.yaml file, which will be preserved.

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

dan-hill2802/bitnami-charts