Create a Helm chart configuration for Spanner Omni

Preview

This product or feature is a preview offering subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms, and can only be used for the purposes of developing, testing, prototyping, and demonstrating software programs. It cannot be used for any data processing or commercial purposes. Pre-GA products and features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

This document explains how to create a Helm configuration for Spanner Omni on Kubernetes.

Overview

You configure Helm charts for Spanner Omni deployments on Kubernetes. Review the available configuration options to customize your deployment. The Helm template includes a global.platform property, which sets default values for key settings like StorageClass and service annotations based on your chosen platform.

Understand how the Helm chart applies platform-specific default values for Google Kubernetes Engine (GKE) and Amazon Elastic Kubernetes Service (Amazon EKS). These defaults cover configurations such as storage classes, data locations, and service annotations. Customize these settings to align with your specific deployment requirements for each platform.

Before you begin

If you haven't done so already, install Helm.

Prepare a Helm chart configuration

To create a Helm chart configuration, do the following:

1. Use the helm show values command to review the configuration options available for creating a deployment:

   helm show values oci://us-docker.pkg.dev/spanner-omni/charts/spanner-omni --version 0.1.0
   

   The documentation for creating a deployment uses the --set flag to specify various options. You can also specify these options in a YAML file and use the -f flag in the helm command. For ease of deployment, the Helm template includes the global.platform property, which determines the default values for the StorageClass, service annotations, and other settings based on the platform.

2. The following table summarizes the platform-specific default values for Google Kubernetes Engine (GKE) and Amazon EKS:

Property	Default	Platform
		GKE	Amazon EKS
storageClasses	- name: my_sc provisioner: kubernetes.io/no-provisioner volumeBindingMode: WaitForFirstConsumer	- name: hyperdisk-balanced-rwo provisioner: pd.csi.storage.gke.io parameters:   type: hyperdisk-balanced	- name: aws-gp3 provisioner: ebs.csi.aws.com parameters:   type: gp3 - name: aws-standard provisioner: ebs.csi.aws.com parameters:   type: standard
locations	- name: us namespace: "" zones: - name: "us-a" shortName: "a" replicas: 1 rootServers: 1 singleServer: true - name: "us-b" shortName: "b" - name: "us-c" shortName: "c"	- name: us-east1 zones: - name: us-east1-b shortName: a - name: us-east1-c shortName: b - name: us-east1-d shortName: c	- name: us-east-1 zones: - name: us-east-1a shortName: a - name: us-east-1c shortName: b - name: us-east-1d shortName: c
dataStorageClass	<default>	premium-rwo	aws-gp3
logsStorageClass	<default>	standard-rwo	aws-standard
serviceAnnotations	null	networking.gke.io/load-balancer-type: "Internal" networking.gke.io/internal-load-balancer-allow-global-access: "true"	service.beta.kubernetes.io/aws-load-balancer-internal: "true" service.beta.kubernetes.io/aws-load-balancer-type: "nlb" service.beta.kubernetes.io/aws-load-balancer-nlb-target-type: "ip" service.beta.kubernetes.io/aws-load-balancer-cross-zone-load-balancing-enabled: "true"

What's next

• Learn how to use a Helm chart to create a multi-cluster deployment on Kubernetes for Spanner Omni.

• Learn how to use a Helm chart to create a deployment on Kubernetes for Spanner Omni.