deploy-example-application.md

Deploy example application

Table of Contents

• Install or update application using Helm
• Work with cartridge config

This guide provides the instructions how to install the example cartridge application. To deploy your own application you'd need to build your own docker image via Cartridge CLI.

Install or update application using Helm

To install or upgrade the Cartridge App using Helm, run following commands from the shell:

• Add helm repository

  helm repo add tarantool https://tarantool.github.io/helm-charts/

• Configure application params

  helm show values tarantool/cartridge > values.yaml

  Edit values.yaml file to configure your deployment, the most useful variables described here

• Install/update app:

  • Replace the my-namespace with any name of namespace what you want.
  • Add the --create-namespace flag if your namespace is not created yet.
  • Execute following command:

    helm upgrade --install tarantool-app tarantool/cartridge --values ./values.yaml -n my-namespace [--create-namespace]

Work with cartridge config

• To pass cartridge cluster config fill the tarantool.config section in your values.yaml file with any valid yaml object.
• If you need to remove some properties from config you should do it explicit by setting it to null value.

Useful helm variables

JSON Path	Type	Description
dockerconfigjson	array	Docker registry(ies) credentials
storageClass	string	An StorageClass name for requested disks
tarantool.image.repository	string	Name of application docker image
tarantool.image.tag	string	Tag of application docker image
tarantool.bucketCount	number	Count of vshard buckets
tarantool.memtxMemory	quantity	Size of reserved memtx memory
tarantool.auth.user	string	Tarantool super-admin username
tarantool.auth.password	string	Tarantool super-admin password/cluster cookie
tarantool.roles	array	Roles definition
tarantool.roles.*.replicasets	number	Count of replicasets in role
tarantool.roles.*.replicas	number	Count of replicas in each replicaset o role
tarantool.roles.*.vshard.weight	number	Weight of replicasets in vshard
tarantool.roles.*.vshard.roles	array	List of vshard roles
tarantool.roles.*.persistence.spec.resources.requests.storage	quantity	Size of disk for each instance of role