KubeLB v1.2 and KubeLB CLI documentation (kubermatic#1970)

* KubeLB v1.2 and KubeLB CLI documentation Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * Ignore autogenerated references for KubeLB CLI Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * Fix typo Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * BGP documentation Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * Fix title in release notes for KubeLB v1.2 Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * Update media for kubelb v1.2 Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * Refactored code Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> * Document gateway to make it easier to configure wildcard domain Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com> --------- Signed-off-by: Waleed Malik <ahmedwaleedmalik@gmail.com>

Author: ahmedwaleedmalik

content/kubelb/main/_index.en.md

@@ -35,7 +35,7 @@ KubeLB solves this problem by providing a centralized management solution that c
 
 - [Introducing KubeLB](https://www.kubermatic.com/products/kubelb/)
 - [KubeLB Whitepaper](https://www.kubermatic.com/static/KubeLB-Cloud-Native-Multi-Tenant-Load-Balancer.pdf)
-- [KubeLB CE](https://github.com/kubermatic/kubelb)
+- [KubeLB - GitHub Repository](https://github.com/kubermatic/kubelb)
 
 Visit [kubermatic.com](https://www.kubermatic.com/) for further information.
 

content/kubelb/main/ce-ee-matrix/_index.en.md

@@ -20,14 +20,20 @@ KubeLB is available in two versions: Community and Enterprise.
 | Ingress | ✔️ | ✔️ |
 | Gateway API v1 | ✔️ | ✔️ |
 | Bring your own secrets(certificates) | ✔️ | ✔️ |
+| Tunneling support through CLI | ✔️ | ❌ |
 | Gateway API beta/alpha(TLS/TCP/UDP routes) | ✔️ | ❌ |
 | Multiple Gateways | ✔️ | ❌ |
 | DNS automation | ✔️ | ❌ |
 | Certificate Management | ✔️ | ❌ |
 | Limits for LoadBalancers, Gateways | ✔️ | ❌ |
 
 {{% notice note %}}
-KubeLB support [ingress-nginx](https://kubernetes.github.io/ingress-nginx/) for **Ingress** resources. [Envoy Gateway](https://gateway.envoyproxy.io/) is supported for **Gateway API** resources. While other products might work for Ingress and Gateway API resources, we are not testing them and can't guarantee the compatibility.
+KubeLB supports the following products for Ingress and Gateway API resources:
+
+- [Ingress-nginx](https://kubernetes.github.io/ingress-nginx/) for **Ingress** resources.
+- [Envoy Gateway](https://gateway.envoyproxy.io/) is supported for **Gateway API** resources.
+
+While other products might work for Ingress and Gateway API resources, we are not testing them and can't guarantee the compatibility.
 {{% /notice %}}
 
 ## Support Policy

content/kubelb/main/cli/_index.en.md

@@ -0,0 +1,62 @@
++++
+title = "KubeLB CLI"
+date = 2025-08-27T10:07:15+02:00
+weight = 30
+description = "Learn how you can use KubeLB CLI to provision Load Balancers and tunnels to expose local workloads"
++++
+
+![KubeLB CLI](/img/kubelb/common/logo.png?classes=logo-height)
+
+## KubeLB CLI
+
+KubeLB CLI is a command line tool that has been introduced to complement KubeLB and make it easier to manage load balancing configurations for multiple tenants in Kube and non-Kube based environments.
+
+The source code is open source and available at [kubermatic/kubelb-cli](https://github.com/kubermatic/kubelb-cli).
+
+{{% notice note %}}
+KubeLB CLI is currently in beta feature stage and is not yet ready for production use. We are actively working on the feature set and taking feedback from the community and our customers to improve the CLI.
+{{% /notice %}}
+
+## Installation
+
+### Manual Installation
+
+Users can download the pre-compiled binaries from the [releases page](https://github.com/kubermatic/kubelb-cli/releases) for their system and copy them to the desired location.
+
+{{% notice note %}}
+KubeLB CLI is currently available for Linux, macOS, and Windows.
+{{% /notice %}}
+
+### Install using `go install`
+
+If you have Go installed, you can also build the binary from the source code using the following command:
+
+```bash
+go install github.com/kubermatic/kubelb-cli@v0.1.0
+```
+
+### Configuration
+
+KubeLB CLI needs the tenant scoped kubeconfig and the tenant name to be configured either via environment variables or through the CLI flags. Environment variables are preferred as you don't have to specify them for each command.
+
+```bash
+export KUBECONFIG=/path/to/kubeconfig
+export TENANT_NAME=my-tenant
+```
+
+## Table of Content
+
+{{% children depth=5 %}}
+{{% /children %}}
+
+## Further Information
+
+- [Introducing KubeLB](https://www.kubermatic.com/products/kubelb/)
+- [KubeLB Whitepaper](https://www.kubermatic.com/static/KubeLB-Cloud-Native-Multi-Tenant-Load-Balancer.pdf)
+- [KubeLB - GitHub Repository](https://github.com/kubermatic/kubelb)
+
+Visit [kubermatic.com](https://www.kubermatic.com/) for further information.
+
+{{% notice tip %}}
+For latest updates follow us on Twitter [@Kubermatic](https://twitter.com/Kubermatic)
+{{% /notice %}}

content/kubelb/main/cli/compatibility-matrix/_index.en.md

@@ -0,0 +1,21 @@
++++
+title = "Compatibility Matrix"
+date = 2025-08-27T00:00:00+01:00
+weight = 30
++++
+
+KubeLB CLI uses Kubernetes management cluster that has KubeLB installed as it's source of truth for the load balancing configurations.
+
+Since it has been introduced alongside KubeLB v1.2, it has a hard dependency for the KubeLB management cluster to be at least v1.2.
+
+{{% notice note %}}
+KubeLB CLI is currently in beta feature stage and is not yet ready for production use. We are actively working on the feature set and taking feedback from the community and our customers to improve the CLI.
+{{% /notice %}}
+
+| KubeLB CLI | KubeLB Management Cluster |
+|------------|---------------------------|
+| v0.1.0 | v1.2+ |
+
+## Support Policy
+
+For support policy, please refer to the [KubeLB Support Policy](../../support-policy/)

content/kubelb/main/cli/loadbalancing/_index.en.md

@@ -0,0 +1,36 @@
++++
+title = "Load Balancing"
+date = 2025-08-27T00:00:00+01:00
+weight = 20
++++
+
+KubeLB CLI can be used to quickly provision Load Balancers that can be public/private based on your load balancing configurations and needs. KubeLB then takes care of securing your endpoint with TLS certificates, automatically creating DNS records, and managing the load balancing configurations.
+
+## Pre-requisites
+
+Please refer to the [DNS](../../tutorials/security/dns/#enable-dns-automation) documentation to configure the Gateway or Ingress to manage DNS for the load balancer.
+
+## Create a Load Balancer
+
+To create a load balancer, you can use the `kubelb loadbalancer create` command.
+
+For example
+
+```bash
+kubelb loadbalancer create my-app --endpoints 10.0.1.1:8080,10.0.1.2:8080 --hostname my-app.example.com
+```
+
+This will create a Load Balancer resource that will forward traffic to the endpoints `10.0.1.1:8080` and `10.0.1.2:8080` and will be accessible at `https://my-app.example.com`.
+
+Specifying hostname is optional and if not provided, KubeLB will generate a random hostname for you if the wildcard domain is enabled for the tenant or globally.
+
+![Demo animation](/img/kubelb/v1.2/loadbalancer.gif?classes=shadow,border "Load Balancer Demo")
+
+## Further actions
+
+Further actions include:
+
+- Updating the load balancer configuration
+- Deleting the load balancer
+- Getting the load balancer details
+- Listing all the load balancers

content/kubelb/main/cli/references/_index.en.md

@@ -0,0 +1,40 @@
++++
+title = "References"
+date = 2024-03-06T12:00:00+02:00
+weight = 50
++++
+
+This section contains a reference of the Kubermatic KubeLB CLI commands and flags.
+
+## kubelb
+
+KubeLB CLI - Manage load balancers and create secure tunnels
+
+### Synopsis
+
+KubeLB CLI provides tools to manage KubeLB load balancers and create secure tunnels
+to expose local services through the KubeLB infrastructure.
+
+### Options
+
+```
+ -h, --help help for kubelb
+ --kubeconfig string Path to the kubeconfig for the tenant
+ --log-file string Log to file instead of stderr
+ --log-format string Log format (cli, json, text) - defaults to cli
+ --log-level string Log level (error, warn, info, debug, trace) - overrides verbosity
+ -q, --quiet Suppress non-essential output (equivalent to --v=0)
+ -t, --tenant string Name of the tenant
+ --timeout duration Timeout for the command (e.g., 30s, 5m) (default 4m0s)
+ -v, --v int Verbosity level (0-4): 0=errors only, 1=basic info, 2=detailed status, 3=debug info, 4=trace (default 1)
+```
+
+### SEE ALSO
+
+* [kubelb completion](commands/kubelb_completion) - Generate the autocompletion script for the specified shell
+* [kubelb docs](commands/kubelb_docs) - Generate markdown documentation for all commands
+* [kubelb expose](commands/kubelb_expose) - Expose a local port via tunnel
+* [kubelb loadbalancer](commands/kubelb_loadbalancer) - Manage KubeLB load balancers
+* [kubelb status](commands/kubelb_status) - Display current status of KubeLB
+* [kubelb tunnel](commands/kubelb_tunnel) - Manage secure tunnels to expose local services
+* [kubelb version](commands/kubelb_version) - Print the version information

content/kubelb/main/cli/references/commands/kubelb_completion.md

@@ -0,0 +1,41 @@
++++
+title = "kubelb completion"
+date = 2025-08-27T00:00:00+01:00
+weight = 200
++++
+
+## kubelb completion
+
+Generate the autocompletion script for the specified shell
+
+### Synopsis
+
+Generate the autocompletion script for kubelb for the specified shell.
+See each sub-command's help for details on how to use the generated script.
+
+### Options
+
+```
+ -h, --help help for completion
+```
+
+### Options inherited from parent commands
+
+```
+ --kubeconfig string Path to the kubeconfig for the tenant
+ --log-file string Log to file instead of stderr
+ --log-format string Log format (cli, json, text) - defaults to cli
+ --log-level string Log level (error, warn, info, debug, trace) - overrides verbosity
+ -q, --quiet Suppress non-essential output (equivalent to --v=0)
+ -t, --tenant string Name of the tenant
+ --timeout duration Timeout for the command (e.g., 30s, 5m) (default 4m0s)
+ -v, --v int Verbosity level (0-4): 0=errors only, 1=basic info, 2=detailed status, 3=debug info, 4=trace (default 1)
+```
+
+### SEE ALSO
+
+* [kubelb](../kubelb) - KubeLB CLI - Manage load balancers and create secure tunnels
+* [kubelb completion bash](../kubelb_completion_bash) - Generate the autocompletion script for bash
+* [kubelb completion fish](../kubelb_completion_fish) - Generate the autocompletion script for fish
+* [kubelb completion powershell](../kubelb_completion_powershell) - Generate the autocompletion script for powershell
+* [kubelb completion zsh](../kubelb_completion_zsh) - Generate the autocompletion script for zsh

content/kubelb/main/cli/references/commands/kubelb_completion_bash.md

@@ -0,0 +1,60 @@
++++
+title = "kubelb completion bash"
+date = 2025-08-27T00:00:00+01:00
+weight = 210
++++
+
+## kubelb completion bash
+
+Generate the autocompletion script for bash
+
+### Synopsis
+
+Generate the autocompletion script for the bash shell.
+
+This script depends on the 'bash-completion' package.
+If it is not installed already, you can install it via your OS's package manager.
+
+To load completions in your current shell session:
+
+ source <(kubelb completion bash)
+
+To load completions for every new session, execute once:
+
+#### Linux
+
+ kubelb completion bash > /etc/bash_completion.d/kubelb
+
+#### macOS
+
+ kubelb completion bash > $(brew --prefix)/etc/bash_completion.d/kubelb
+
+You will need to start a new shell for this setup to take effect.
+
+```
+kubelb completion bash
+```
+
+### Options
+
+```
+ -h, --help help for bash
+ --no-descriptions disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+ --kubeconfig string Path to the kubeconfig for the tenant
+ --log-file string Log to file instead of stderr
+ --log-format string Log format (cli, json, text) - defaults to cli
+ --log-level string Log level (error, warn, info, debug, trace) - overrides verbosity
+ -q, --quiet Suppress non-essential output (equivalent to --v=0)
+ -t, --tenant string Name of the tenant
+ --timeout duration Timeout for the command (e.g., 30s, 5m) (default 4m0s)
+ -v, --v int Verbosity level (0-4): 0=errors only, 1=basic info, 2=detailed status, 3=debug info, 4=trace (default 1)
+```
+
+### SEE ALSO
+
+* [kubelb completion](../kubelb_completion) - Generate the autocompletion script for the specified shell

content/kubelb/main/cli/references/commands/kubelb_completion_fish.md

@@ -0,0 +1,51 @@
++++
+title = "kubelb completion fish"
+date = 2025-08-27T00:00:00+01:00
+weight = 220
++++
+
+## kubelb completion fish
+
+Generate the autocompletion script for fish
+
+### Synopsis
+
+Generate the autocompletion script for the fish shell.
+
+To load completions in your current shell session:
+
+ kubelb completion fish | source
+
+To load completions for every new session, execute once:
+
+ kubelb completion fish > ~/.config/fish/completions/kubelb.fish
+
+You will need to start a new shell for this setup to take effect.
+
+```
+kubelb completion fish [flags]
+```
+
+### Options
+
+```
+ -h, --help help for fish
+ --no-descriptions disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+ --kubeconfig string Path to the kubeconfig for the tenant
+ --log-file string Log to file instead of stderr
+ --log-format string Log format (cli, json, text) - defaults to cli
+ --log-level string Log level (error, warn, info, debug, trace) - overrides verbosity
+ -q, --quiet Suppress non-essential output (equivalent to --v=0)
+ -t, --tenant string Name of the tenant
+ --timeout duration Timeout for the command (e.g., 30s, 5m) (default 4m0s)
+ -v, --v int Verbosity level (0-4): 0=errors only, 1=basic info, 2=detailed status, 3=debug info, 4=trace (default 1)
+```
+
+### SEE ALSO
+
+* [kubelb completion](../kubelb_completion) - Generate the autocompletion script for the specified shell

content/kubelb/main/cli/references/commands/kubelb_completion_powershell.md

@@ -0,0 +1,48 @@
++++
+title = "kubelb completion powershell"
+date = 2025-08-27T00:00:00+01:00
+weight = 230
++++
+
+## kubelb completion powershell
+
+Generate the autocompletion script for powershell
+
+### Synopsis
+
+Generate the autocompletion script for powershell.
+
+To load completions in your current shell session:
+
+ kubelb completion powershell | Out-String | Invoke-Expression
+
+To load completions for every new session, add the output of the above command
+to your powershell profile.
+
+```
+kubelb completion powershell [flags]
+```
+
+### Options
+
+```
+ -h, --help help for powershell
+ --no-descriptions disable completion descriptions
+```
+
+### Options inherited from parent commands
+
+```
+ --kubeconfig string Path to the kubeconfig for the tenant
+ --log-file string Log to file instead of stderr
+ --log-format string Log format (cli, json, text) - defaults to cli
+ --log-level string Log level (error, warn, info, debug, trace) - overrides verbosity
+ -q, --quiet Suppress non-essential output (equivalent to --v=0)
+ -t, --tenant string Name of the tenant
+ --timeout duration Timeout for the command (e.g., 30s, 5m) (default 4m0s)
+ -v, --v int Verbosity level (0-4): 0=errors only, 1=basic info, 2=detailed status, 3=debug info, 4=trace (default 1)
+```
+
+### SEE ALSO
+
+* [kubelb completion](../kubelb_completion) - Generate the autocompletion script for the specified shell