create: add built-in vshard cluster template

This patch introduces built-in `vshard_cluster` template,
which uses tarantool 3.0 config.

Part of #489

Author: askalt

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 - Module ``tt replicaset``, to manage replicasets:
   - ``tt replicaset status`` to show a cluster status information.
+- Built-in vshard cluster application template.
 
 ### Changed
 

cli/cmd/create_test.go

@@ -39,6 +39,7 @@ func TestCreateValidArgsFunction(t *testing.T) {
 
 	templates := []string{
 		"cartridge",
+		"vshard_cluster",
 		"archive",
 		"template2",
 		tdir1Name,

cli/codegen/generate_code.go

@@ -131,6 +131,14 @@ func main() {
 	if err != nil {
 		log.Errorf("error while generating file modes: %s", err)
 	}
+	err = generateFileModeFile(
+		"cli/create/builtin_templates/templates/vshard_cluster",
+		"cli/create/builtin_templates/static/vshard_cluster_template_filemodes_gen.go",
+		"VshardCluster",
+	)
+	if err != nil {
+		log.Errorf("error while generating file modes: %s", err)
+	}
 
 	if err = generateLuaCodeVar(); err != nil {
 		log.Errorf("error while generating lua code string variables: %s", err)

cli/create/builtin_templates/builtin_templates.go

@@ -11,8 +11,9 @@ var TemplatesFs embed.FS
 
 // FileModes contains mapping of file modes by built-in template name.
 var FileModes = map[string]map[string]int{
-	"cartridge": static.CartridgeFileModes,
+	"cartridge":      static.CartridgeFileModes,
+	"vshard_cluster": static.VshardClusterFileModes,
 }
 
 // Names contains built-in template names.
-var Names = [...]string{"cartridge"}
+var Names = [...]string{"cartridge", "vshard_cluster"}

cli/create/builtin_templates/templates/vshard_cluster/MANIFEST.yaml

@@ -0,0 +1,30 @@
+description: Vshard cluster template
+follow-up-message: |
+  What's next?
+  Build and start '{{ .name }}' application:
+      $ tt build {{ .name }}
+      $ tt start {{ .name }}
+
+  Pay attention that default passwords were generated,
+  you can change it in the config.yaml.
+
+vars:
+  - prompt: Bucket count
+    name: bucket_count
+    default: '3000'
+    re: ^[1-9]\d*$
+
+  - prompt: Storage replication sets count
+    name: replicasets_count
+    default: '2'
+    re: ^[1-9]\d*$
+
+  - prompt: Storage replicas per replication set count (>=2)
+    name: replicas_count
+    default: '2'
+    re: ^[2-9]|[1-9]\d+$
+
+  - prompt: Routers count
+    name: routers_count
+    default: '1'
+    re: ^[1-9]\d*$

cli/create/builtin_templates/templates/vshard_cluster/config.yaml.tt.template

@@ -0,0 +1,52 @@
+credentials:
+  users:
+    client:
+      password: 'secret'
+      roles: [super]
+    replicator:
+      password: 'secret'
+      roles: [replication]
+    storage:
+      password: 'secret'
+      roles: [sharding]
+
+iproto:
+  advertise:
+    peer:
+      login: replicator
+    sharding:
+      login: storage
+
+sharding:
+  bucket_count: {{.bucket_count}}
+
+groups:
+  storages:
+    app:
+      module: storage
+    sharding:
+      roles: [storage]
+    replication:
+      failover: manual
+    {{- $replicasets := atoi .replicasets_count}}{{$replicas := atoi .replicas_count}}
+    replicasets: {{ range replicasets "storage" $replicasets $replicas }}
+      {{.Name}}:
+        leader: {{index .InstNames 0}}
+        instances: {{range .InstNames}}
+          {{.}}:
+            iproto:
+              listen:
+                - uri: localhost:{{port}}{{end}}{{end}}
+  routers:
+    app:
+      module: router
+    sharding:
+      roles: [router]
+    {{- $routers := atoi .routers_count}}
+    replicasets: {{ range replicasets "router" $routers 1}}
+      {{.Name}}:
+        instances: {{range .InstNames}}
+          {{.}}:
+            iproto:
+              listen:
+                - uri: localhost:{{port}}{{end}}{{end}}

cli/create/builtin_templates/templates/vshard_cluster/instances.yaml.tt.template

@@ -0,0 +1,10 @@
+---
+{{- $replicasets := atoi .replicasets_count}}{{$replicas := atoi .replicas_count}}
+{{ range replicasets "storage" $replicasets $replicas }}{{range .InstNames}}{{.}}:
+
+{{end}}{{end}}
+
+{{- $routers := atoi .routers_count}}
+{{- range replicasets "router" $routers 1}}{{range .InstNames}}{{.}}:
+
+{{end}}{{end}}

cli/create/builtin_templates/templates/vshard_cluster/router.lua

@@ -0,0 +1,34 @@
+local vshard = require('vshard')
+local log = require('log')
+
+-- Bootstrap the vshard router.
+while true do
+    local ok, err = vshard.router.bootstrap({
+        if_not_bootstrapped = true,
+    })
+    if ok then
+        break
+    end
+    log.info(('Router bootstrap error: %s'):format(err))
+end
+
+-- Put data into the cluster.
+function put(id, name, age)
+    local bucket_id = vshard.router.bucket_id_mpcrc32({id})
+    vshard.router.callrw(bucket_id, 'put', {id, bucket_id, name, age})
+end
+
+-- Get data from the cluster.
+function get(id)
+    local bucket_id = vshard.router.bucket_id_mpcrc32({id})
+    return vshard.router.callro(bucket_id, 'get', {id})
+end
+
+-- Put sample data.
+function put_sample_data()
+    put(1, 'Elizabeth', 12)
+    put(2, 'Mary', 46)
+    put(3, 'David', 33)
+    put(4, 'William', 81)
+    put(5, 'Jack', 35)
+end

cli/create/builtin_templates/templates/vshard_cluster/storage.lua

@@ -0,0 +1,56 @@
+local vshard = require('vshard')
+
+-- Create 'customers' space.
+box.once('customers', function()
+    box.schema.create_space('customers', {
+        format = {{
+            name = 'id',
+            type = 'unsigned'
+        }, {
+            name = 'bucket_id',
+            type = 'unsigned'
+        }, {
+            name = 'name',
+            type = 'string'
+        }, {
+            name = 'age',
+            type = 'number'
+        }}
+    })
+    box.space.customers:create_index('primary_index', {
+        parts = {{
+            field = 1,
+            type = 'unsigned'
+        }}
+    })
+    box.space.customers:create_index('bucket_id', {
+        parts = {{
+            field = 2,
+            type = 'unsigned'
+        }},
+        unique = false
+    })
+    box.space.customers:create_index('age', {
+        parts = {{
+            field = 4,
+            type = 'number'
+        }},
+        unique = false
+    })
+end)
+
+-- Put data to the 'customers' space.
+-- Function should be called by the router.
+function put(id, bucket_id, name, age)
+    box.space.customers:insert({id, bucket_id, name, age})
+end
+
+-- Get data from the 'customers' space.
+-- Function should be called by the router.
+function get(id)
+    local tuple = box.space.customers:get(id)
+    if tuple == nil then
+        return nil
+    end
+    return {tuple.id, tuple.name, tuple.age}
+end

cli/create/builtin_templates/templates/vshard_cluster/{{.name}}-scm-1.rockspec.tt.template

@@ -0,0 +1,11 @@
+package = '{{ .name }}'
+version = 'scm-1'
+source  = {
+    url = '/dev/null',
+}
+dependencies = {
+    'vshard == 0.1.25'
+}
+build = {
+    type = 'none';
+}