Creating a service instance

Management console

Go to the VK Cloud management console.
Select the project where you need to create a service instance.
Navigate to Data Platform → Service instances.
Click the Create instance button.
On the Configuration step:
1. Select the service type: Cloud ClickHouse.
2. Select the required service version.
3. Select the service instance configuration:
  - Single: in this configuration, the service instance will be located on a single server.
    
    This solution is suitable for development and testing, reducing the cost of deploying test infrastructure. It does not provide fault tolerance: a node failure causes all operations to stop.
  - Cluster: in this configuration, a fault-tolerant cluster will be created with maximum availability, automatic recovery, and failover after failures.
    
    This solution is suitable for storing databases of most projects, including high-load ones with high requirements for data integrity.
4. Click the Next step button.
On the Parameters step:
1. Set the instance parameters:
  - Name: specify a name for the service instance.
  - Description: add a description if necessary.
  - Database name: specify the name of the database that Cloud ClickHouse will connect to.
  - Assign external IP: enable the option to make the Cloud ClickHouse instance accessible via the internet.
  - Kubernetes cluster: select the required cluster from the dropdown list or create a new one by selecting Create new cluster in the list. When creating a new cluster, specify the parameters:
    - Network: select the subnet where the cluster will be accessible from the list, or create a new one by selecting Create new network in the list. When creating a new subnet, specify the SDN and the subnet address.
    - Availability zone: select the availability zone of the cluster from the list.
2. Select the cluster configuration: Basic or Advanced.
  Basic
  Advanced
  Select one of the ready-made cluster templates. Templates differ:
  
  in the Single node instance configuration — by the number of CPUs and RAM on Cloud ClickHouse nodes;
  
  in the Cluster instance configuration — by the number of CPUs and RAM on Cloud ClickHouse nodes, as well as the number of database shards.
  
  In the Clickhouse Keeper block, specify the number of ClickHouse Keeper nodes and the parameters of each node: number of CPUs, RAM amount, disk type and size.
  
  ClickHouse Keeper nodes are designed to manage replication and data synchronization between cluster nodes. They are necessary to ensure database fault tolerance, integrity, and high availability.
  
  In the Clickhouse block, specify the number of ClickHouse nodes and the parameters of each node: number of CPUs, RAM amount, disk type and size.
  
  ClickHouse nodes are designed for storing and processing large volumes of data in real time. They are necessary to ensure high query performance and efficient resource utilization.
  
  (Optional) To add another database shard in the Cluster instance configuration, click the Add shard button.
3. Click the Next step button.
On the Maintenance step:
1. Select the days of the week and the start time of maintenance, considering the time zone specified in the block.
  
  The duration of maintenance, including backup, is 4 hours. During this time, the service may be unavailable.
2. Set the maximum number of full backups. This number depends on the data archival retention requirements or may be dictated by regulatory requirements. When the maximum number is exceeded, older backups will be overwritten.
  
  A full backup includes files, databases, settings, and configurations necessary to restore the system in case of failure, data loss, or other issues.
3. Set the incremental backup schedule in crontab format or select an existing one from the list.
  
  An incremental backup contains only the data that has changed since the previous backup run (full or incremental). This backup is smaller in size than a full one.
4. Set the maximum number of incremental backups. When the maximum number is exceeded, older backups will be overwritten.
5. Click the Next step button.
On the Credentials step:
1. Specify the account login to access Cloud ClickHouse. Login requirements:
  - only digits, Latin letters, and the _ character are allowed;
  - the first character must be a Latin letter of any case or _;
  - invalid names: os_admin, root, dataplatform_moth.
2. Select a role:
  - Database Owner — a user with the broadest set of permissions. When users are deleted, permissions on objects they created are transferred to the database owner. A service instance can have only one owner, who cannot be deleted.
  - Standard User — a user who can create, modify, and view objects: tables, schemas, functions, etc. They own the permissions on the objects they create. The number of users with this role is unlimited.
  - Observer — a user who can view database tables but cannot create or modify them. The number of users with this role is unlimited.
  - Security Auditor — a user who can view existing users, assigned roles, and system tables. The auditor cannot create new objects or modify or view existing user objects. The number of users with this role is unlimited.
  Multiple users can be created for Cloud ClickHouse, but at least one of them must have the Database Owner role.
3. Specify the password to access Cloud ClickHouse. To set a password, click the Generate button or specify your own.
  
  Password requirements:
  - at least 16 characters;
  - at least one uppercase and one lowercase letter of the Latin alphabet;
  - at least one digit;
  - at least one of the characters: !, ?, %, #, /, (, ), -, +, *.
4. (Optional) To add another account, click the Add account button.
5. Click the Create button.
When the instance transitions to the Active status, check the connection and make sure that the instance was created successfully and the access settings are correct.

Was this article helpful?