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/16 00:38:53 UTC

(superset) branch k8sftw created (now 666fc86139)

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

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


      at 666fc86139 docs: make k8s top item in Installation section

This branch includes the following new commits:

     new 666fc86139 docs: make k8s top item in Installation section

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



(superset) 01/01: docs: make k8s top item in Installation section

Posted by ma...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

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

commit 666fc86139961c97f9d0ab4383ac8e78177caac3
Author: Maxime Beauchemin <ma...@gmail.com>
AuthorDate: Fri Mar 15 17:36:12 2024 -0700

    docs: make k8s top item in Installation section
    
    Also clarify our stance against using our docker-compose assets in production
---
 .../installing-superset-using-docker-compose.mdx       | 18 ++++++++++--------
 docs/docs/installation/running-on-kubernetes.mdx       |  2 +-
 docs/docs/intro.mdx                                    |  1 -
 3 files changed, 11 insertions(+), 10 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..2fb881d6ce 100644
--- a/docs/docs/installation/installing-superset-using-docker-compose.mdx
+++ b/docs/docs/installation/installing-superset-using-docker-compose.mdx
@@ -1,21 +1,23 @@
 ---
 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.
+:::
 
 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..42d0c5ba91 100644
--- a/docs/docs/installation/running-on-kubernetes.mdx
+++ b/docs/docs/installation/running-on-kubernetes.mdx
@@ -1,7 +1,7 @@
 ---
 title: Installing on Kubernetes
 hide_title: true
-sidebar_position: 3
+sidebar_position: 1
 version: 1
 ---
 
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/)