From 6c3bfe80dca7bbd5e76ba51ad69b801f462ef9cd Mon Sep 17 00:00:00 2001 From: Anthony Corletti Date: Sun, 21 Mar 2021 17:32:24 -0400 Subject: [PATCH] docs: update helm documentation (#12932) * docs: update helm documentation * docs: fix for end-of-file-fixer pre-commit-config * update: bump chart apiVersion to v2 and remove requirements.yaml --- docs/installation.rst | 7 +++--- .../docs/installation/installing_scratch.mdx | 13 +++++++++- helm/superset/Chart.yaml | 11 +++++++- helm/superset/requirements.yaml | 25 ------------------- 4 files changed, 26 insertions(+), 30 deletions(-) delete mode 100644 helm/superset/requirements.yaml diff --git a/docs/installation.rst b/docs/installation.rst index f1307763441b..658c9a7e26b7 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1487,13 +1487,14 @@ Install Superset with helm in Kubernetes ---------------------------------------- You can install Superset into Kubernetes with Helm . The chart is -located in ``install/helm``. +located in the ``helm`` directory. -To install Superset into your Kubernetes: +To install Superset in your Kubernetes cluster with Helm 3, run: .. code-block:: bash - helm upgrade --install superset ./install/helm/superset + helm dep install ./helm/superset + helm upgrade --install superset ./helm/superset Note that the above command will install Superset into ``default`` namespace of your Kubernetes cluster. diff --git a/docs/src/pages/docs/installation/installing_scratch.mdx b/docs/src/pages/docs/installation/installing_scratch.mdx index 39e36ea23283..79c35d98531f 100644 --- a/docs/src/pages/docs/installation/installing_scratch.mdx +++ b/docs/src/pages/docs/installation/installing_scratch.mdx @@ -119,4 +119,15 @@ locally by default at `localhost:8088`) and login using the username and passwor ### Installing Superset with Helm in Kubernetes -See the dedicated [Kubernetes installation](/docs/installation/running-on-kubernetes) page. +You can install Superset into Kubernetes with [Helm](https://helm.sh/). The chart is located in +the `helm/` directory. + +To install Superset in your Kubernetes cluster with Helm 3, run: + +``` +helm dep up ./helm/superset +helm upgrade --install superset ./helm/superset +``` + +Note that the above command will install Superset into `default` namespace of your Kubernetes +cluster. diff --git a/helm/superset/Chart.yaml b/helm/superset/Chart.yaml index 973f6c70479c..49379034149f 100644 --- a/helm/superset/Chart.yaml +++ b/helm/superset/Chart.yaml @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -apiVersion: v1 +apiVersion: v2 appVersion: "1.0" description: Apache Superset is a modern, enterprise-ready business intelligence web application name: superset @@ -23,3 +23,12 @@ maintainers: email: cychiang0823@gmail.com url: https://github.com/cychiang version: 0.1.0 +dependencies: +- name: postgresql + version: 10.2.0 + repository: https://charts.bitnami.com/bitnami + condition: postgresql.enabled +- name: redis + version: 12.3.0 + repository: https://charts.bitnami.com/bitnami + condition: redis.enabled diff --git a/helm/superset/requirements.yaml b/helm/superset/requirements.yaml deleted file mode 100644 index b9dbac74905e..000000000000 --- a/helm/superset/requirements.yaml +++ /dev/null @@ -1,25 +0,0 @@ -# -# Licensed to the Apache Software Foundation (ASF) under one or more -# contributor license agreements. See the NOTICE file distributed with -# this work for additional information regarding copyright ownership. -# The ASF licenses this file to You under the Apache License, Version 2.0 -# (the "License"); you may not use this file except in compliance with -# the License. You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -dependencies: -- name: postgresql - version: 10.2.0 - repository: https://charts.bitnami.com/bitnami - condition: postgresql.enabled -- name: redis - version: 12.3.0 - repository: https://charts.bitnami.com/bitnami - condition: redis.enabled