docs(clickhousegrant): add clickhouse grant docs to API reference

aiven · Jun 24, 2024 · 6d42ce1 · 6d42ce1
1 parent b965ada
commit 6d42ce1
Show file tree

Hide file tree

Showing 3 changed files with 85 additions and 0 deletions.
diff --git a/docs/docs/api-reference/clickhousegrant.md b/docs/docs/api-reference/clickhousegrant.md
@@ -2,6 +2,50 @@
 title: "ClickhouseGrant"
 ---
 
+## Usage example
+
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: ClickhouseGrant
+    metadata:
+      name: demo-ch-grant
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      project: my-aiven-project
+      serviceName: my-clickhouse
+
+      privilegeGrants:
+        - grantees:
+            - user: user1
+            - user: my-clickhouse-user-🦄
+          privileges:
+            - SELECT
+            - INSERT
+          database: my-db
+          # If table is not specified, the privileges are granted on all tables in the database
+          # If columns is not specified, the privileges are granted on all columns in the table
+        - grantees:
+            - role: my-role
+          privileges:
+            - SELECT
+          database: my-db
+          table: my-table
+          columns:
+            - col1
+            - col2
+
+      roleGrants:
+        - roles:
+            - other-role
+          grantees:
+            - user: my-user
+            - role: my-role
+    ```
+
 ## ClickhouseGrant {: #ClickhouseGrant }
 
 ClickhouseGrant is the Schema for the ClickhouseGrants API.

diff --git a/docs/docs/api-reference/examples/clickhousegrant.yaml b/docs/docs/api-reference/examples/clickhousegrant.yaml
@@ -0,0 +1,40 @@
+
+apiVersion: aiven.io/v1alpha1
+kind: ClickhouseGrant
+metadata:
+  name: demo-ch-grant
+spec:
+  authSecretRef:
+    name: aiven-token
+    key: token
+
+  project: my-aiven-project
+  serviceName: my-clickhouse
+
+  privilegeGrants:
+    - grantees:
+        - user: user1
+        - user: my-clickhouse-user-🦄
+      privileges:
+        - SELECT
+        - INSERT
+      database: my-db
+      # If table is not specified, the privileges are granted on all tables in the database
+      # If columns is not specified, the privileges are granted on all columns in the table
+    - grantees:
+        - role: my-role
+      privileges:
+        - SELECT
+      database: my-db
+      table: my-table
+      columns:
+        - col1
+        - col2
+
+  roleGrants:
+    - roles:
+        - other-role
+      grantees:
+        - user: my-user
+        - role: my-role
+
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -92,6 +92,7 @@ nav:
       - api-reference/clickhousedatabase.md
       - api-reference/clickhouserole.md
       - api-reference/clickhouseuser.md
+      - api-reference/clickhousegrant.md
       - api-reference/connectionpool.md
       - api-reference/database.md
       - api-reference/grafana.md