Skip to content

Commit

Permalink
doc: Restructure Kubernetes docs
Browse files Browse the repository at this point in the history
  • Loading branch information
happyRip committed Dec 18, 2023
1 parent e1967b7 commit 851be69
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 19 deletions.
23 changes: 8 additions & 15 deletions doc/content/the-things-stack/host/kubernetes/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,20 @@
title: "Kubernetes"
description: ""
weight: 3
aliases: [/getting-started/kubernetes]
---

{{% tts %}} is packaged as a [Helm Chart](https://helm.sh/) to be run on Kubernetes Clusters. {{% tts %}} Helm charts are packaged and distributed as [OCI packages](https://helm.sh/docs/topics/registries/) and are published to [Docker Hub](https://hub.docker.com/r/thethingsindustries/lorawan-stack-helm-chart).
This guide is meant for users who want to deploy {{% tts %}} on Kubernetes.

This guide helps the user to install and configure {{% tts %}} on a Kubernetes cluster.
<!--more-->

Operating The Things Stack on a Kubernetes cluster is only meant for advanced users with sufficient experience with the chosen infrastructure platform and with Kubernetes.
{{% tts %}} is currently available as two flavours for self-hosting on Kubernetes.

{{< warning >}} Until the release of v1.0.0, all versions are considered to be in the Alpha stage and are not suitable for production use. The Things Industries does not offer any guarantees on compatibility between the Alpha versions. {{</ warning >}}
1. Generic

{{< note "Make sure to follow each section of this guide in the same order as it is written without skipping any steps." />}}
- {{% tts %}} packaged as a Helm Chart with no infrastructure provided.

## UDP Gateway Support
2. Azure

UDP gateways require connection stickiness in order to continue communicating with Gateway Server instances when they get recreated or when the nodes on which Gateway Servers are running are replaced. The most straightforward way to do this is to connect UDP gateways directly to the Gateway Server service via an external Load Balancer.
This depends on the settings of the external Load Balancer that is used. The implementation details are specific to the external environment and is hence out of scope for this documentation.
Please check the documentation of the Load Balancer and run tests to ensure that gateway communication is not lost on server updates.
- {{% tts %}} deployment on Azure Kubernetes Service with Azure supporting infrastructure.

## Kubernetes Version Support

||Kubernetes v1.21 and above|
|---|---|
|Chart v1.0.0 and below (alpha)|[x]|
Read more in the following sections.
3 changes: 2 additions & 1 deletion doc/content/the-things-stack/host/kubernetes/azure/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: "Azure"
description: ""
weight: 1
distributions: "Enterprise"
weight: 2
---

{{% tts %}} can be deployed to [Azure](https://portal.azure.com/) as a set of highly available services on Azure Kubernetes Service using Terraform and Helm.
Expand Down
27 changes: 24 additions & 3 deletions doc/content/the-things-stack/host/kubernetes/generic/_index.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,30 @@
---
title: "Generic"
description: ""
weight: 2
distributions: "Enterprise"
weight: 1
---

This guide is meant for users who want to deploy {{% tts %}} on Kubernetes with self-hosted infrastructure. It gives an overview of the Helm charts and the steps required to deploy them.
{{% tts %}} is packaged as a [Helm Chart](https://helm.sh/) to be run on Kubernetes Clusters. {{% tts %}} Helm charts are packaged and distributed as [OCI packages](https://helm.sh/docs/topics/registries/) and are published to [Docker Hub](https://hub.docker.com/r/thethingsindustries/lorawan-stack-helm-chart).

<!--more-->
This guide helps the user to install and configure {{% tts %}} on a Kubernetes cluster.

<!-- more -->

Operating The Things Stack on a Kubernetes cluster is only meant for advanced users with sufficient experience with the chosen infrastructure platform and with Kubernetes.

{{< warning >}} Until the release of v1.0.0, all versions are considered to be in the Alpha stage and are not suitable for production use. The Things Industries does not offer any guarantees on compatibility between the Alpha versions. {{</ warning >}}

{{< note "Make sure to follow each section of this guide in the same order as it is written without skipping any steps." />}}

## UDP Gateway Support

UDP gateways require connection stickiness in order to continue communicating with Gateway Server instances when they get recreated or when the nodes on which Gateway Servers are running are replaced. The most straightforward way to do this is to connect UDP gateways directly to the Gateway Server service via an external Load Balancer.
This depends on the settings of the external Load Balancer that is used. The implementation details are specific to the external environment and is hence out of scope for this documentation.
Please check the documentation of the Load Balancer and run tests to ensure that gateway communication is not lost on server updates.

## Kubernetes Version Support

| | Kubernetes v1.21 and above |
| ------------------------------ | -------------------------- |
| Chart v1.0.0 and below (alpha) | [x] |

0 comments on commit 851be69

Please sign in to comment.