Skip to content

Self-Managed: yb-storageclass

Install yb-storageclass with Helm. This will create all the Yellowbrick Kubernetes Storage Classes required for creating an Yellowbrick instance.

INFO

Given immutable nature of storageclass, this helm chart only requires to be applied once. A uninstall will explicitly delete the storage classes, and may need to be cleaned up manually.

When using the commands or values outlined here, please make appropriate substitutions defined as:

ValueDescription
{cloud-provider}Your cloud provider: aws, azure, or gcp
{version}The chart version of yb-storageclass

Helm Chart

Running the Yellowbrick Deployer will push the Helm charts and container images you need into your cloud environment. For instructions on pushing assets using the Deployer, see the documentation.

Chart name: yb-storageclass

The get-assets subcommand can be used to find the version of chart name yb-storageclass, see cli reference.

Install Command

See Authenticating with ECR

bash
helm install yb-storageclass oci://{image-repo}/yb-storageclass \
  -n {namespace}  \
  -f values.yaml \
  --version {version}

Values

Please note that you may need to adjust the allowedTopologies and parameters values as appropriate for your installation.

INFO

This helm chart creates storage classes which can provision gp3 and io1 volumes. Without a prefix, the storage class will use names similar to the types on aws(for example gp3, io1-scaled and io1-standard). To avoid a conflict with existing standard names, we recommend that you use a yb- prefix, which will prefix the name of the storage class(for example yb-gp3)

The storage classes can be locked to a specific zone by using allowedTopologies and extra parameters can be applied to all storage classes. See here

yaml
cloudProvider: {cloud-provider}

storageClass:
  prefix: yb-

  allowedTopologies: []
  parameters: {}

INFO

Please note that the prefix given here needs to match the prefix given for the yb-resources Helm chart.