Skip to main content
Version: 0.9.0-incubating

Apache Gravitino Helm Chart

This Helm chart deploys Apache Gravitino on Kubernetes with customizable configurations.

Prerequisites​

  • Kubernetes 1.29+
  • Helm 3+

Update Chart Dependency​

The Gravitino Helm chart has not yet been officially released.
To proceed, please clone the repository, navigate to the chart directory, and execute the Helm dependency update command.

helm dependency update [CHART]

View Chart values​

You can customize values.yaml parameters to override chart default settings. Additionally, Gravitino configurations in gravitino.conf can be modified through Helm values.yaml.

To display the default values of the Gravitino chart, run:

helm show values [CHART]

Install Helm Chart​

helm install [RELEASE_NAME] [CHART] [flags]

Deploy with Default Configuration​

Run the following command to deploy Gravitino using the default settings, specify container image versions using --set image.tag=0.x.0-incubating (replace x with target version):

helm upgrade --install gravitino ./gravitino -n gravitino --create-namespace --set image.tag=<0.*.0-incubating>

Deploy with Custom Configuration​

To customize the deployment, use the --set flag to override specific values:

helm upgrade --install gravitino ./gravitino -n gravitino --create-namespace \
  --set key1=val1,key2=val2,...

Alternatively, you can provide a custom values.yaml file:

helm upgrade --install gravitino ./gravitino -n gravitino --create-namespace -f /path/to/chart/resources/scenarios/ci-values.yaml

Note:
/path/to/chart/resources/scenarios/ci-values.yaml is an example scenario to deploy.

Deploying Gravitino with MySQL as the Storage Backend​

To deploy both Gravitino and MySQL, where MySQL is used as the storage backend, enable the built-in MySQL instance:

helm upgrade --install gravitino ./gravitino -n gravitino --create-namespace \
  --set mysql.enabled=true

Disable Dynamic Storage Provisioning​

By default, the MySQL PersistentVolumeClaim(PVC) storage class is local-path. To disable dynamic provisioning, set the storage class to "-":

helm upgrade --install gravitino ./gravitino -n gravitino --create-namespace \
  --set mysql.enabled=true \
  --set global.defaultStorageClass="-"

You must then manually create a PersistentVolume (PV).

Deploy Gravitino using an existed MySQL Database​

Ensure you have the following MySQL credentials ready: Username, Password, Database Name. When creating your database, we recommend calling it gravitino.

Before deploying Gravitino, initialize your existing MySQL instance and create the necessary tables required for Gravitino to function properly.

mysql -h database-1.***.***.rds.amazonaws.com -P 3306 -u <YOUR-USERNAME> -p <YOUR-PASSWORD> < schema-0.*.0-mysql.sql

Use Helm to install or upgrade Gravitino, specifying the MySQL connection details.

helm upgrade --install gravitino ./gravitino -n gravitino --create-namespace \
  --set entity.jdbcUrl="jdbc:mysql://database-1.***.***.rds.amazonaws.com:3306/gravitino" \
  --set entity.jdbcDriver="com.mysql.cj.jdbc.Driver" \
  --set entity.jdbcUser="admin" \
  --set entity.jdbcPassword="admin123"

Note:
Replace database-1...rds.amazonaws.com with your actual MySQL host.
Change admin and admin123 to your actual MySQL username and password.
Ensure the target MySQL database (gravitino) exists before deployment.

Uninstall Helm Chart​

helm uninstall [RELEASE_NAME] -n [NAMESPACE]