Tenant Settings

Overview

Punchplatform provides a settings file per tenant to configure specific topics:

  • the zookeeper cluster used to operate the tenant
  • the archives housekeeper configuration

Tenant settings file

At the root of the tenant directory (ie $PUNCHPLATFORM_CONF_DIR/tenants/<tenant_name>), there is following structure:

etc
    conf.json

Settings fields

Admin Zookeeper cluster section

admin_zk_cluster

MANDATORY: zookeeper cluster name used by the operator commands to start, stop the channels of the tenant.

Typical value: common

Archiving section

archiving
OPTIONAL: archives housekeeper section. The housekeeper is responsible of of clearing old data. See Archiving Housekeeping health tab.
archiving.clusters
MANDATORY IN SECTION: objects-storage clusters.
archiving.clusters.<name>
OPTIONAL: objects-storage cluster name.
archiving.clusters.<name>.techno

MANDATORY IN SECTION: technology name (an objects storage can be stored on a Ceph cluster or on a file-system).

Typical values: “ceph” or “file”.

archiving.clusters.<name>.pools
MANDATORY IN SECTION: a dictionary representing all cluster’s pools.
archiving.clusters.<name>.pools.<pool_name>

OPTIONAL: pool name.

Typical value: “mytenant-data”

archiving.clusters.<name>.pools.<pool_name>.retention_in_days

MANDATORY IN SECTION: pool retention in days. Older data will be removed.

Typical value: 365

Example:

"archiving" : {
        "clusters" : {
                "main" : {
                        "techno" : "ceph",
                        "pools" : {
                                "mytenant-data" : {
                                        "retention_in_days" : 365
                                }
                        }
                }
        }
}