create: add config_storage template

Closes #1180

@TarantoolBot document
Title: `tt create` support `config_storage` template.

Configurable parameters:
- Number of instances in replicaset
- Interval of status checking

Author: elhimov

CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
+- `tt create`: add `config_storage` template
+
 ### Changed
 
 ### Fixed

cli/cmd/create.go

@@ -44,7 +44,8 @@ func NewCreateCmd() *cobra.Command {
 Built-in templates:
 	cartridge: a simple Cartridge application.
 	single_instance: Tarantool 3 application with a single instance configuration.
-	vshard_cluster: Tarantool 3 vshard cluster application.`,
+	vshard_cluster: Tarantool 3 vshard cluster application.
+	config_storage: Tarantool 3 cluster configuration storage.`,
 		Example: `
 # Create an application app1 from a template.
 
@@ -62,7 +63,11 @@ Built-in templates:
 
 # Create Tarantool 3 vshard cluster.
 
-    $ tt create vshard_cluster --name cluster_app`,
+    $ tt create vshard_cluster --name cluster_app
+
+# Create Tarantool 3 cluster configuration storage.
+
+    $ tt create config_storage --name tcs`,
 	}
 
 	createCmd.Flags().StringVarP(&appName, "name", "n", "", "Application name")

cli/cmd/create_test.go

@@ -41,6 +41,7 @@ func TestCreateValidArgsFunction(t *testing.T) {
 		"cartridge",
 		"vshard_cluster",
 		"single_instance",
+		"config_storage",
 		"archive",
 		"template2",
 		tdir1Name,

cli/codegen/generate_code.go

@@ -136,6 +136,14 @@ func main() {
 	if err != nil {
 		log.Errorf("error while generating file modes: %s", err)
 	}
+	err = generateFileModeFile(
+		"cli/create/builtin_templates/templates/config_storage",
+		"cli/create/builtin_templates/static/config_storage_template_filemodes_gen.go",
+		"ConfigStorage",
+	)
+	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

@@ -14,7 +14,13 @@ var FileModes = map[string]map[string]int{
 	"cartridge":       static.CartridgeFileModes,
 	"vshard_cluster":  static.VshardClusterFileModes,
 	"single_instance": static.SingleInstanceFileModes,
+	"config_storage":  static.ConfigStorageFileModes,
 }
 
 // Names contains built-in template names.
-var Names = [...]string{"cartridge", "vshard_cluster", "single_instance"}
+var Names = [...]string{
+	"cartridge",
+	"vshard_cluster",
+	"single_instance",
+	"config_storage",
+}

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

@@ -0,0 +1,19 @@
+description: Config storage template
+follow-up-message: |
+  What's next?
+  Start '{{ .name }}' application:
+      $ tt start {{ .name }}
+
+  Pay attention that default passwords were generated,
+  you can change it in the config.yaml.
+
+vars:
+  - prompt: Storages replicas (odd, >=3)
+    name: replicas_count
+    default: '3'
+    re: ^([3579]|[1-9]\d*[13579])$
+
+  - prompt: Status check interval
+    name: status_check_interval
+    default: '5'
+    re: ^[1-9]\d*$

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

@@ -0,0 +1,50 @@
+credentials:
+  users:
+    replicator:
+      password: 'topsecret'
+      roles: [replication]
+    client:
+      password: 'secret'
+      privileges:
+        - permissions: [execute]
+          lua_call:
+            - config.storage.get
+            - config.storage.put
+            - config.storage.delete
+            - config.storage.keepalive
+            - config.storage.txn
+            - config.storage.info
+        # Not necessary since tarantool 3.5.0, 3.4.1, 3.3.3, 3.2.2.
+        - permissions: [read, write]
+          spaces: [config_storage, config_storage_meta]
+
+iproto:
+  advertise:
+    peer:
+      login: replicator
+
+replication:
+  failover: election
+
+database:
+  use_mvcc_engine: true
+
+groups:
+  group-001:
+    replicasets:
+{{- $status_check_interval := atoi .status_check_interval}}
+{{- $replicas := atoi .replicas_count}}
+{{- range replicasets "replicaset" 1 $replicas}}
+      {{.Name}}:
+        roles: [config.storage]
+        roles_cfg:
+          config.storage:
+            status_check_interval: {{$status_check_interval}}
+        instances:
+{{- range .InstNames}}
+          {{.}}:
+            iproto:
+              listen:
+              - uri: 127.0.0.1:{{port}}
+{{- end}}
+{{- end}}

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

@@ -0,0 +1,7 @@
+---
+{{- $replicas := atoi .replicas_count}}
+{{- range replicasets "replicaset" 1 $replicas}}
+{{- range .InstNames}}
+{{.}}:
+{{- end}}
+{{- end}}

test/integration/create/test_create.py

@@ -15,6 +15,7 @@
     run_command_and_get_output,
     wait_event,
     wait_file,
+    wait_files,
 )
 
 tt_config_text = """env:
@@ -1051,3 +1052,109 @@ def select_data_func():
     # Assert here to be sure that instances are stopped.
     assert can_insert, "can not insert data into the vshard cluster"
     assert can_select, "can not select data from the vhsard cluster"
+
+
+@pytest.mark.slow
+@pytest.mark.skipif(
+    tarantool_major_version < 3,
+    reason="skip centralized config test for Tarantool < 3",
+)
+@pytest.mark.parametrize("num_replicas", [None, 3, 5])
+def test_create_app_from_builtin_config_storage_template(tt_cmd, tmp_path, num_replicas):
+    with open(os.path.join(tmp_path, config_name), "w") as tnt_env_file:
+        tnt_env_file.write(tt_config_text.format(tmp_path))
+
+    create_cmd = [tt_cmd, "create", "config_storage", "--name", "app1"]
+    tt_process = subprocess.Popen(
+        create_cmd,
+        cwd=tmp_path,
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+        stdin=subprocess.PIPE,
+        text=True,
+    )
+    if num_replicas is None:
+        tt_process.stdin.writelines(["\n", "\n"])
+    else:
+        tt_process.stdin.writelines([f"{num_replicas}\n", "\n"])
+    tt_process.stdin.close()
+    tt_process.wait()
+    output = tt_process.stdout.read()
+    assert tt_process.returncode == 0
+    assert "Application 'app1' created successfully" in output
+
+    app_path = tmp_path / "app1"
+    assert os.path.exists(app_path / "config.yaml")
+    assert os.path.exists(app_path / "instances.yaml")
+
+    # Start app.
+    start_cmd = [tt_cmd, "start", "app1"]
+    instance_process = subprocess.Popen(
+        start_cmd,
+        cwd=tmp_path,
+        stderr=subprocess.STDOUT,
+        stdout=subprocess.PIPE,
+        text=True,
+    )
+    start_output = instance_process.stdout.readlines()
+    for line in start_output:
+        assert "Starting an instance" in line
+    if num_replicas is None:
+        num_replicas = 3
+    instances = [f"replicaset-001-{chr(ord('a')+i)}" for i in range(num_replicas)]
+    pid_files = [os.path.join(tmp_path, "app1", inst) for inst in instances]
+    assert wait_files(10, pid_files)
+
+    # Check status.
+    status_cmd = [tt_cmd, "status", "app1"]
+    status_rc, status_out = run_command_and_get_output(status_cmd, cwd=tmp_path)
+    assert status_rc == 0
+    status_info = extract_status(status_out)
+    for key in status_info.keys():
+        assert status_info[key]["STATUS"] == "RUNNING"
+
+    # def eval_cmd_func(inst, cmd):
+    #     connect_process = subprocess.Popen(
+    #         [tt_cmd, "connect", f"app1:{inst}", "-f-"],
+    #         cwd=tmp_path,
+    #         stdin=subprocess.PIPE,
+    #         stderr=subprocess.STDOUT,
+    #         stdout=subprocess.PIPE,
+    #         text=True,
+    #     )
+    #     connect_process.stdin.write(cmd)
+    #     connect_process.stdin.close()
+    #     connect_process.wait()
+    #     return connect_process.stdout.read()
+
+    # def insert_data_func():
+    #     out = eval_cmd_func("router-001-a", "put_sample_data()")
+    #     return out == "---\n...\n\n"
+
+    # def select_data_func():
+    #     out = eval_cmd_func("router-001-a", "get(1)")
+    #     return out.find("[1, 'Elizabeth', 12]") != -1
+
+    # # Check that data can be inserted and selected.
+    # can_insert = wait_event(60, insert_data_func)
+    # can_select = False
+    # if can_insert:
+    #     can_select = wait_event(60, select_data_func)
+
+    # # Print instances log to find out the reason in case of an assert fall.
+    # for inst in instances:
+    #     with open(os.path.join(tmp_path, "app1", inst, "tt.log")) as f:
+    #         print(inst, f.read())
+
+    # # Stop the vhsard_cluster app.
+    # stop_cmd = [tt_cmd, "stop", "--yes", "app1"]
+    # stop_rc, stop_out = run_command_and_get_output(stop_cmd, cwd=tmp_path)
+    # assert stop_rc == 0
+    # for inst in instances:
+    #     assert re.search(rf"The Instance app1:{inst} \(PID = \d+\) has been terminated.", stop_out)
+
+    # with open(app_path / "router-001-a" / "tt.log") as f:
+    #     print("\n".join(f.readlines()))
+    # # Assert here to be sure that instances are stopped.
+    # assert can_insert, "can not insert data into the vshard cluster"
+    # assert can_select, "can not select data from the vhsard cluster"