Skip to content

Add VMWare Tanzu notes. Also differentiate between supported and tested k8s #719

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.

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

Merged
merged 5 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions modules/ROOT/nav1.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@
** xref:kubernetes/microk8s.adoc[]
** xref:kubernetes/openshift.adoc[]
** xref:kubernetes/ske.adoc[]
** xref:kubernetes/vmware_tanzu.adoc[]
* xref:getting-started.adoc[]
4 changes: 3 additions & 1 deletion modules/ROOT/pages/kubernetes/huawei-cloud.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
= Huawei cloud

Huawei cloud uses a non-standard Kubelet state directory. Therefore installing secret-operator on Huawei cloud requires special treatment. Please read on the xref:secret-operator:installation.adoc#_huawei_cloud[secret-operator installation guide] for details.
Huawei Cloud uses a non-standard Kubelet state directory.
Therefore, installing the secret-operator and listener-operator on Huawei Cloud requires special handling.
Please refer to the xref:secret-operator:installation.adoc#_huawei_cloud[secret-operator installation guide] and the xref:listener-operator:installation.adoc#_huawei_cloud[listener-operator installation guide] for details.
4 changes: 3 additions & 1 deletion modules/ROOT/pages/kubernetes/ibm-cloud.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
= IBM cloud

IBM cloud uses a non-standard Kubelet state directory. Therefore installing secret-operator on IBM cloud requires a special treatment. Please read on the xref:secret-operator:installation.adoc#_ibm_cloud[secret-operator installation guide] for details.
IBM Cloud uses a non-standard Kubelet state directory.
Therefore, installing the secret-operator and listener-operator on IBM Cloud requires special handling.
Please refer to the xref:secret-operator:installation.adoc#_ibm_cloud[secret-operator installation guide] and the xref:listener-operator:installation.adoc#_ibm_cloud[listener-operator installation guide] for details.
4 changes: 4 additions & 0 deletions modules/ROOT/pages/kubernetes/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ The following distributions are supported for a production setup of the Stackabl

include::partial$supported-kubernetes-distributions.adoc[]

These Kubernetes distributions are not officially tested by us but based on community feedback have been known to work. Some might require extra steps, please refer to the detailed pages for more information. Please contact us if you're interested in official support for any of these:

include::partial$tested-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.

Consult the xref:release_notes.adoc[release notes] to find out which specific Kubernetes versions are supported for the Stackable Data Platform you are using.
Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/kubernetes/microk8s.adoc
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
= 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.
Microk8s uses a non-standard Kubelet state directory.
Therefore, installing the secret-operator and listener-operator on Microk8s requires special handling.
Please refer to the xref:secret-operator:installation.adoc#_microk8s[secret-operator installation guide] and the xref:listener-operator:installation.adoc#_microk8s[listener-operator installation guide] for details.
5 changes: 5 additions & 0 deletions modules/ROOT/pages/kubernetes/vmware_tanzu.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
= VMware Tanzu

VMware Tanzu uses a non-standard Kubelet state directory.
Therefore, installing the secret-operator and listener-operator on VMware Tanzu requires special handling.
Please refer to the xref:secret-operator:installation.adoc#_vmware_tanzu[secret-operator installation guide] and the xref:listener-operator:installation.adoc#_vmware_tanzu[listener-operator installation guide] for details.
7 changes: 6 additions & 1 deletion modules/ROOT/pages/product-information.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -107,10 +107,15 @@ The supported Kubernetes versions for each platform release can be found here:

xref:release-notes.adoc[SDP Release notes]

There are various Kubernetes distributions. Stackable supports:
There are various Kubernetes distributions.
The following distributions are supported for a production setup of the Stackable Data Platform:

include::partial$supported-kubernetes-distributions.adoc[]

These Kubernetes distributions are not officially tested by us but based on community feedback have been known to work. Some might require extra steps, please refer to the detailed pages for more information. Please contact us if you're interested in official support for any of these:

include::partial$tested-kubernetes-distributions.adoc[]

=== Product specific dependencies

The following products have required external components to run:
Expand Down
7 changes: 4 additions & 3 deletions modules/ROOT/partials/supported-kubernetes-distributions.adoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
* https://aws.amazon.com/eks/[Amazon Elastic Kubernetes Service]
* xref:kubernetes/eks.adoc[Amazon Elastic Kubernetes Service]
* xref:kubernetes/aks.adoc[Azure Kubernetes Service]
* xref:kubernetes/gke.adoc[Google Kubernetes Engine]
* xref:kubernetes/ionos-managed-k8s.adoc[IONOS Managed Kubernetes]
* xref:kubernetes/ionos-managed-stackable.adoc[IONOS Managed Stackable]
* https://kind.sigs.k8s.io/[kind]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's kind of confusing IMO that some of these lead to the official upstream product page, and some lead to our docs on them.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would prefer to always link to our internal guide, however, for some clouds we don't have any to link to.
I'm also happy to remove upstream links entirely if you prefer that?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about:

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me, will raise a PR

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please have a look at #720

* xref:kubernetes/microk8s.adoc[MicroK8s]
* xref:kubernetes/openshift.adoc[Red Hat OpenShift]
* xref:kubernetes/ske.adoc[STACKIT Kubernetes Engine] (with the exception of missing public NodePorts)
* https://www.rancher.com/products/rancher[SUSE Rancher]
* https://www.suse.com/products/k3s/[SUSE K3S]
* https://www.rancher.com/products/rancher[SUSE Rancher]
6 changes: 6 additions & 0 deletions modules/ROOT/partials/tested-kubernetes-distributions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
* xref:kubernetes/huawei-cloud.adoc[Huawei Cloud]
* xref:kubernetes/ibm-cloud.adoc[IBM Cloud]
* https://www.plusserver.com/en/product/managed-kubernetes/[plusserver Kubernetes as a Service]
* xref:kubernetes/ske.adoc[STACKIT Kubernetes Engine] (with the exception of missing public NodePorts)
* xref:kubernetes/vmware_tanzu.adoc[VMware Tanzu]
* https://www.oracle.com/cloud/cloud-native/kubernetes-engine/[Oracle Kubernetes Engine (OKE)]