AttentionThis page documents an earlier version. Go to the latest (v2.1)version.
Pick appropriate k8s tab
For Kubernetes, you have two options, one is to using Pivotal Container Service or Managed Kubernetes Service, depending on what you are using click on the appropriate tab.
Once you go to the appropriate tab, You should see configuration form something like this:
Select the Kubernetes provider type from the Type dropdown, in case of Pivotal Container Service this would be default to that option.
Configure the provider
Take note of the following for configuring your K8s provider:
Give a meaningful name for your config.
Service Accountprovide the name of the service account which has necessary access to manage the cluster, refer to Create Service Account .
Kube Configthere are two ways to specify the kube config for an Availability Zone.
- Specify at provider level in the provider form as shown above. If specified, this config file will be used for all AZ's in all regions.
- Specify at zone level inside of the region form as described below, this is especially needed for multi-az or multi-region deployments.
Image Registryspecifies where to pull Yugabyte image from leave this to default, unless you are hosting the registry on your end.
Pull Secret, Our Enterprise Yugabyte image is in a private repo and we need to upload the pull secret to download the image, your sales representative should have provided this secret.
A filled in form looks something like this:
Configure the region/zones
Click on Add Region to open the modal.
Specify a Region and the dialog will expand to show the zone form.
Zone, enter a zone label, keep in mind this label should match with your failure domain zone label
Storage Classis optional, it takes a comma delimited value, if not specified would default to standard, please make sure this storage class exists in your k8s cluster.
Kube Configis optional if specified at provider level or else
Overridesis optional, if not specified Yugabyte Platform would use defaults specified inside the helm chart,
- Overrides to add Service level annotations
serviceEndpoints: - name: "yb-master-service" type: "LoadBalancer" annotations: service.beta.kubernetes.io/aws-load-balancer-internal: "0.0.0.0/0" app: "yb-master" ports: ui: "7000" - name: "yb-tserver-service" type: "LoadBalancer" annotations: service.beta.kubernetes.io/aws-load-balancer-internal: "0.0.0.0/0" app: "yb-tserver" ports: ycql-port: "9042" yedis-port: "6379" ysql-port: "5433"
- Overrides to disable LoadBalancer
- Overrides to change the cluster domain name
- Overrides to add annotations at StatefulSet level
networkAnnotation: annotation1: 'foo' annotation2: 'bar'
Add a new Zone by clicking on
Add Zone button on the bottom left of the zone form.
Your form may have multiple AZ's as shown below.
Add Region to add the region and close the modal.
Save to save the configuration. If successful, it will redirect you to the table view of all configs.