You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@superset.apache.org by ma...@apache.org on 2024/03/21 17:22:36 UTC

(superset) branch master updated: docs: make k8s top item in Installation section (#27540)

This is an automated email from the ASF dual-hosted git repository.

maximebeauchemin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git


The following commit(s) were added to refs/heads/master by this push:
     new e32b1c861f docs: make k8s top item in Installation section (#27540)
e32b1c861f is described below

commit e32b1c861fc791791401dc1cb22afda172767915
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Thu Mar 21 10:22:27 2024 -0700

    docs: make k8s top item in Installation section (#27540)
---
 .../installing-superset-using-docker-compose.mdx    | 21 +++++++++++++--------
 docs/docs/installation/running-on-kubernetes.mdx    | 12 ++++++++++--
 docs/docs/intro.mdx                                 |  1 -
 3 files changed, 23 insertions(+), 11 deletions(-)

diff --git a/docs/docs/installation/installing-superset-using-docker-compose.mdx b/docs/docs/installation/installing-superset-using-docker-compose.mdx
index d40ce649c4..c20e1283fc 100644
--- a/docs/docs/installation/installing-superset-using-docker-compose.mdx
+++ b/docs/docs/installation/installing-superset-using-docker-compose.mdx
@@ -1,21 +1,26 @@
 ---
 title: Installing Locally Using Docker Compose
 hide_title: true
-sidebar_position: 1
+sidebar_position: 3
 version: 1
 ---
 
 ## Using Docker Compose
 
-The fastest way to try Superset locally is using Docker and Docker Compose on a Linux or Mac OSX
-computer. Superset does not have official support for Windows, so we have provided a VM workaround
-below.
+**DO NOT USE THIS FOR PRODUCTION!**
 
-It's **not** typical, nor recommended to use docker-compose to productionize an
-application like Superset. docker-compose should be used for local development
-or testing the app.
+The fastest way to try Superset locally is using Docker Compose on a Linux or Mac OSX
+computer. Superset does not have official support for Windows, so we have provided a VM workaround
+below. It's also the easiest way to launch a fully functioning **development environment** quickly.
 
-**DO NOT USE THIS FOR PRODUCTION!**
+:::caution
+Since `docker-compose` is primarily designed to run a set of containers on **a single host**
+and can't credibly support **high availability** as a result, we do not support nor recommend
+using our `docker-compose` constructs to support production-type use-cases. For single host
+environments, we recommend using [minikube](https://minikube.sigs.k8s.io/docs/start/) along
+our [installing on k8s](https://superset.apache.org/docs/installation/running-on-kubernetes)
+documentation.
+:::
 
 Note that there are 3 major ways we support to run docker-compose:
 1. **docker-compose.yml:** for interactive development, where we mount your local folder with the
diff --git a/docs/docs/installation/running-on-kubernetes.mdx b/docs/docs/installation/running-on-kubernetes.mdx
index 5de9d5b79c..2f6732ec7c 100644
--- a/docs/docs/installation/running-on-kubernetes.mdx
+++ b/docs/docs/installation/running-on-kubernetes.mdx
@@ -1,19 +1,27 @@
 ---
 title: Installing on Kubernetes
 hide_title: true
-sidebar_position: 3
+sidebar_position: 1
 version: 1
 ---
 
 ## Installing on Kubernetes
 
-Running Superset on Kubernetes is supported with the provided [Helm](https://helm.sh/) chart found in the official [Superset helm repository](https://apache.github.io/superset/index.yaml).
+Running Superset on Kubernetes is supported with the provided [Helm](https://helm.sh/) chart
+found in the official [Superset helm repository](https://apache.github.io/superset/index.yaml).
 
 ### Prerequisites
 
 - A Kubernetes cluster
 - Helm installed
 
+:::note
+For simpler, single host environments, we recommend using
+[minikube](https://minikube.sigs.k8s.io/docs/start/) which is easy to setup on many platforms
+and works fantastically well with the Helm chart referenced here.
+:::
+
+
 ### Running
 
 1. Add the Superset helm repository
diff --git a/docs/docs/intro.mdx b/docs/docs/intro.mdx
index 3a4a09378c..6618bcc940 100644
--- a/docs/docs/intro.mdx
+++ b/docs/docs/intro.mdx
@@ -15,7 +15,6 @@ Here are a **few different ways you can get started with Superset**:
 
 - Try a [Quickstart deployment](/docs/quickstart), which runs a single Docker container
 - Install Superset [from PyPI](/docs/installation/installing-superset-from-pypi/)
-- Deploy Superset [using Docker Compose](/docs/installation/installing-superset-using-docker-compose)
 - Deploy Superset [with Kubernetes](/docs/installation/running-on-kubernetes)
 - Download the [source code from Apache Foundation's website](https://dist.apache.org/repos/dist/release/superset/)