VK Cloud logo
Support

Managing a service instance

Viewing instance information

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click on the name of the required instance.

  4. View the information on the instance page tabs.

Editing instance name and description

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click the ••• icon for the required instance and select Edit.

  4. Edit the instance name and description.

  5. Click Save changes.

Viewing component status

  1. Go to the VK Cloud management console.

  2. Go to the Data Platform → Service instances section.

  3. Click the name of the required instance.

  4. On the instance page, go to the Component status tab.

Horizontal scaling

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click the ••• icon for the required instance and select Horizontal scaling.

  4. Specify the number of nodes.

  5. Click Save changes.

Increasing disk size

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Access the disk size settings in one of the following ways:

    • From the service instance list:

      1. In the service instance list, click the ••• icon for the required instance.
      2. Select Increase disks.

    • From the instance page:

      1. In the service instance list, click on the name of the required instance.
      2. On the General information tab, click the ••• icon.
      3. Select Increase disks.

  4. Specify the new disk size.

  5. Click Save changes.

Adding an account

  1. Go to the VK Cloud management console.

  2. Go to the Data Platform → Service instances section.

  3. Click the name of the required instance.

  4. On the instance page, go to the Credentials tab.

  5. Click the Add account button.

  6. In the opened window, specify the user login to access the Cloud ClickHouse instance.

  7. 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.

  8. Create or generate a user password.

    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: !, ?, %, #, /, (, ), -, +, *.

  9. Click the Save changes button.

Deleting an account

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click on the name of the required instance.

  4. On the instance page, go to the Credentials tab.

  5. Click ••• for the required instance and select Delete.

  6. Confirm the deletion and wait for the operation to complete.

Enabling and disabling extensions

  1. Go to the VK Cloud management console.
  1. Go to Data Platform → Service instances.
  2. Click on the instance name.
  3. Go to the Extensions tab.
  4. To the right of the required extension parameter, in the Action column, click Enable or Disable.
  5. Confirm the action.

Viewing and editing instance settings

  1. Go to the VK Cloud management console.

  2. Navigate to Data Platform → Service instances.

  3. Click the name of the required instance.

  4. On the instance page, go to the Settings tab.

  5. Find the required parameter in the instance settings table; use the search bar if necessary.

  6. View the settings change history by clicking .

  7. Edit the required settings:

    1. Click the Edit button.
    2. Change the values of the required parameters in the table.
    3. If you need to revert to the default value, click ••• for the required parameter and select Reset.
    4. Click the Save changes button.

Adding a connection

  1. Go to the VK Cloud management console.

  2. Go to the Data Platform → Service instances section.

  3. Click the name of the required instance.

  4. On the instance page, go to the Connections tab.

  5. Click the Add connection button.

  6. Select the data source:

    • S3 VK Cloud — connection to VK Object Storage storage in the same project.
    • S3 external — connection to an external S3 object storage.
    • Iceberg Metastore with S3 VK Cloud — connection to a Cloud Iceberg Metastore instance in the same VK Cloud project.
    • Iceberg Metastore with external S3 — connection to an external Cloud Iceberg Metastore catalog.
    • ClickHouse — connection to a Cloud ClickHouse database.
    • PostgreSQL — connection to a PostgreSQL database.
    • MySQL — connection to a MySQL database.

  7. Configure the connection parameters for the data source:

    • Name: specify a connection name. The name must start with a lowercase Latin letter and contain only uppercase and lowercase Latin letters, digits, and _ characters. The name will be used when working with Cloud ClickHouse.
    • Bucket: the name of the VK Object Storage bucket that the Cloud ClickHouse instance will connect to.

  8. Click the Save changes button.

Changing instance maintenance parameters

  1. Go to the VK Cloud management console.

  2. Go to the Data Platform → Service instances section.

  3. Click the name of the required instance.

  4. On the instance page, go to the Maintenance tab.

  5. 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.

  6. 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.

  7. 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.

  8. Set the maximum number of incremental backups. When the maximum number is exceeded, older backups will be overwritten.

  9. Click the Save changes button.

Viewing backups

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click on the name of the required instance.

  4. Go to the Backup list tab. The list displays information about all created backups, including their size.

  5. Review the information.

Creating an instance backup

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click on the name of the required instance.

  4. Go to the Backup list tab.

  5. Click Add backup.

  6. Specify a backup name or keep the auto-generated name.

  7. Select the backup type from the list.

  8. Click Save changes.

Restoring an instance from a backup

  1. Go to the VK Cloud management console.

  2. Go to the Data Platform → Service instances section.

  3. Click the name of the required instance.

  4. On the instance page, go to the backups tab.

  5. Click ••• for the required backup and select Restore.

  6. (Optional) Change the instance parameter values. The parameters are described in the creating an instance section.

  7. Click the Create button.

    A new Cloud ClickHouse service instance will be created.

Deleting an instance

  1. Go to the management console VK Cloud.

  2. Go to Data Platform → Service instances.

  3. Click the ••• icon for the required instance and select Delete.

  4. Confirm the deletion and wait for the operation to complete. Instance deletion may take a long time.

Was this article helpful?
Was this article helpful?
Did you find a mistake in the article? Select it and click
Ctrl+Enter
Privacy Policy