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.

Sign up for GitHub

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

Jump to bottom

fix: broken link for K8s docs #495

Merged
merged 2 commits into from
Oct 9, 2024
Merged

fix: broken link for K8s docs #495

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e3f6b1
fix: broken link for K8s docs
staceysalamon-aiven Oct 9, 2024
dfaae31
fix formatting
staceysalamon-aiven Oct 9, 2024
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
22 changes: 12 additions & 10 deletions docs/tools/kubernetes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,15 @@
title: Aiven Operator for Kubernetes®
---

Aiven Operator for [Kubernetes®](https://kubernetes.io/) allows users to manage Aiven services through the Kubernetes® API by using [Custom Resource Definitions (CRD)](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/).
Manage Aiven services with [Aiven Operator for Kubernetes®](https://aiven.github.io/aiven-operator/) by using [Custom Resource Definitions (CRD)](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/).

:::note[Supported services]
Aiven Operator for Kubernetes® supports:

- Aiven for Apache Kafka®
- Aiven for Caching
- Aiven for ClickHouse®
- Aiven for OpenSearch®
- Aiven for PostgreSQL®
:::

## Get started

Expand All @@ -22,15 +20,17 @@ database.
### Requirements

- You have access to a Kubernetes cluster where you can run the operator.
- You have an Aiven account. If you don't have one yet, [sign up for free](https://console.aiven.io/signup).
- You have an Aiven account. If you don't have one yet,
[sign up for free](https://console.aiven.io/signup).
- To use the operator locally, we recommend using [**kind**](https://kind.sigs.k8s.io/).
See [the installation guide](https://kind.sigs.k8s.io/docs/user/quick-start/#installation).
- To install the operator, we recommend [**Helm**](https://helm.sh/).
See the [installation guide](https://helm.sh/docs/intro/install/).

### Install the Kubernetes® operator

1. Optional: To manage the webhook TLS certificates used by our operator, install the `cert-manager`:
1. Optional: To manage the webhook TLS certificates used by our operator,
install the `cert-manager`:

```bash
kubectl apply -f https://github.com/jetstack/cert-manager/releases/latest/download/cert-manager.yaml
Expand All @@ -43,7 +43,8 @@ database.

:::note
- For GKE version >= 1.21 VPC users, add a firewall rule to explicitly allow
ingress to port 9443 for admission webhook. See [the Google Cloud docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules).
ingress to port 9443 for admission webhook. See
[the Google Cloud docs](https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules).

- If you are running a GKE _Autopilot_ cluster in Google Cloud Platform,
use GKE version >=1.21 and install `cert-manager`
Expand Down Expand Up @@ -95,9 +96,9 @@ Your pod's status should be `Running`.

Before creating a service, authenticate the operator with Aiven's API:

1. [Create an Aiven token](/docs/platform/howto/create_authentication_token).
1. Create the Kubernetes secret in the namespace which is going to be used to create your Aiven
services:
1. [Create a token](/docs/platform/howto/create_authentication_token).
1. Create the Kubernetes secret in the namespace which is going to be used
to create your Aiven services:

```bash
kubectl create secret generic aiven-token --from-literal=token="<your-token>"
Expand Down Expand Up @@ -219,5 +220,6 @@ kubectl delete -f https://github.com/jetstack/cert-manager/releases/latest/downl

## Related links

- [Aiven Operator for Kubernetes repository](https://github.io/aiven-operator)
- [Aiven Operator for Kubernetes repository](https://github.com/aiven/aiven-operator/)
- [Aiven Operator examples](https://aiven.github.io/aiven-operator/resources/project.html)
- [Kubernetes Basics](https://kubernetes.io/docs/tutorials/kubernetes-basics/)