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: add secret dependency warning #779

Merged
merged 1 commit into from
Jul 3, 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
3 changes: 3 additions & 0 deletions docs/docs/api-reference/cassandra.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ title: "Cassandra"
- network: 10.20.0.0/16
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/clickhouse.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ title: "Clickhouse"
maintenanceWindowTime: 23:00:00
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/clickhousedatabase.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ title: "ClickhouseDatabase"
databaseName: example-db
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/clickhousegrant.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ title: "ClickhouseGrant"
- role: my-role
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/clickhouserole.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ title: "ClickhouseRole"
role: my-role
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/clickhouseuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ title: "ClickhouseUser"
plan: startup-16
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/connectionpool.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ title: "ConnectionPool"
serviceName: my-pg
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ title: "Database"
lcCollate: en_US.UTF-8
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/grafana.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ title: "Grafana"
- network: 10.20.0.0/16
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ title: "Kafka"
maintenanceWindowTime: 23:00:00
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/kafkaacl.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ title: "KafkaACL"
permission: admin
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/kafkaconnect.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ title: "KafkaConnect"
kafka_connect: true
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/kafkaschema.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ title: "KafkaSchema"
}
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/kafkaschemaregistryacl.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ title: "KafkaSchemaRegistryACL"
permission: schema_registry_read
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/kafkatopic.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,9 @@ title: "KafkaTopic"
min_cleanable_dirty_ratio: 0.2
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/mysql.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ title: "MySQL"
- network: 10.20.0.0/16
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/opensearch.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ title: "OpenSearch"
maintenanceWindowTime: 23:00:00
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/postgresql.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ title: "PostgreSQL"
pg_version: "15"
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ title: "Project"
cloud: aws-eu-west-1
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/projectvpc.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ title: "ProjectVPC"
networkCidr: 10.0.0.0/24
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/redis.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ title: "Redis"
redis_maxmemory_policy: allkeys-random
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/serviceintegration.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,9 @@ title: "ServiceIntegration"
partitions: 1
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/serviceintegrationendpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ title: "ServiceIntegrationEndpoint"
basic_auth_password: password
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
3 changes: 3 additions & 0 deletions docs/docs/api-reference/serviceuser.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ title: "ServiceUser"
serviceName: my-service-name
```

!!! info
To create this resource, a `Secret` containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

```shell
Expand Down
9 changes: 5 additions & 4 deletions docs/docs/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ weight: 10
---

To get authenticated and authorized, set up the communication between the Aiven Operator for Kubernetes and Aiven by
using a token stored in a Kubernetes Secret. You can then refer to the Secret name on every custom resource in
using a token stored in a Kubernetes Secret. You can then refer to the `Secret` name on every custom resource in
the `authSecretRef` field.

**If you don't have an Aiven account yet, sign
up [here](https://console.aiven.io/signup?utm_source=github&utm_medium=organic&utm_campaign=k8s-operator&utm_content=signup)
for a free trial. 🦀**
!!! important
If you don't have an Aiven account yet, sign
up [here](https://console.aiven.io/signup?utm_source=github&utm_medium=organic&utm_campaign=k8s-operator&utm_content=signup)
for a free trial 🦀

1\. Generate an authentication token

Expand Down
45 changes: 26 additions & 19 deletions generators/docs/generator.go
Original file line number Diff line number Diff line change
Expand Up @@ -421,9 +421,12 @@ var templateFuncs = template.FuncMap{
"indent": func(i int, src string) string {
return reIndent.ReplaceAllString(src, strings.Repeat(" ", i))
},
"backtick": func(i int) string {
"code": func(s string) string {
return fmt.Sprintf("`%s`", s)
},
"codeblock": func() string {
// we can't use backticks in go strings, so we render them
return strings.Repeat("`", i)
return "```"
},
"rfill": rfill,
}
Expand All @@ -437,51 +440,55 @@ title: "{{ .Kind }}"

{{ range .UsageExamples }}
??? example {{ if .Title }}"{{ .Title }}"{{ end }}
{{ backtick 3 }}yaml
{{ codeblock }}yaml
{{ .Value | indent 4 }}
{{ backtick 3 }}
{{ codeblock }}
{{ end }}

{{ $example := .GetExample }}
{{ if $example }}

!!! info
To create this resource, a {{ code "Secret" }} containing Aiven token must be [created](/aiven-operator/authentication.html) first.

Apply the resource with:

{{ backtick 3 }}shell
{{ codeblock }}shell
kubectl apply -f example.yaml
{{ backtick 3 }}
{{ codeblock }}

Verify the newly created {{ backtick 1 }}{{ .Kind }}{{ backtick 1 }}:
Verify the newly created {{ code .Kind }}:

{{ backtick 3 }}shell
{{ codeblock }}shell
kubectl get {{ .Plural }} {{ $example.Metadata.Name }}
{{ backtick 3 }}
{{ codeblock }}

The output is similar to the following:
{{ backtick 3 }}shell
{{ codeblock }}shell
{{ range $example.Table }}{{ rfill .Title .Value }} {{ end }}
{{ range $example.Table }}{{ rfill .Value .Title }} {{ end }}
{{ backtick 3 }}
{{ codeblock }}

{{ if $example.Secret.Name }}
To view the details of the {{ backtick 1 }}Secret{{ backtick 1 }}, use the following command:
{{ backtick 3 }}shell
To view the details of the {{ code "Secret" }}, use the following command:
{{ codeblock }}shell
kubectl describe secret {{ $example.Secret.Name }}
{{ backtick 3 }}
{{ codeblock }}

You can use the [jq](https://github.com/jqlang/jq) to quickly decode the {{ backtick 1 }}Secret{{ backtick 1 }}:
You can use the [jq](https://github.com/jqlang/jq) to quickly decode the {{ code "Secret" }}:

{{ backtick 3 }}shell
{{ codeblock }}shell
kubectl get secret {{ $example.Secret.Name }} -o json | jq '.data | map_values(@base64d)'
{{ backtick 3 }}
{{ codeblock }}

The output is similar to the following:

{{ backtick 3 }}{ .json .no-copy }
{{ codeblock }}{ .json .no-copy }
{
{{- range $example.Secret.Keys }}
"{{ . }}": "<secret>",{{ end }}
}
{{ backtick 3 }}
{{ codeblock }}

{{ end }}

Expand Down
Loading