Skip to content

Commit

Permalink
docs: generate usage commands (#768)
Browse files Browse the repository at this point in the history
  • Loading branch information
byashimov authored Jun 25, 2024
1 parent 4d240ca commit 5ead138
Show file tree
Hide file tree
Showing 25 changed files with 550 additions and 4 deletions.
18 changes: 18 additions & 0 deletions docs/docs/api-reference/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,24 @@ title: "Cassandra"
- network: 10.20.0.0/16
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `Cassandra`:

```shell
kubectl get cassandras my-cassandra
```

The output is similar to the following:
```shell
Name Project Region Plan State
my-cassandra aiven-project-name google-europe-west1 startup-4 RUNNING
```

## Cassandra {: #Cassandra }

Cassandra is the Schema for the cassandras API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,24 @@ title: "Clickhouse"
maintenanceWindowTime: 23:00:00
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `Clickhouse`:

```shell
kubectl get clickhouses my-clickhouse
```

The output is similar to the following:
```shell
Name Project Region Plan State
my-clickhouse my-aiven-project google-europe-west1 startup-16 RUNNING
```

## Clickhouse {: #Clickhouse }

Clickhouse is the Schema for the clickhouses API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/clickhousedatabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,24 @@ title: "ClickhouseDatabase"
databaseName: example-db
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `ClickhouseDatabase`:

```shell
kubectl get clickhousedatabases my-db
```

The output is similar to the following:
```shell
Name Database name Service Name Project
my-db example-db my-clickhouse my-aiven-project
```

## ClickhouseDatabase {: #ClickhouseDatabase }

ClickhouseDatabase is the Schema for the databases API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/clickhousegrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,24 @@ title: "ClickhouseGrant"
- role: my-role
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `ClickhouseGrant`:

```shell
kubectl get clickhousegrants demo-ch-grant
```

The output is similar to the following:
```shell
Name Project Service Name
demo-ch-grant my-aiven-project my-clickhouse
```

## ClickhouseGrant {: #ClickhouseGrant }

ClickhouseGrant is the Schema for the ClickhouseGrants API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/clickhouserole.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,24 @@ title: "ClickhouseRole"
role: my-role
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `ClickhouseRole`:

```shell
kubectl get clickhouseroles my-role
```

The output is similar to the following:
```shell
Name Project Service Name Role
my-role my-aiven-project my-clickhouse my-role
```

## ClickhouseRole {: #ClickhouseRole }

ClickhouseRole is the Schema for the clickhouseroles API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/clickhouseuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,24 @@ title: "ClickhouseUser"
plan: startup-16
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `ClickhouseUser`:

```shell
kubectl get clickhouseusers my-clickhouse-user
```

The output is similar to the following:
```shell
Name Username Service Name Project
my-clickhouse-user example-username my-clickhouse my-aiven-project
```

## ClickhouseUser {: #ClickhouseUser }

ClickhouseUser is the Schema for the clickhouseusers API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/connectionpool.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,24 @@ title: "ConnectionPool"
serviceName: my-pg
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `ConnectionPool`:

```shell
kubectl get connectionpools my-connection-pool
```

The output is similar to the following:
```shell
Name Service Name Project Database Username Pool Size Pool Mode
my-connection-pool my-pg aiven-project-name my-database my-service-user 25 transaction
```

## ConnectionPool {: #ConnectionPool }

ConnectionPool is the Schema for the connectionpools API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,24 @@ title: "Database"
lcCollate: en_US.UTF-8
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `Database`:

```shell
kubectl get databases my-db
```

The output is similar to the following:
```shell
Name Project Service Name
my-db aiven-project-name my-service
```

## Database {: #Database }

Database is the Schema for the databases API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,24 @@ title: "Grafana"
- network: 10.20.0.0/16
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `Grafana`:

```shell
kubectl get grafanas my-grafana
```

The output is similar to the following:
```shell
Name Project Region Plan State
my-grafana my-aiven-project google-europe-west1 startup-1 RUNNING
```

## Grafana {: #Grafana }

Grafana is the Schema for the grafanas API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@ title: "Kafka"
maintenanceWindowTime: 23:00:00
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `Kafka`:

```shell
kubectl get kafkas my-kafka
```

The output is similar to the following:
```shell
Name Project Region Plan State
my-kafka my-aiven-project google-europe-west1 startup-2 RUNNING
```

## Kafka {: #Kafka }

Kafka is the Schema for the kafkas API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/kafkaacl.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,24 @@ title: "KafkaACL"
permission: admin
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `KafkaACL`:

```shell
kubectl get kafkaacls my-kafka-acl
```

The output is similar to the following:
```shell
Name Service Name Project Username Permission Topic
my-kafka-acl my-kafka my-aiven-project my-user admin my-topic
```

## KafkaACL {: #KafkaACL }

KafkaACL is the Schema for the kafkaacls API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/kafkaconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,24 @@ title: "KafkaConnect"
kafka_connect: true
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `KafkaConnect`:

```shell
kubectl get kafkaconnects my-kafka-connect
```

The output is similar to the following:
```shell
Name Project Region Plan State
my-kafka-connect my-aiven-project google-europe-west1 business-4 RUNNING
```

## KafkaConnect {: #KafkaConnect }

KafkaConnect is the Schema for the kafkaconnects API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/kafkaschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,24 @@ title: "KafkaSchema"
}
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `KafkaSchema`:

```shell
kubectl get kafkaschemas my-schema
```

The output is similar to the following:
```shell
Name Service Name Project Subject Compatibility Level Version
my-schema my-kafka my-aiven-project mny-subject BACKWARD <version>
```

## KafkaSchema {: #KafkaSchema }

KafkaSchema is the Schema for the kafkaschemas API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/kafkaschemaregistryacl.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,24 @@ title: "KafkaSchemaRegistryACL"
permission: schema_registry_read
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `KafkaSchemaRegistryACL`:

```shell
kubectl get kafkaschemaregistryacls my-kafka-schema-registry-acl
```

The output is similar to the following:
```shell
Name Project Service Name Resource Username State
my-kafka-schema-registry-acl aiven-project-name my-kafka Subject:my-topic my-user RUNNING
```

## KafkaSchemaRegistryACL {: #KafkaSchemaRegistryACL }

KafkaSchemaRegistryACL is the Schema for the kafkaschemaregistryacls API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/kafkatopic.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,24 @@ title: "KafkaTopic"
min_cleanable_dirty_ratio: 0.2
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `KafkaTopic`:

```shell
kubectl get kafkatopics kafka-topic
```

The output is similar to the following:
```shell
Name Service Name Project Partitions Replication
kafka-topic my-kafka my-aiven-project 1 2
```

## KafkaTopic {: #KafkaTopic }

KafkaTopic is the Schema for the kafkatopics API.
Expand Down
18 changes: 18 additions & 0 deletions docs/docs/api-reference/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,24 @@ title: "MySQL"
- network: 10.20.0.0/16
```

Apply the resource with:

```shell
kubectl apply -f example.yaml
```

Verify the newly created `MySQL`:

```shell
kubectl get mysqls my-mysql
```

The output is similar to the following:
```shell
Name Project Region Plan State
my-mysql my-aiven-project google-europe-west1 business-4 RUNNING
```

## MySQL {: #MySQL }

MySQL is the Schema for the mysqls API.
Expand Down
Loading

0 comments on commit 5ead138

Please sign in to comment.