Creating a user

If you have a ClickHouse® cluster, you can create a user in it using a custom ClickhouseUser resource.

The user's password is stored in a Kubernetes Secret with the password key. The ClickhouseUser resource name and the Secret name must follow this pattern: <cluster_name>-<user_name>. If the spec.authentication.secretName field is not specified, the operator uses a Secret with the same name by default.

The ClickhouseUser and Secret resources must reside in the same namespace as the ClickhouseCluster cluster.

Using the CLIUsing the CLI

1. Create a file for the ClickhouseUser and Secret resources, e.g., using the touch clickhouseuser.yaml command.

2. Open the file and paste the configuration below into it:

   apiVersion: v1
   kind: Secret
   metadata:
     name: <cluster_name>-<username>
   type: Opaque
   stringData:
     password: "<password>"
   ---
   apiVersion: clickhouse.stackland.yandex.cloud/v1alpha1
   kind: ClickhouseUser
   metadata:
     name: <cluster_name>-<username>
   spec:
     cluster: <cluster_name>
     name: <username>
     roles:
       - name: <cluster_name>-reader
       - name: <cluster_name>-writer
     authentication:
       secretName: <cluster_name>-<username>
   

   Where:

   • spec.cluster: ClickhouseCluster cluster name.
   • spec.name: ClickHouse® user name.
   • spec.roles: List of roles assigned to the user. In each item, specify name, i.e., ClickhouseRole resource name in the same namespace.
   • spec.authentication.secretName: Name of the Secret with the password. This is an optional field. If not specified, the Secret named <cluster_name>-<user_name> is used.
   • In the stringData.password field of the Secret, set the user password.

3. Apply the manifest: kubectl apply -f clickhouseuser.yaml -n <project_name>.

Using the management consoleUsing the management console

1. If you have not opened a project yet, select one.

2. In the left-hand menu, select ClickHouse® Clusters.

3. Select a cluster.

4. Go to the Users tab.

5. Click Create.

6. Fill out the fields as follows:

   • Name: ClickHouse® user name.
   • Password: User password. The management console automatically creates a Kubernetes Secret with the password.
   • Roles: List of roles assigned to the user. You can select multiple roles from those created in this cluster.

7. Click Create.

Done. The user will now appear in the list on the Users tab.