Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: generate secret commands #773

Merged
merged 1 commit into from
Jun 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/docs/api-reference/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,31 @@ Name Project Region Plan State
my-cassandra aiven-project-name google-europe-west1 startup-4 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret cassandra-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret cassandra-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"CASSANDRA_HOST": "<secret>",
"CASSANDRA_PORT": "<secret>",
"CASSANDRA_USER": "<secret>",
"CASSANDRA_PASSWORD": "<secret>",
"CASSANDRA_URI": "<secret>",
"CASSANDRA_HOSTS": "<secret>",
"CASSANDRA_CA_CERT": "<secret>",
}
```

## Cassandra {: #Cassandra }

Cassandra is the Schema for the cassandras API.
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/api-reference/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,28 @@ Name Project Region Plan State
my-clickhouse my-aiven-project google-europe-west1 startup-16 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret my-clickhouse
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret my-clickhouse -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"CLICKHOUSE_HOST": "<secret>",
"CLICKHOUSE_PORT": "<secret>",
"CLICKHOUSE_USER": "<secret>",
"CLICKHOUSE_PASSWORD": "<secret>",
}
```

## Clickhouse {: #Clickhouse }

Clickhouse is the Schema for the clickhouses API.
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/api-reference/clickhouseuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,28 @@ Name Username Service Name Project
my-clickhouse-user example-username my-clickhouse my-aiven-project
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret clickhouse-user-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret clickhouse-user-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"CLICKHOUSEUSER_HOST": "<secret>",
"CLICKHOUSEUSER_PORT": "<secret>",
"CLICKHOUSEUSER_USER": "<secret>",
"CLICKHOUSEUSER_PASSWORD": "<secret>",
}
```

## ClickhouseUser {: #ClickhouseUser }

ClickhouseUser is the Schema for the clickhouseusers API.
Expand Down
24 changes: 24 additions & 0 deletions docs/docs/api-reference/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,30 @@ Name Project Region Plan State
my-grafana my-aiven-project google-europe-west1 startup-1 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret grafana-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret grafana-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"GRAFANA_HOST": "<secret>",
"GRAFANA_PORT": "<secret>",
"GRAFANA_USER": "<secret>",
"GRAFANA_PASSWORD": "<secret>",
"GRAFANA_URI": "<secret>",
"GRAFANA_HOSTS": "<secret>",
}
```

## Grafana {: #Grafana }

Grafana is the Schema for the grafanas API.
Expand Down
33 changes: 33 additions & 0 deletions docs/docs/api-reference/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,39 @@ Name Project Region Plan State
my-kafka my-aiven-project google-europe-west1 startup-2 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret kafka-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret kafka-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"KAFKA_HOST": "<secret>",
"KAFKA_PORT": "<secret>",
"KAFKA_USERNAME": "<secret>",
"KAFKA_PASSWORD": "<secret>",
"KAFKA_ACCESS_CERT": "<secret>",
"KAFKA_ACCESS_KEY": "<secret>",
"KAFKA_SASL_HOST": "<secret>",
"KAFKA_SASL_PORT": "<secret>",
"KAFKA_SCHEMA_REGISTRY_HOST": "<secret>",
"KAFKA_SCHEMA_REGISTRY_PORT": "<secret>",
"KAFKA_CONNECT_HOST": "<secret>",
"KAFKA_CONNECT_PORT": "<secret>",
"KAFKA_REST_HOST": "<secret>",
"KAFKA_REST_PORT": "<secret>",
"KAFKA_CA_CERT": "<secret>",
}
```

## Kafka {: #Kafka }

Kafka is the Schema for the kafkas API.
Expand Down
27 changes: 27 additions & 0 deletions docs/docs/api-reference/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,33 @@ Name Project Region Plan State
my-mysql my-aiven-project google-europe-west1 business-4 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret mysql-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret mysql-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"MYSQL_HOST": "<secret>",
"MYSQL_PORT": "<secret>",
"MYSQL_DATABASE": "<secret>",
"MYSQL_USER": "<secret>",
"MYSQL_PASSWORD": "<secret>",
"MYSQL_SSL_MODE": "<secret>",
"MYSQL_URI": "<secret>",
"MYSQL_REPLICA_URI": "<secret>",
"MYSQL_CA_CERT": "<secret>",
}
```

## MySQL {: #MySQL }

MySQL is the Schema for the mysqls API.
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/api-reference/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,28 @@ Name Project Region Plan State
my-os my-aiven-project google-europe-west1 startup-4 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret os-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret os-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"OPENSEARCH_HOST": "<secret>",
"OPENSEARCH_PORT": "<secret>",
"OPENSEARCH_USER": "<secret>",
"OPENSEARCH_PASSWORD": "<secret>",
}
```

## OpenSearch {: #OpenSearch }

OpenSearch is the Schema for the opensearches API.
Expand Down
26 changes: 26 additions & 0 deletions docs/docs/api-reference/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,32 @@ Name Project Region Plan State
my-postgresql aiven-project-name google-europe-west1 startup-4 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret postgresql-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret postgresql-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"POSTGRESQL_HOST": "<secret>",
"POSTGRESQL_PORT": "<secret>",
"POSTGRESQL_DATABASE": "<secret>",
"POSTGRESQL_USER": "<secret>",
"POSTGRESQL_PASSWORD": "<secret>",
"POSTGRESQL_SSLMODE": "<secret>",
"POSTGRESQL_DATABASE_URI": "<secret>",
"POSTGRESQL_CA_CERT": "<secret>",
}
```

## PostgreSQL {: #PostgreSQL }

PostgreSQL is the Schema for the postgresql API.
Expand Down
19 changes: 19 additions & 0 deletions docs/docs/api-reference/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,25 @@ Name
my-project
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret project-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret project-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"PROJECT_CA_CERT": "<secret>",
}
```

## Project {: #Project }

Project is the Schema for the projects API.
Expand Down
22 changes: 22 additions & 0 deletions docs/docs/api-reference/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,28 @@ Name Project Region Plan State
k8s-redis my-aiven-project google-europe-west1 startup-4 RUNNING
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret redis-token
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret redis-token -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"REDIS_HOST": "<secret>",
"REDIS_PORT": "<secret>",
"REDIS_USER": "<secret>",
"REDIS_PASSWORD": "<secret>",
}
```

## Redis {: #Redis }

Redis is the Schema for the redis API.
Expand Down
25 changes: 25 additions & 0 deletions docs/docs/api-reference/serviceuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,31 @@ Name Service Name Project
my-service-user my-service-name aiven-project-name
```

To view the details of the `Secret`, use the following command:
```shell
kubectl describe secret service-user-secret
```

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the `Secret`:

```shell
kubectl get secret service-user-secret -o json | jq '.data | map_values(@base64d)'
```

The output is similar to the following:

```{ .json .no-copy }
{
"SERVICEUSER_HOST": "<secret>",
"SERVICEUSER_PORT": "<secret>",
"SERVICEUSER_USERNAME": "<secret>",
"SERVICEUSER_PASSWORD": "<secret>",
"SERVICEUSER_CA_CERT": "<secret>",
"SERVICEUSER_ACCESS_CERT": "<secret>",
"SERVICEUSER_ACCESS_KEY": "<secret>",
}
```

## ServiceUser {: #ServiceUser }

ServiceUser is the Schema for the serviceusers API.
Expand Down
Loading
Loading