Updating the ClickHouse DBMS


# Updating the ClickHouse DBMS

[!NOTE] ClickHouse DBMS update is performed separately from the Operavix server application update. ClickHouse runs only on Linux and is updated using a Docker image.

To update the ClickHouse DBMS:

1. Remove the ClickHouse service from Docker:

    ```bash
    # docker service rm operavix-clickhouse
    ```

2. Initiate a backup of the database data. During command execution, the console will display the directories being copied. Ensure no copy error messages appear after the procedure completes.

    ```bash
    # docker run -it --rm \
    --mount source=operavix-clickhouse,target=/clickhouse \
    -v /tmp:/target \
    operavix/operavix-clickhouse:22.8.3.13 \
    /bin/bash -c "tar -cvf /target/clickhouse-$(date -u +%d.%m.%Y).tar /clickhouse"
    ```

    **Note:** The image version is provided as an example. When running the command, replace the specified version with the one you are installing.

3. Run the *setpermission.sh* script from the new ClickHouse image. The script adjusts file permissions so that the upgrade proceeds correctly on the next service start.

    ```bash
    # docker run -it --user root --rm \
    --mount source=operavix-clickhouse,target=/var/lib/clickhouse/ \
    --mount source=operavix-clickhouse-log,target=/var/log/clickhouse-server \
    operavix/operavix-clickhouse:23.3.2.37 /setpermission.sh
    ```

    **Note:** The image version is provided as an example. When running the command, replace the specified version with the one you are installing.

4. Start the ClickHouse service.

    ```bash
    # docker service create --name operavix-clickhouse \
    --secret operavix_app_user \
    --secret operavix_app_user_password_hash \
    --secret operavix_external_user \
    --secret operavix_external_user_password_hash \
    --secret operavix_clickhouse_dhparam.pem \
    --secret operavix_clickhouse.crt \
    --secret operavix_clickhouse.key \
    --publish published=8123,target=8123,mode=host \
    --mount type=volume,src=operavix-clickhouse,target=/var/lib/clickhouse/ \
    --mount type=volume,src=operavix-clickhouse-log,target=/var/log/clickhouse-server \
    --restart-max-attempts 5 \
    --restart-condition "on-failure" \
    --no-resolve-image \
    operavix/operavix-clickhouse:23.3.2.37
    ```

5. Verify that the ClickHouse service is running—open `https://<server_address>:8123/ping` in a browser or use the command:  
   `curl https://<server_address>:8123/ping`.

    - If the service is running, the response will be: `OK`  
    - If no response appears, check the ClickHouse service logs by running:

        ```bash
        # docker service logs -f operavix-clickhouse
        ```


Step-by-step guide for updating the ClickHouse DBMS

Connecting the Application to the ClickHouse Analytical DBMS

Installing and Removing the ClickHouse DBMS

What Is Operavix

Quick Installation of the Operavix Server Component

Monitoring Agent

JS Tracker (Customer Journey Tracking)

Quick Installation

Quick System Setup

Building a Custom Dashboard

Template-Based Reports for Data Analysis

First Dashboard

What’s Next?

Quick Start 

Functional Architecture

Network Interaction of System Components

Description of the System Functioning

System Integration with External Automated Systems

Technical Requirements for Server and Hardware Equipment

Architectural Scheme of the Operavix Application

Network Scheme of the Operavix Application

Glossary

Description of the Operavix System 

Installing, Configuring, and Removing the Operavix Application on Windows

Installing the Operavix Application on Linux

Updating Operavix on Windows

Updating Operavix on Linux

Updating Operavix

Cluster Mode Setup

Migrating the Operavix Server from Windows to Linux

Installing the Automation Module on a Separate Server

Installing and Running the AI Agent

Installing and Running the Webhook Agent

Instructions for Installing, Updating, and Removing the System

License Key

Beta Version Functionality

System Licensing

Working with Databases

Working with the System

System Configuration Files

Prometheus Metrics

Access Roles

Working with GraphQL

Managing System Users

System Emails to Users

Embedding Operavix Dashboards

Differences Between Operavix on Linux and Windows Operating Systems

Administration 

Creating User Accounts in ClickHouse

Setting up a ClickHouse DBMS Cluster in Docker with Replication Support

ClickHouse 

User Data Collection by Monitoring Agent

Obtaining The Monitoring Agent Distribution

Monitoring Agent Configurator

Installing, Updating, and Removing the Monitoring Agent on Windows

Installing, Updating, and Removing the Monitoring Agent on Linux

Starting and Stopping the Monitoring Agent

Managing the Monitoring Agent

Monitoring Logs

Storing Monitoring Agent Logs

Collecting Screenshots with the Monitoring Agent

Export and Import of User Activity

Activity Archiving

Working with Damaged Monitoring Archives

Data Storage Structure in ClickHouse

Monitoring 

Signing In to the System

How to Recover Your Password

Home Page

Filtering

Navigation in the System

Workspaces

Personal Profile

System Settings

Users

Departments

Bulk Actions

Adding API Keys

Keytab File Creation for the Kerberos Authentication in Active Directory

Configuring Authentication Using OpenID Connect and Keycloak

Configuring SAML Authentication in Keycloak

Adding Authentication

About the system

The Monitoring Section

The Connections Section

Data Storages

System Tables

System Settings 

Automation Agents

Execution Log

Control Panel

Configuring an SMB Connection

Connections

Automation Blocks

Trigger Blocks

Working with Files

Working with Services

Working with LLM

Tools

Event Processing

Editing a Script

Query and Code Editor

Script Testing and Publishing

Running a Script

Script Example

Automation 

Custom Integrations 

System Events

JS Tracker 

Access Settings for Workspaces

Adding and Configuring Tables

Replacing Tables

Adding and Configuring Processes

Global Workspace Indicators

Display Rules

Configuring the Data Model

Packages

General

Configuring Access to Dashboards

Click to Filter

Table Report Export

Browse mode

Edit Mode

Views

Dimensions and Measures

Widget Basic Settings

Widget Display Settings

Widget Filtering Settings

Widget List

Widgets

Sorting

Markdown Usage Rules

Variables

Global Dashboard Indicators

Running Script from Dashboard

Go to URL

Run Script

Open View

Update Variable

Click Actions

Input Methods

Displaying Monitoring Screenshots in a Dashboard

Formula Editor

Functions for Formulas

The process Function

View Configuration in YAML

Widget Configuration in YAML

Dimensions and Measures in YAML

Process-Based Dimensions and Measures in YAML

Data Formats and Formatting in YAML

YAML Editor

Dashboards

Report Example

Business Intelligence 

OperavixAI

Package Creation Guide

Marketplace 

Template-Based Dashboards

Configuring Depersonalization Of User Data When Deleted In AD

Activating LDAPS

Synchronized Attributes Between the System and AD

Getting Information About AD Security Groups Using A GraphQL Request

Configuring User Synchronization with Active Directory

User Synchronization 

Audit Mechanism Description

System Status Monitoring

Implemented Information Security Protection Measures in the System

Audit Logs

Docker Containers

Mutual Authentication Between Application Server and ClickHouse

For Security Administrator 

Known Issues

Known Issues and Limitations 

Frequently Asked Questions

.css-wsrjzs{display:inline;margin-right:12px;}@media screen and (max-width: 691px){.css-wsrjzs{display:inline-block;margin-right:0;}}Updating the ClickHouse DBMS

Updating the ClickHouse DBMS