Skip to content
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

Install superset in Kubernetes with helm chart #4923

Merged
merged 4 commits into from
May 4, 2018

Conversation

cychiang
Copy link
Contributor

@cychiang cychiang commented May 3, 2018

Hi,

I created a simple helm chart to easily install superset in Kubernetes.

This helm chart is created by helm v2.9.0 and tested in Kubernetes v1.9.3

  • Install with helm: helm upgrade --install superset ./install/helm/superset

It should start to install superset into "default" namespace in Kubernetes

The image used in this helm chart comes from: https://hub.docker.com/r/amancevice/superset

@codecov-io
Copy link

codecov-io commented May 3, 2018

Codecov Report

Merging #4923 into master will decrease coverage by 0.04%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #4923      +/-   ##
==========================================
- Coverage   77.12%   77.08%   -0.05%     
==========================================
  Files          44       44              
  Lines        8539     8549      +10     
==========================================
+ Hits         6586     6590       +4     
- Misses       1953     1959       +6
Impacted Files Coverage Δ
superset/db_engine_specs.py 52.47% <0%> (-0.23%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e213ccd...2c2ce5b. Read the comment docs.

@mistercrunch
Copy link
Member

Nice, can you add an entry in the docs? @docs/installation.rst

@cychiang
Copy link
Contributor Author

cychiang commented May 3, 2018

@mistercrunch
No problem, I have added a short installation guide in docs/installation.rst

@mistercrunch mistercrunch merged commit 976e43e into apache:master May 4, 2018
michellethomas pushed a commit to michellethomas/panoramix that referenced this pull request May 24, 2018
* Add helm chart to install superset in kubernetes

* set resources into unlimited

* Add descriptions to Chart.yaml

* add an entry in docs/installation.rst
timifasubaa pushed a commit to timifasubaa/incubator-superset that referenced this pull request May 31, 2018
* Add helm chart to install superset in kubernetes

* set resources into unlimited

* Add descriptions to Chart.yaml

* add an entry in docs/installation.rst
@maver1ck
Copy link
Contributor

maver1ck commented Jul 17, 2018

@cychiang @mistercrunch
How this chart is connected to
https://github.com/kubernetes/charts/tree/master/stable/superset
?
Which one is official and should be used ?
Do we need two charts ?

@cychiang
Copy link
Contributor Author

@maver1ck

Which one is official and should be used ?

Both of them are good to use and all community support.
In superset, there is no official support on "automatic install" based on #4331 .
Because of that, I decided to submit this pull request.

Do we need two charts?

I'm also looking for helm chart to install superset on KubeApps before I submit this pull request. But, who knows. 😃

@maver1ck
Copy link
Contributor

maver1ck commented Jul 18, 2018

@cychiang I'm asking this question because I'd like to add support for Celery workers to one of the charts and don't know which to use as a base.

@cychiang
Copy link
Contributor Author

@maver1ck
That is great if you want to contribute your work in superset helm chart.
Personally, I would say, choose the one you like.
But I can assure you that if I make any changes of superset helm chart, I will submit pull request to here. 😄

@ahsanshah
Copy link

Question on this chart...does this work or is it compatible with the Docker/Contrib install steps or are the two different? I would think given Helm leverages Docker images it may be best to "sync" the 2? For instance, OOTB helm chart works great. However, trying to do the chart install with a custom base docker image requires a lot of template changes.

@cychiang
Copy link
Contributor Author

@ahsanshah Hi! This helm chart is based on this image: amancevice/superset, and it may not be compatible with the image from Docker/Contrib. This is a good idea to leverage Docker/Contrib image to provide a better user experience of the superset. I will spend some time to take a look of Docker/Contrib image and try to leverage it with helm chart if I have free time.

wenchma pushed a commit to wenchma/incubator-superset that referenced this pull request Nov 16, 2018
* Add helm chart to install superset in kubernetes

* set resources into unlimited

* Add descriptions to Chart.yaml

* add an entry in docs/installation.rst
@charles-zhan
Copy link

@cychiang so what is the default username and password for superset webui when installed with this script.

@cychiang
Copy link
Contributor Author

Hi @charles-zhan, I assume you deploy the superset in Kubernetes cluster and want to know the username and password when open the web UI.

According to the document here you need to create username and password by your own.
Here is the step to create the username and password.

  1. Invoke superset-init to create an admin account by kubectl exec -ti ${your_pods_name} -- superset-init

  2. You will enter the interactive mode, and it will request you enter information to create the credential.

  3. After you complete all steps, you should be able to login with username and password you provided on the previous stage.

@newtonjose
Copy link

hey, @cychiang, I need pass new superset_config.py to chart, how make it? Tka

@cychiang
Copy link
Contributor Author

cychiang commented Nov 9, 2019

Hej, @newtonjose
I try my best to answer your question since I haven't updating my template for quite a long time. Maybe there're many different ways, but you can make it as following steps:

  1. create a config directory in helm project root, in this case, same layer as Chart.yaml
  2. place your superset_config.py under that directory
  3. deploy your template

What's behind the scene?
You can look at line 27 on templates/configmap.yaml, it will generate a Kubernetes configmap resource along when you deploy your template.
Then, look at line 42 on templates/deployment.yaml you can see that it will mount a configmap to a container which is superset.
After all, you can expect your superset_config.py will show up on /etc/superset/

@newtonjose
Copy link

Work good @cychiang , maybe this can be a feature. Something else, I don't see on docs how initialize the superset app, but you explain how do that above. I think have a good solution like.

Well, I try change SQLALCHEMY_DATABASE_URI, but my problem was the SECRET_KEY and getting this error Invalid decryption key.

@mistercrunch mistercrunch added 🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.25.0 labels Feb 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏷️ bot A label used by `supersetbot` to keep track of which PR where auto-tagged with release labels 🚢 0.25.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants