Polaris Helm Chart

A Helm chart for Apache Polaris (incubating).

Homepage: https://polaris.apache.org/

Source Code

• https://github.com/apache/polaris

Installation

Running locally with a Minikube cluster

The below instructions assume Minikube and Helm are installed.

Start the Minikube cluster, build and load image into the Minikube cluster:

minikube start
eval $(minikube docker-env)

./gradlew \
  :polaris-server:assemble \
  :polaris-server:quarkusAppPartsBuild --rerun \
  :polaris-admin:assemble \
  :polaris-admin:quarkusAppPartsBuild --rerun \
  -Dquarkus.container-image.build=true

Installing the chart locally

The below instructions assume a local Kubernetes cluster is running and Helm is installed.

Common setup

Create the target namespace:

kubectl create namespace polaris

Create all the required resources in the polaris namespace. This usually includes a Postgres database, Kubernetes secrets, and service accounts. The Polaris chart does not create these resources automatically, as they are not required for all Polaris deployments. The chart will fail if these resources are not created beforehand. You can find some examples in the helm/polaris/ci/fixtures directory, but beware that these are primarily intended for tests.

Below are two sample deployment models for installing the chart: one with a non-persistent backend and another with a persistent backend.

[!WARNING] The examples below use values files located in the helm/polaris/ci directory. These files are intended for testing purposes primarily, and may not be suitable for production use. For production deployments, create your own values files based on the provided examples.

Non-persistent backend

Install the chart with a non-persistent backend. From Polaris repo root:

helm upgrade --install --namespace polaris \
  polaris helm/polaris

Persistent backend

[!WARNING] The Postgres deployment set up in the fixtures directory is intended for testing purposes only and is not suitable for production use. For production deployments, use a managed Postgres service or a properly configured and secured Postgres instance.

Install the chart with a persistent backend. From Polaris repo root:

helm upgrade --install --namespace polaris \
  --values helm/polaris/ci/persistence-values.yaml \
  polaris helm/polaris
kubectl wait --namespace polaris --for=condition=ready pod --selector=app.kubernetes.io/name=polaris --timeout=120s

To access Polaris and Postgres locally, set up port forwarding for both services (This is needed for bootstrap processes):

kubectl port-forward -n polaris $(kubectl get pod -n polaris -l app.kubernetes.io/name=polaris -o jsonpath='{.items[0].metadata.name}') 8181:8181

kubectl port-forward -n polaris $(kubectl get pod -n polaris -l app.kubernetes.io/name=postgres -o jsonpath='{.items[0].metadata.name}') 5432:5432

Run the catalog bootstrap using the Polaris admin tool. This step initializes the catalog with the required configuration:

container_envs=$(kubectl exec -it -n polaris $(kubectl get pod -n polaris -l app.kubernetes.io/name=polaris -o jsonpath='{.items[0].metadata.name}') -- env)
export QUARKUS_DATASOURCE_USERNAME=$(echo "$container_envs" | grep quarkus.datasource.username | awk -F '=' '{print $2}' | tr -d '\n\r')
export QUARKUS_DATASOURCE_PASSWORD=$(echo "$container_envs" | grep quarkus.datasource.password | awk -F '=' '{print $2}' | tr -d '\n\r')
export QUARKUS_DATASOURCE_JDBC_URL=$(echo "$container_envs" | grep quarkus.datasource.jdbc.url | sed 's/postgres/localhost/2' | awk -F '=' '{print $2}' | tr -d '\n\r')

java -jar runtime/admin/build/quarkus-app/quarkus-run.jar bootstrap -c POLARIS,root,pass -r POLARIS

Uninstalling

helm uninstall --namespace polaris polaris

kubectl delete --namespace polaris -f helm/polaris/ci/fixtures/

kubectl delete namespace polaris

Development & Testing

This section is intended for developers who want to run the Polaris Helm chart tests.

Prerequisites

The following tools are required to run the tests:

• Helm Unit Test
• Chart Testing

Quick installation instructions for these tools:

helm plugin install https://github.com/helm-unittest/helm-unittest.git
brew install chart-testing

The integration tests also require some fixtures to be deployed. The ci/fixtures directory contains the required resources. To deploy them, run the following command:

kubectl apply --namespace polaris -f helm/polaris/ci/fixtures/
kubectl wait --namespace polaris --for=condition=ready pod --selector=app.kubernetes.io/name=postgres --timeout=120s

The helm/polaris/ci contains a number of values files that will be used to install the chart with different configurations.

Running the unit tests

Helm unit tests do not require a Kubernetes cluster. To run the unit tests, execute Helm Unit from the Polaris repo root:

helm unittest helm/polaris

You can also lint the chart using the Chart Testing tool, with the following command:

ct lint --charts helm/polaris

Running the integration tests

Integration tests require a Kubernetes cluster. See installation instructions above for setting up a local cluster.

Integration tests are run with the Chart Testing tool:

ct install --namespace polaris --charts ./helm/polaris

Values