Clickhouse
Create an integration to manage access to ClickHouse resources
ClickHouse is a column-oriented database management system built for fast analytical queries on large volumes of data.
Through this integration, Apono helps you discover ClickHouse resources and securely manage just-in-time (JIT) access to them.
Prerequisites
Apono Connector
On-prem connection serving as a bridge between a ClickHouse instance and Apono:
Minimum Required Version: 1.7.6 Learn how to update an existing AWS, Azure, GCP, or Kubernetes connector.
ClickHouse Access Control Enabled
ClickHouse 20.x or later with SQL-driven access control and account management enabled
ClickHouse Instance Information
Information for the database instance to be integrated:
Hostname
Port
Create a ClickHouse user
You must create a user in your ClickHouse instance for the Apono connector and grant it the required permissions.
Follow these steps to create a user and grant it database permissions:
In ClickHouse, create a new user. Use apono_admin or another name of your choosing for the username. Be sure to set a strong password for the user.
CREATE USER apono_admin IDENTIFIED WITH sha256_password BY '<strong_password>'; Grant the new user the privileges of the current user
WITH GRANT OPTION. This allows the Apono user to inherit the privileges of the administrative user running the command.
The Apono user needs the following privileges to enable Apono to discover resources and manage JIT access to your ClickHouse resources:
SELECTonsystem.databases,system.tables, andsystem.dictionariesCREATE USER,ALTER USER, andDROP USERCREATE ROLEandDROP ROLEGRANT OPTIONon managed databasesSHOWprivileges, includingSHOW DATABASES,SHOW TABLES,SHOW COLUMNS, andSHOW DICTIONARIES
Verify that the Apono user has the required privileges listed in the note of step 2.
Create a secret with the credentials from step 1. Use the following key-value pair structure when generating the secret. Be sure to replace
#PASSWORDwith the actual value. If you used a different name for the user, replaceapono-adminwith the name you assigned to the user.
You can also input the user credentials directly into the Apono UI during the integration process.
Manage materialized views
If your ClickHouse environment uses materialized views, review their access mode and write requirements before integrating ClickHouse with Apono.
Access control
ClickHouse materialized views support two security modes that determine how permissions are evaluated when a user queries the view.
DEFINER
(Recommended) Runs with the permissions of the user who created the view
The querying user only needs the SELECT permission on the view.
INVOKER
Runs with the permissions of the querying user
The querying user must have the SELECT permission on both the view and its underlying source tables. Otherwise, the query fails with ACCESS_DENIED.
Follow these steps to update a materialized view:
Run the following query to review materialized views.
If the create_table_query output does not contain SQL SECURITY DEFINER, the materialized view uses INVOKER mode.
If the materialized view uses
INVOKERmode, update the mode toDEFINERmode.
WRITE access
When requesting WRITE access to a materialized view, users must also have READ access on the source table or tables referenced in the view query.
ClickHouse requires access to the source tables when executing ALTER TABLE <database>.<view_name> MODIFY QUERY. Without it, the WRITE permission is granted but cannot be used.
You can now integrate your ClickHouse instance.
Integrate ClickHouse
You can also use the steps below to integrate with Apono using Terraform.
In step 11, instead of clicking Confirm, follow the Are you integrating with Apono using Terraform? guidance.
Follow these steps to complete the integration:
On the Catalog tab, click ClickHouse. The Connect Integration page appears.
Under Discovery, select one or more resources
Click Next. The Apono connector section appears.
From the dropdown menu, select a connector. Choosing a connector links Apono to all the services available on the account where the connector is located.
If the desired connector is not listed, click + Add new connector and follow the instructions for creating a connector (AWS, Azure, GCP, Kubernetes).
Click Next. The Integration Config section expands.
Define the Integration Config settings.
SettingDescriptionIntegration Name
Unique, alphanumeric, user-friendly name used to identify the integration when constructing an access flow
Hostname
ClickHouse server address
Native Port
Port value for the instance Default Value: 9000
HTTP Port
HTTP port value used by the chosen database client
Default Value: 8123
Enable Secure Connection
Enables a connection to the ClickHouse server based on Transport Layer Security (TLS)
Default Value: false
Skip Certification Verification
Skips validation of the server’s TLS certificate
This is intended for use with self-signed certificates, debugging, or in testing environments.
Default Value: false
Database
(Optional) Name of the database to integrate
Default Value: default
Click Next. The Secret Store section expands.
If you select the Apono secret manager, enter the value of the username and password for the ClickHouse Apono user.
Click Next. The Get more with Apono section expands.
Define the Get more with Apono settings.
SettingDescriptionCredential Rotation
(Optional) Number of days after which the database credentials must be rotated Learn more about the Credentials Rotation Policy.
User cleanup after access is revoked (in days)
(Optional) Defines the number of days after access has been revoked that the user should be deleted
Learn more about Periodic User Cleanup & Deletion.
Custom Access Details
(Optional) Instructions explaining how to access this integration's resources Upon accessing an integration, a message with these instructions will be displayed to end users in the User Portal. The message may include up to 400 characters. To view the message as it appears to end users, click Preview.
Integration Owner
(Optional) Fallback approver if no resource owner is found Follow these steps to define one or several integration owners:
From the Attribute dropdown menu, select User or Group under the relevant identity provider (IdP) platform.
From the Value dropdown menu, select one or multiple users or groups.
NOTE: When Resource Owner is defined, an Integration Owner must be defined.
Resource Owner
(Optional) Group or role responsible for managing access approvals or rejections for the resource Follow these steps to define one or several resource owners:
Enter a Key name. This value is the name of the tag created in your cloud environment.
From the Attribute dropdown menu, select an attribute under the IdP platform to which the key name is associated. Apono will use the value associated with the key (tag) to identify the resource owner. When you update the membership of the group or role in your IdP platform, this change is also reflected in Apono.
NOTE: When this setting is defined, an Integration Owner must also be defined.
Click Confirm.
💡Are you integrating with Apono using Terraform?
If you want to integrate with Apono using Terraform, follow these steps instead of clicking Confirm:
At the top of the screen, click View as Code. A modal appears with the completed Terraform configuration code.
Click to copy the code.
Make any additional edits.
Deploy the code in your Terraform.
Refer to Integration Config Metadata for more details about the schema definition.
Usage
Now that the integration is complete, you can add ClickHouse to define the resources in an access flow. This allows requesters to access ClickHouse resources securely based on your approval and provisioning rules.
Follow the guidance in these articles to define the resource using ClickHouse:
Last updated
Was this helpful?