diff --git a/k8s/index.mdx b/k8s/index.mdx index 3dea754ad9..6b59ad627a 100644 --- a/k8s/index.mdx +++ b/k8s/index.mdx @@ -3,22 +3,30 @@ title: Kubernetes Operator sidebarTitle: Overview --- -The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. +## What is the Kubernetes Operator? + +The ngrok Kubernetes Operator is the best way to use ngrok if your applications run in Kubernetes environments. +It comes with custom resources for configuration and also supports both Ingress resources as well as the new cross-platform Gateway API configuration resources. +When using Kubernetes Ingresses or the Gateway API resources, the ngrok Kubernetes Operator will translate them into managed instances of the ngrok custom resources for you. The ngrok Kubernetes Operator is deployed to a cluster and allows developers to self-service endpoints to their apps and services using a shared ngrok account. Check out the [how it works](/k8s/how-it-works) and [architecture](/k8s/installation/architecture) pages for more info on how the operator functions. -## When Should I Use The ngrok Kubernetes Operator? +## Features + +TK + +## Use cases You should use the ngrok Kubernetes Operator if you want to: -1. Send traffic to your Kubernetes workloads -1. Integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok -1. Perform cross-cluster networking -1. Use Kubernetes with ngrok without using ngrok's SDKs +- Send traffic to your Kubernetes workloads +- Integrate Kubernetes workloads with workloads outside of Kubernetes, such as those running on virtual machines, bare metal, embedded devices, and anywhere else you can run ngrok +- Perform cross-cluster networking +- Use Kubernetes with ngrok without using ngrok's SDKs -## What Type of Config Can I Use With The Operator? +## Configuration The Operator supports its own native custom resource types, including: @@ -40,3 +48,7 @@ controller incur a cost. More details can be found on our [pricing page](https:/ [Kubernetes Ingress docs]: https://kubernetes.io/docs/concepts/services-networking/ingress/ [Gateway API docs]: https://gateway-api.sigs.k8s.io/ + +## What's next + +TK