docs: test examples (#723)

aiven · May 6, 2024 · 733a9ae · 733a9ae
1 parent f07a985
commit 733a9ae
Show file tree

Hide file tree

Showing 37 changed files with 1,229 additions and 886 deletions.
diff --git a/docs/docs/api-reference/cassandra.md b/docs/docs/api-reference/cassandra.md
@@ -4,40 +4,41 @@ title: "Cassandra"
 
 ## Usage example
 
-```yaml
-apiVersion: aiven.io/v1alpha1
-kind: Cassandra
-metadata:
-  name: my-cassandra
-spec:
-  authSecretRef:
-    name: aiven-token
-    key: token
-
-  connInfoSecretTarget:
-    name: cassandra-secret
-    prefix: MY_SECRET_PREFIX_
-    annotations:
-      foo: bar
-    labels:
-      baz: egg
-
-  project: aiven-project-name
-  cloudName: google-europe-west1
-  plan: startup-4
-
-  maintenanceWindowDow: sunday
-  maintenanceWindowTime: 11:00:00
-
-  userConfig:
-    migrate_sstableloader: true
-    public_access:
-      prometheus: true
-    ip_filter:
-      - network: 0.0.0.0
-        description: whatever
-      - network: 10.20.0.0/16
-```
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: Cassandra
+    metadata:
+      name: my-cassandra
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      connInfoSecretTarget:
+        name: cassandra-secret
+        prefix: MY_SECRET_PREFIX_
+        annotations:
+          foo: bar
+        labels:
+          baz: egg
+
+      project: aiven-project-name
+      cloudName: google-europe-west1
+      plan: startup-4
+
+      maintenanceWindowDow: sunday
+      maintenanceWindowTime: 11:00:00
+
+      userConfig:
+        migrate_sstableloader: true
+        public_access:
+          prometheus: true
+        ip_filter:
+          - network: 0.0.0.0
+            description: whatever
+          - network: 10.20.0.0/16
+    ```
 
 ## Cassandra {: #Cassandra }
 

diff --git a/docs/docs/api-reference/clickhouse.md b/docs/docs/api-reference/clickhouse.md
@@ -4,31 +4,32 @@ title: "Clickhouse"
 
 ## Usage example
 
-```yaml
-apiVersion: aiven.io/v1alpha1
-kind: Clickhouse
-metadata:
-  name: my-clickhouse
-spec:
-  authSecretRef:
-    name: aiven-token
-    key: token
-
-  connInfoSecretTarget:
-    name: clickhouse-secret
-    prefix: MY_SECRET_PREFIX_
-    annotations:
-      foo: bar
-    labels:
-      baz: egg
-
-  project: my-aiven-project
-  cloudName: google-europe-west1
-  plan: startup-16
-
-  maintenanceWindowDow: friday
-  maintenanceWindowTime: 23:00:00
-```
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: Clickhouse
+    metadata:
+      name: my-clickhouse
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      connInfoSecretTarget:
+        name: clickhouse-secret
+        prefix: MY_SECRET_PREFIX_
+        annotations:
+          foo: bar
+        labels:
+          baz: egg
+
+      project: my-aiven-project
+      cloudName: google-europe-west1
+      plan: startup-16
+
+      maintenanceWindowDow: friday
+      maintenanceWindowTime: 23:00:00
+    ```
 
 ## Clickhouse {: #Clickhouse }
 

diff --git a/docs/docs/api-reference/clickhousedatabase.md b/docs/docs/api-reference/clickhousedatabase.md
@@ -4,19 +4,20 @@ title: "ClickhouseDatabase"
 
 ## Usage example
 
-```yaml
-apiVersion: aiven.io/v1alpha1
-kind: ClickhouseDatabase
-metadata:
-  name: my-db
-spec:
-  authSecretRef:
-    name: aiven-token
-    key: token
-
-  project: aiven-project-name
-  serviceName: my-clickhouse
-```
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: ClickhouseDatabase
+    metadata:
+      name: my-db
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      project: aiven-project-name
+      serviceName: my-clickhouse
+    ```
 
 ## ClickhouseDatabase {: #ClickhouseDatabase }
 

diff --git a/docs/docs/api-reference/clickhouserole.md b/docs/docs/api-reference/clickhouserole.md
@@ -4,20 +4,21 @@ title: "ClickhouseRole"
 
 ## Usage example
 
-```yaml
-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
-```
+??? example 
+    ```yaml
+    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
+    ```
 
 ## ClickhouseRole {: #ClickhouseRole }
 

diff --git a/docs/docs/api-reference/clickhouseuser.md b/docs/docs/api-reference/clickhouseuser.md
@@ -4,27 +4,28 @@ title: "ClickhouseUser"
 
 ## Usage example
 
-```yaml
-apiVersion: aiven.io/v1alpha1
-kind: ClickhouseUser
-metadata:
-  name: my-clickhouse-user
-spec:
-  authSecretRef:
-    name: aiven-token
-    key: token
-
-  connInfoSecretTarget:
-    name: clickhouse-user-secret
-    prefix: MY_SECRET_PREFIX_
-    annotations:
-      foo: bar
-    labels:
-      baz: egg
-
-  project: my-aiven-project
-  serviceName: my-clickhouse
-```
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: ClickhouseUser
+    metadata:
+      name: my-clickhouse-user
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      connInfoSecretTarget:
+        name: clickhouse-user-secret
+        prefix: MY_SECRET_PREFIX_
+        annotations:
+          foo: bar
+        labels:
+          baz: egg
+
+      project: my-aiven-project
+      serviceName: my-clickhouse
+    ```
 
 ## ClickhouseUser {: #ClickhouseUser }
 

diff --git a/docs/docs/api-reference/connectionpool.md b/docs/docs/api-reference/connectionpool.md
@@ -4,31 +4,32 @@ title: "ConnectionPool"
 
 ## Usage example
 
-```yaml
-apiVersion: aiven.io/v1alpha1
-kind: ConnectionPool
-metadata:
-  name: my-connection-pool
-spec:
-  authSecretRef:
-    name: aiven-token
-    key: token
-
-  connInfoSecretTarget:
-    name: connection-pool-secret
-    prefix: MY_SECRET_PREFIX_
-    annotations:
-      foo: bar
-    labels:
-      baz: egg
-
-  project: aiven-project-name
-  serviceName: my-service
-  databaseName: my-db
-  username: my-user
-  poolMode: transaction
-  poolSize: 25
-```
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: ConnectionPool
+    metadata:
+      name: my-connection-pool
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      connInfoSecretTarget:
+        name: connection-pool-secret
+        prefix: MY_SECRET_PREFIX_
+        annotations:
+          foo: bar
+        labels:
+          baz: egg
+
+      project: aiven-project-name
+      serviceName: my-service
+      databaseName: my-db
+      username: my-user
+      poolMode: transaction
+      poolSize: 25
+    ```
 
 ## ConnectionPool {: #ConnectionPool }
 

diff --git a/docs/docs/api-reference/database.md b/docs/docs/api-reference/database.md
@@ -4,22 +4,23 @@ title: "Database"
 
 ## Usage example
 
-```yaml
-apiVersion: aiven.io/v1alpha1
-kind: Database
-metadata:
-  name: my-db
-spec:
-  authSecretRef:
-    name: aiven-token
-    key: token
-
-  project: aiven-project-name
-  serviceName: my-service
-
-  lcCtype: en_US.UTF-8
-  lcCollate: en_US.UTF-8
-```
+??? example 
+    ```yaml
+    apiVersion: aiven.io/v1alpha1
+    kind: Database
+    metadata:
+      name: my-db
+    spec:
+      authSecretRef:
+        name: aiven-token
+        key: token
+
+      project: aiven-project-name
+      serviceName: my-service
+
+      lcCtype: en_US.UTF-8
+      lcCollate: en_US.UTF-8
+    ```
 
 ## Database {: #Database }