ClickhouseRole

Prerequisites¶

• A Kubernetes cluster with the operator installed using helm, kubectl or kind (for local development).
• A Kubernetes Secret with an Aiven authentication token.

Required permissions¶

To create and manage this resource, you must have the appropriate roles or permissions. See the Aiven documentation for details on managing permissions.

This resource uses the following API operations, and for each operation, any of the listed permissions is sufficient:

Usage example¶

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

apiVersion: aiven.io/v1alpha1
kind: ClickhouseRole
metadata:
  name: my-role
spec:
  authSecretRef:
    name: aiven-token
    key: token

  project: my-aiven-project
  serviceName: my-clickhouse
  role: my-role

Apply the resource with:

kubectl apply -f example.yaml

Verify the newly created ClickhouseRole:

kubectl get clickhouseroles my-role

The output is similar to the following:

Name       Project             Service Name     Role       
my-role    my-aiven-project    my-clickhouse    my-role    

ClickhouseRole¶

ClickhouseRole is the Schema for the clickhouseroles API.

Required

• apiVersion (string). Value aiven.io/v1alpha1.
• kind (string). Value ClickhouseRole.
• metadata (object). Data that identifies the object, including a name string and optional namespace.
• spec (object). ClickhouseRoleSpec defines the desired state of ClickhouseRole. See below for nested schema.

spec¶

Appears on ClickhouseRole.

ClickhouseRoleSpec defines the desired state of ClickhouseRole.

Required

• project (string, Immutable, Pattern: ^[a-zA-Z0-9_-]+$, MaxLength: 63). Identifies the project this resource belongs to.
• role (string, Immutable, MaxLength: 255). The role that is to be created.
• serviceName (string, Immutable, Pattern: ^[a-z][-a-z0-9]+$, MaxLength: 63). Specifies the name of the service that this resource belongs to.

Optional

• authSecretRef (object). Authentication reference to Aiven token in a secret. See below for nested schema.

authSecretRef¶

Appears on spec.

Authentication reference to Aiven token in a secret.

Required

• key (string, MinLength: 1).
• name (string, MinLength: 1).