Puppet Class: clickhouse

Inherited by:
clickhouse::repo
clickhouse::client
clickhouse::server
Defined in:
manifests/init.pp

Summary

this class allows you to install ClickHouse DB's repo, client and server

Overview

Top level class for ClickHouse DBMS installation and management.

Examples:

Simple use

include clickhouse

Install server and client

class { 'clickhouse':
  server => true,
}

Install everything and manage repository

class { 'clickhouse':
  server      => true,
  client      => true,
  manage_repo => true,
}

Parameters:

  • server (Boolean) (defaults to: false) —

    Is clickhouse-server should be installed or not. It won’t be installed by default, because some time you need the client only.

  • client (Boolean) (defaults to: true) —

    Is clickhouse-client should be installed or not.

  • manage_repo (Boolean) (defaults to: false) —

    Is apt or yum repository should be managed. Set to ‘false` by default to not affect your own repositories policy.

  • user (String[1]) (defaults to: 'clickhouse') —

    User for configs owning. Strongly recommended staying default.

    It’s highly unrecommended to change default user, but feel free to shot in a knee. You have to adjust as well the data directory and the whole configs everywhere.

  • group (String[1]) (defaults to: $user) —

    Group for configs, see ‘user` parameter.

Author:

  • InnoGames GmbH



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'manifests/init.pp', line 36

class clickhouse (
    Boolean   $server      = false,
    Boolean   $client      = true,
    Boolean   $manage_repo = false,
    String[1] $user        = 'clickhouse',
    String[1] $group       = $user,
) {

    if $server {
        include clickhouse::server
    }

    if $client {
        include clickhouse::client
    }

    if $manage_repo {
        include clickhouse::repo
    }
}