service-catalog/manifests/helm/lakekeeper/0.8.1/charts/openfga

OpenFGA Helm Chart

This is a Helm chart to deploy OpenFGA - a high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.

TL;DR

helm repo add openfga https://openfga.github.io/helm-charts
helm install openfga openfga/openfga

Installing the Chart

To install the chart with the release name openfga:

helm repo add openfga https://openfga.github.io/helm-charts
helm install openfga openfga/openfga

This will deploy a 3-replica deployment of OpenFGA on the Kubernetes cluster using the default configurations for OpenFGA. For more information on the default values, please see the official OpenFGA documentation. The Chart Parameters section below lists the parameters that can be configured during installation.

Tip: List all releases using helm list

Customization

If you wish to customize the OpenFGA deployment you may supply paremeters such as the ones listed in the values.yaml.

Installing with Custom Common Labels

You can specify custom labels to insert into resources inline or via Values files:

helm install openfga openfga/openfga \
  --set-json 'commonLabels={"app.example.com/domain": "example", "app.example.com/system": "permissions"}'

commonLabels:
    app.example.com/system: permissions
    app.example.com/domain: example

Installing with Postgres

If you do not already have a Postgres deployment, you can deploy OpenFGA with Postgres with the following command:

helm install openfga openfga/openfga \
  --set datastore.engine=postgres \
  --set datastore.uri="postgres://postgres:password@openfga-postgresql.default.svc.cluster.local:5432/postgres?sslmode=disable" \
  --set postgresql.enabled=true \
  --set postgresql.auth.postgresPassword=password \
  --set postgresql.auth.database=postgres

This will bootstrap a Postgres deployment using the bitnami/postgresql chart and deploy OpenFGA configured in a way to connect to it.

Installing with MySQL

If you do not already have a MySQL deployment, you can deploy OpenFGA with MySQL with the following command:

helm install openfga openfga/openfga \
  --set datastore.engine=mysql \
  --set datastore.uri="root:password@tcp(openfga-mysql.default.svc.cluster.local:3306)/mysql?parseTime=true" \
  --set mysql.enabled=true \
  --set mysql.auth.rootPassword=password \
  --set mysql.auth.database=mysql

This will bootstrap a MySQL deployment using the bitnami/mysql chart and deploy OpenFGA configured in a way to connect to it.

Connecting to an existing Postgres or MySQL deployment

If you have an existing Postgres or MySQL deployment, you can connect OpenFGA to it by providing the datastore.uri parameter. For example, to connect to a Postgres deployment:

helm install openfga openfga/openfga \
  --set datastore.engine=postgres \
  --set datastore.uri="postgres://postgres:password@postgres.postgres:5432/postgres?sslmode=disable"

Using an existing secret for Postgres or MySQL

If you have an existing secret with the connection details for Postgres or MySQL, you can reference the secret in the values file. For example, say you have created the following secret for Postgres:

kubectl create secret generic my-postgres-secret \
  --from-literal=uri="postgres://postgres.postgres:5432/postgres?sslmode=disable" \
  --from-literal=username=postgres --from-literal=password=password

You can reference this secret in the values file as follows:

datastore:
  engine: postgres
  existingSecret: my-postgres-secret
  secretKeys:
    uriKey: uri
    usernameKey: username
    passwordKey: password

You can also mix and match both static config and secret references. When the secret key is defined, the static config will be ignored. The following example shows how to reference the secret for username and password, but provide the URI statically:

datastore:
  engine: postgres
  uri: "postgres://postgres.postgres:5432/postgres?sslmode=disable"
  existingSecret: my-postgres-secret
  secretKeys:
    usernameKey: username
    passwordKey: password

Uninstalling the Chart

To uninstall/delete the openfga deployment:

helm uninstall openfga

Chart Parameters

Take a look at the Chart values schema reference for more information on the chart values that can be configured. Chart values that are null will default to the server specific default values. For more information on the server defaults please see the official server configuration documentation.