Document tips for various Kubernetes providers (#621)

* Document tips for various Kubernetes providers

* Add stuff to navbar

* fix navbar

* Apply suggestions from code review

Co-authored-by: Nick <NickLarsenNZ@users.noreply.github.com>

---------

Co-authored-by: Nick <NickLarsenNZ@users.noreply.github.com>

Author: sbernauer

modules/ROOT/assets/images/managed-k8s/ionos/1.png

@@ -1,3 +1,11 @@
 * xref:quickstart.adoc[]
-* xref:kubernetes.adoc[]
+* xref:kubernetes/index.adoc[]
+** xref:kubernetes/gke.adoc[]
+** xref:kubernetes/huawei-cloud.adoc[]
+** xref:kubernetes/ibm-cloud.adoc[]
+** xref:kubernetes/ionos-managed-k8s.adoc[]
+** xref:kubernetes/ionos-managed-stackable.adoc[]
+** xref:kubernetes/microk8s.adoc[]
+** xref:kubernetes/openshift.adoc[]
+** xref:kubernetes/ske.adoc[]
 * xref:getting-started.adoc[]

modules/ROOT/assets/images/managed-k8s/ionos/2.png

@@ -16,7 +16,8 @@ Stackable is based on Kubernetes and uses this as the control plane to manage cl
 
 == Installing Kubernetes and kubectl
 
-Stackable's control plane is built around Kubernetes. Follow the xref:kubernetes.adoc#local-installation[instructions] on how to set up a local Kubernetes instance if you do not have access to a cluster and install kubectl.
+Stackable's control plane is built around Kubernetes.
+Follow the xref:kubernetes/index.adoc#local-installation[instructions] on how to set up a local Kubernetes instance if you do not have access to a cluster and install `kubectl`.
 
 If you already have kubectl installed, and have access to a Kubernetes cluster, you can skip this step.
 

modules/ROOT/assets/images/managed-k8s/ionos/3.png

@@ -0,0 +1,5 @@
+= Google Kubernetes Engine (GKE)
+
+Autopilot clusters are not suported, as the xref:secret-operator:index.adoc[secret-operator] requires special privileges that are not granted in Autopilot clusters.
+
+Other than that no special steps are needed.

modules/ROOT/assets/images/managed-k8s/ske/1.png

@@ -0,0 +1,3 @@
+= Huawei cloud
+
+IMB cloud uses a non-standard Kubelet state directory. Therefore installing secret-operator on Huawei cloud requires special treatement. Please read on the xref:secret-operator:installation.adoc#_huawei_cloud[secret-operator installation guide] for details.

modules/ROOT/assets/images/managed-k8s/ske/2.png

@@ -0,0 +1,3 @@
+= IBM cloud
+
+IMB cloud uses a non-standard Kubelet state directory. Therefore installing secret-operator on IBM cloud requires a special treatement. Please read on the xref:secret-operator:installation.adoc#_ibm_cloud[secret-operator installation guide] for details.

modules/ROOT/assets/images/managed-k8s/ske/3.png

@@ -13,59 +13,14 @@ The following distributions are supported for a production setup of the Stackabl
 
 include::partial$supported-kubernetes-distributions.adoc[]
 
+In case a Kubernetes provider needs some special tuning or we have some tips for it, it has a subpage below this page.
+
 In this version of the SDP, the following Kubernetes versions are supported:
 
 include::partial$supported-kubernetes-versions.adoc[]
 
 Consult the xref:release_notes.adoc[release notes] to find out which specific versions are supported for the Stackable Data Platform you are using.
 
-[#openshift-notes]
-== Notes on OpenShift
-
-SDP operators are certified for the OpenShift platform and can be installed from the OperatorHub.
-
-IMPORTANT: OpenShift installations with FIPS mode enabled are not supported. This is because neither the SDP operators, nor the supported Apache products are FIPS-compliant.
-
-=== Customizing operator installations
-Depending on the cluster size, you may need to customize the resources requested by the SDP operator Pods.
-This is possible when installing the operators from the command line.
-For example, to assign `256Mi` of memory to the Apache Kafka operator, you need to create a custom Subscription as follows:
-
-[source,yaml]
-----
----
-apiVersion: operators.coreos.com/v1alpha1
-kind: Subscription
-metadata:
-  name: stackable-kafka-operator
-  namespace: stackable-operators
-spec:
-  channel: stable
-  installPlanApproval: Automatic
-  name: stackable-kafka-operator
-  source: certified-operators
-  sourceNamespace: openshift-marketplace
-  startingCSV: kafka-operator.v23.11.0
-  config:
-    resources:
-      limits:
-        memory: 256Mi
-      requests:
-        memory: 256Mi
-----
-
-In addition, You can restrict the operator to watch a specific namespace. By default, the operator watches all namespaces.
-For example, to restrict the Kafka operator to watching only a namespace called `kafka-namespace` you add the following properties to the Subscription manifest:
-
-[source,yaml]
-----
-spec:
-  config:
-    env:
-      - name: WATCH_NAMESPACE
-        value: kafka-namespace
-----
-
 [#local-installation]
 == Installing a testinging/development Kubernetes instance locally
 Stackable's control plane is built around Kubernetes, and we'll give some brief examples of how to install Kubernetes on your machine.

modules/ROOT/assets/images/managed-k8s/ske/4.png

@@ -0,0 +1,26 @@
+= IONOS managed Kubernetes
+
+https://cloud.ionos.com/managed/kubernetes
+
+TIP: IONOS also offers a xref:kubernetes/ionos-managed-stackable.adoc[managed Stackable service], which simplifies the usage of Stackable.
+
+There are no special setup steps needed.
+
+. Create Kubernetes cluster
++
+image::managed-k8s/ionos/1.png[]
+
+. Create Nodepool
++
+image::managed-k8s/ionos/2.png[]
+
+. Download kubeconfig
++
+image::managed-k8s/ionos/3.png[]
+
+. Set kubectl context
++
+[source,bash]
+----
+export KUBECONFIG=~/Downloads/kubeconfig.json
+----

modules/ROOT/assets/images/managed-k8s/ske/5.png

@@ -0,0 +1,5 @@
+= IONOS managed Stackable
+
+https://cloud.ionos.com/solutions/managed-stackable
+
+> The Managed Stackable Data Platform from IONOS Cloud is designed to enable you to work with maximum efficiency: Simply select the appropriate data management tools for your respective purpose, build individual stacks for yourself or your customers and make all your data productively usable as quickly as possible

modules/ROOT/nav1.adoc

@@ -0,0 +1,3 @@
+= Microk8s
+
+Microk8s uses a non-standard Kubelet state directory. Therefore installing secret-operator on Microk8s requires a special treatement. Please read on the xref:secret-operator:installation.adoc#_microk8s[secret-operator installation guide] for details.

modules/ROOT/pages/getting-started.adoc

@@ -0,0 +1,45 @@
+= OpenShift
+
+SDP operators are certified for the OpenShift platform and can be installed from the OperatorHub.
+
+IMPORTANT: OpenShift installations with FIPS mode enabled are not supported. This is because neither the SDP operators, nor the supported Apache products are FIPS-compliant.
+
+== Customizing operator installations
+Depending on the cluster size, you may need to customize the resources requested by the SDP operator Pods.
+This is possible when installing the operators from the command line.
+For example, to assign `256Mi` of memory to the Apache Kafka operator, you need to create a custom Subscription as follows:
+
+[source,yaml]
+----
+---
+apiVersion: operators.coreos.com/v1alpha1
+kind: Subscription
+metadata:
+  name: stackable-kafka-operator
+  namespace: stackable-operators
+spec:
+  channel: stable
+  installPlanApproval: Automatic
+  name: stackable-kafka-operator
+  source: certified-operators
+  sourceNamespace: openshift-marketplace
+  startingCSV: kafka-operator.v23.11.0
+  config:
+    resources:
+      limits:
+        memory: 256Mi
+      requests:
+        memory: 256Mi
+----
+
+In addition, You can restrict the operator to watch a specific namespace. By default, the operator watches all namespaces.
+For example, to restrict the Kafka operator to watching only a namespace called `kafka-namespace` you add the following properties to the Subscription manifest:
+
+[source,yaml]
+----
+spec:
+  config:
+    env:
+      - name: WATCH_NAMESPACE
+        value: kafka-namespace
+----

modules/ROOT/pages/kubernetes/gke.adoc

@@ -0,0 +1,40 @@
+= STACKIT Kubernetes Engine (SKE)
+
+https://www.stackit.de/de/produkt/stackit-kubernetes-engine/
+
+SKE clusters by default have no public IPs assigned to the Kubernetes nodes.
+As of 2024-06-13 marking the nodes as public during the Kubernetes cluster creation is not supported.
+
+As a workaround we create a normal Kubernetes and assign public IP adresses to the Kubernetes nodes.
+
+WARNING: The Kubernetes nodes are ephemeral. When STACKIT decides to reboot your Kubernetes nodes (e.g. to do security updates) they will loose their IP addresses and your services will not be reachable anymore, you need to re-assign the IP addresses.
+To circumvent this problem you can use LoadBalancers instead of NodePorts (which might be more expensive due to additional IP addresses).
+
+. Create Kubernetes cluster
++
+We recommend using at least 50GB disk space for the docker images.
++
+image::managed-k8s/ske/1.png[]
+
+. Wait until Kubernetes is up and running
++
+image::managed-k8s/ske/2.png[]
+
+. List servers
++
+image::managed-k8s/ske/3.png[]
+
+. Assign public IP to *all* Kubernetes nodes
++
+image::managed-k8s/ske/4.png[]
+
+. Download kubeconfig
++
+image::managed-k8s/ske/5.png[]
+
+. Set kubectl context
++
+[source,bash]
+----
+export KUBECONFIG=~/Downloads/my-cluister.yml
+----

modules/ROOT/pages/kubernetes/huawei-cloud.adoc

@@ -19,7 +19,7 @@ All images are stored in the {stackable-image-registry}[Stackable image registry
 == Image structure and contents
 
 All our images are built using the {ubi}[Red Hat Universal Base Image (UBI)] minimal as a base image.
-This is a requirement for the platform to achieve xref:ROOT:kubernetes.adoc[OpenShift] certification and be available in the RedHat Certified Operator catalog.
+This is a requirement for the platform to achieve xref:ROOT:kubernetes/openshift.adoc[OpenShift] certification and be available in the RedHat Certified Operator catalog.
 The base image also contains only minimal dependencies and is vetted by RedHat.
 
 The file system structure is the same across all images, which makes the images easier to work with.

modules/ROOT/pages/kubernetes/ibm-cloud.adoc

@@ -47,7 +47,8 @@ Learn more about roles: xref:roles-and-role-groups.adoc[]
 [#deployment]
 == Deployment
 
-All operators and products run as containers in a xref:ROOT:kubernetes.adoc[Kubernetes cluster]. The operators are deployed with stackablectl (the Stackable CLI) or Helm.
+All operators and products run as containers in a xref:ROOT:kubernetes/index.adoc[Kubernetes cluster].
+The operators are deployed with stackablectl (the Stackable CLI) or Helm.
 
 image::deployment.drawio.svg[]
 

modules/ROOT/pages/kubernetes.adoc modules/ROOT/pages/kubernetes/index.adoc

@@ -1,7 +1,11 @@
 <div class="navbar-item has-dropdown is-hoverable">
     <a class="navbar-link" href="#">Platform</a>
     <div class="navbar-dropdown">
-        <a class="navbar-item" href="{{{ relativize (versioned "home" page "/getting_started.html") }}}">Getting Started</a>
+        {{#if (not (or (eq page.version "23.1") (eq page.version "23.4") (eq page.version "23.7") (eq page.version "23.11") (eq page.version "24.3")))}}
+        <a class="navbar-item" href="{{{ relativize (versioned "home" page "/quickstart.html") }}}">Quickstart</a>
+        <a class="navbar-item" href="{{{ relativize (versioned "home" page "/kubernetes/index.html") }}}">Kubernetes</a>
+        {{/if}}
+        <a class="navbar-item" href="{{{ relativize (versioned "home" page "/getting-started.html") }}}">Getting Started</a>
         <hr class="navbar-divider">
         <a class="navbar-item" href="{{{ relativize (versioned "home" page "concepts/index.html") }}}">Concepts</a>
         <a class="navbar-item" href="{{{ relativize (versioned "home" page "demos/index.html") }}}">Demos</a>