You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@superset.apache.org by GitBox <gi...@apache.org> on 2021/02/14 16:28:00 UTC
[GitHub] [superset] Yann-OAF opened a new pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Yann-OAF opened a new pull request #13116:
URL: https://github.com/apache/superset/pull/13116
### SUMMARY
This PR adds an optional kubernetes `Deployment` to run the Celery beat, which is needed in order to trigger the scheduled alerts and reports (as per the excellent unpublished guide at https://github.com/apache/superset/blob/4fa3b6c7185629b87c27fc2c0e5435d458f7b73d/docs/src/pages/docs/installation/email_reports.mdx).
It is off by default, and needs to be enabled with `supersetBeat.enabled`.
The new pod is defined pretty much exactly like the worker pod except that:
* `replicas` is always 1, since this needs to be a singleton
* The command is different
Note that for the chart to be able to execute reports, we still need to check all the other boxes, in particular:
* Make sure one webdriver is installed - for this, the commands mentioned in the guide above can be added as a custom `supersetWorker.command` (this is only needed in the worker container) with the existing chart, with something like this in your `values.yaml`:
```
supersetWorker:
command:
- /bin/sh
- -c
- |
# Install chrome webdriver
# See https://github.com/apache/superset/blob/4fa3b6c7185629b87c27fc2c0e5435d458f7b73d/docs/src/pages/docs/installation/email_reports.mdx
apt update
wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
apt install -y --no-install-recommends ./google-chrome-stable_current_amd64.deb
wget https://chromedriver.storage.googleapis.com/88.0.4324.96/chromedriver_linux64.zip
unzip chromedriver_linux64.zip
chmod +x chromedriver
mv chromedriver /usr/bin
apt autoremove -yqq --purge
apt clean
rm -f google-chrome-stable_current_amd64.deb chromedriver_linux64.zip
# Run
. {{ .Values.configMountPath }}/superset_bootstrap.sh; celery --app=superset.tasks.celery_app:app worker
```
* Perform all the required Celery setup by overriding the `superset_config.py`. This is now possible with the latest chart from `master` by specifying overrides in your `values.yaml` such as:
```
configOverrides:
celery_conf: |
from celery.schedules import crontab
class CeleryConfig(object):
BROKER_URL = f"redis://{env('REDIS_HOST')}:{env('REDIS_PORT')}/0"
CELERY_IMPORTS = ('superset.sql_lab', )
CELERY_RESULT_BACKEND = f"redis://{env('REDIS_HOST')}:{env('REDIS_PORT')}/0"
CELERY_ANNOTATIONS = {'tasks.add': {'rate_limit': '10/s'}}
CELERY_IMPORTS = ('superset.sql_lab', "superset.tasks", "superset.tasks.thumbnails", )
CELERY_ANNOTATIONS = {
'sql_lab.get_sql_results': {
'rate_limit': '100/s',
},
'email_reports.send': {
'rate_limit': '1/s',
'time_limit': 600,
'soft_time_limit': 600,
'ignore_result': True,
},
}
CELERYBEAT_SCHEDULE = {
'reports.scheduler': {
'task': 'reports.scheduler',
'schedule': crontab(minute='*', hour='*'),
},
'reports.prune_log': {
'task': 'reports.prune_log',
'schedule': crontab(minute=0, hour=0),
},
'cache-warmup-hourly': {
'task': 'cache-warmup',
'schedule': crontab(minute='*/30', hour='*'),
'kwargs': {
'strategy_name': 'top_n_dashboards',
'top_n': 10,
'since': '7 days ago',
},
}
}
CELERY_CONFIG = CeleryConfig
reports: |
EMAIL_PAGE_RENDER_WAIT = 60
WEBDRIVER_BASEURL = "http://superset:8088/"
WEBDRIVER_BASEURL_USER_FRIENDLY = "https://superset.qa.oneacrefund.org/"
WEBDRIVER_TYPE= "chrome"
WEBDRIVER_OPTION_ARGS = [
"--force-device-scale-factor=2.0",
"--high-dpi-support=2.0",
"--headless",
"--disable-gpu",
"--disable-dev-shm-usage",
"--no-sandbox",
"--disable-setuid-sandbox",
"--disable-extensions",
]
feature_flags: |
import ast
FEATURE_FLAGS = {
"ALERT_REPORTS": True,
}
EMAIL_NOTIFICATIONS = ast.literal_eval(os.getenv("EMAIL_NOTIFICATIONS", "True"))
SMTP_HOST = os.getenv("SMTP_HOST","localhost")
SMTP_STARTTLS = ast.literal_eval(os.getenv("SMTP_STARTTLS", "True"))
SMTP_SSL = ast.literal_eval(os.getenv("SMTP_SSL", "False"))
SMTP_USER = os.getenv("SMTP_USER","superset")
SMTP_PORT = os.getenv("SMTP_PORT",25)
SMTP_PASSWORD = os.getenv("SMTP_PASSWORD","superset")
SMTP_MAIL_FROM = os.getenv("SMTP_MAIL_FROM","superset@superset.com")
SLACK_API_TOKEN = os.getenv("SLACK_API_TOKEN",None)
extraSecretEnv:
SLACK_API_TOKEN: xoxb-...
SMTP_PASSWORD: ...
extraEnv:
SMTP_HOST: smtp.gmail.com
SMTP_USER: ...
SMTP_PORT: "587"
SMTP_MAIL_FROM: ...
```
The above would probably need to be added to the doc together with PR #13104 for the Kubernetes case.
### TEST PLAN
* Update `values.yaml` with `supersetBeat.enabled: true` and upgrade your chart release
* See your new pod running!
### ADDITIONAL INFORMATION
- [x] Has associated issue: #13104
- [ ] Changes UI
- [ ] Requires DB Migration.
- [ ] Confirm DB Migration upgrade and downgrade tested.
- [ ] Introduces new feature or API
- [ ] Removes existing feature or API
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576668485
##########
File path: helm/superset/templates/deployment-worker.yaml
##########
@@ -31,11 +31,16 @@ spec:
release: {{ .Release.Name }}
template:
metadata:
- {{ if .Values.supersetWorker.forceReload }}
annotations:
+ checksum/superset_config.py: {{ include "superset-config" . | sha256sum }}
+ checksum/connections: {{ .Values.supersetNode.connections | toYaml | sha256sum }}
+ checksum/extraConfigs: {{ .Values.extraConfigs | toYaml | sha256sum }}
+ checksum/extraSecretEnv: {{ .Values.extraSecretEnv | toYaml | sha256sum }}
+ checksum/configOverrides: {{ .Values.configOverrides | toYaml | sha256sum }}
Review comment:
Since those values will change on any content updates of the source values, this will force a patch of the `Deployment`, and a restart of the pods whenever we publish an update to these (otherwise, updates to a `ConfigMap` does not automatically force the pods mounting them to restart).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576702176
##########
File path: helm/superset/values.yaml
##########
@@ -165,6 +165,25 @@ supersetWorker:
name: '{{ tpl .Values.envFromSecret . }}'
command: [ "/bin/sh", "-c", "until nc -zv $DB_HOST $DB_PORT -w1; do echo 'waiting for db'; sleep 1; done" ]
+##
+## Superset beat configuration (to trigger scheduled jobs like reports)
+supersetCeleryBeat:
+ # This is only required if you intend to use alerts and reports
+ enabled: false
+ command:
+ - "/bin/sh"
+ - "-c"
+ - ". {{ .Values.configMountPath }}/superset_bootstrap.sh; celery beat --app=superset.tasks.celery_app:app --pidfile /tmp/celerybeat.pid --schedule /tmp/celerybeat-schedule"
Review comment:
Agreed, different PR... and probably not high prio...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576004351
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
+#
+# 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.
+#
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ template "superset.fullname" . }}-beat
Review comment:
I initially named the pods the same way you did, but some colleague said that `beat` is kind of generic, and it would be better naming it `{{ template "superset.fullname" . }}-celerybeat`.
I let you judge :wink:
##########
File path: helm/superset/values.yaml
##########
@@ -165,6 +165,25 @@ supersetWorker:
name: '{{ tpl .Values.envFromSecret . }}'
command: [ "/bin/sh", "-c", "until nc -zv $DB_HOST $DB_PORT -w1; do echo 'waiting for db'; sleep 1; done" ]
+##
+## Superset beat configuration (to trigger scheduled jobs like reports)
+supersetBeat:
+ # this is only required if you intend to use reports and alerts (?)
Review comment:
For the moment, yes
```suggestion
# This is only required if you intend to use alerts and reports
```
##########
File path: helm/superset/templates/deployment-worker.yaml
##########
@@ -31,11 +31,16 @@ spec:
release: {{ .Release.Name }}
template:
metadata:
- {{ if .Values.supersetWorker.forceReload }}
annotations:
+ checksum/superset_config.py: {{ include "superset-config" . | sha256sum }}
+ checksum/connections: {{ .Values.supersetNode.connections | toYaml | sha256sum }}
+ checksum/extraConfigs: {{ .Values.extraConfigs | toYaml | sha256sum }}
+ checksum/extraSecretEnv: {{ .Values.extraSecretEnv | toYaml | sha256sum }}
+ checksum/configOverrides: {{ .Values.configOverrides | toYaml | sha256sum }}
Review comment:
_[K8S newbie]_ What's the point of those annotations?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576670986
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
+#
+# 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.
+#
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ template "superset.fullname" . }}-beat
Review comment:
Yeah that makes sense...
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779738897
No problem, Github suggestions isn't perfect :sweat_smile:
Sorry for flooding the PR.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] craig-rueda merged pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
craig-rueda merged pull request #13116:
URL: https://github.com/apache/superset/pull/13116
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779835811
> LGTM, the suggestion on how to add the webdriver is not ideal. Calling @craig-rueda here for some additional thoughts
Yes I definitely agree... installing stuff at runtime isn't a really good practice since it creates extra risks. The best would really be to have a pre-built image for it, but I'm not aware of any official ones, and this is out of scope of this PR anyway...
Btw I would argue that the same goes for the way extra pip packages (which also requires running the containers as `root`...)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576699334
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
+#
+# 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.
+#
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ template "superset.fullname" . }}-celerybeat
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ chart: {{ template "superset.chart" . }}
+ release: {{ .Release.Name }}
+ heritage: {{ .Release.Service }}
+spec:
+ # This must be a singleton
+ replicas: 1
+ selector:
+ matchLabels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ template:
+ metadata:
+ annotations:
+ checksum/superset_config.py: {{ include "superset-config" . | sha256sum }}
+ checksum/connections: {{ .Values.supersetNode.connections | toYaml | sha256sum }}
+ checksum/extraConfigs: {{ .Values.extraConfigs | toYaml | sha256sum }}
+ checksum/extraSecretEnv: {{ .Values.extraSecretEnv | toYaml | sha256sum }}
+ checksum/configOverrides: {{ .Values.configOverrides | toYaml | sha256sum }}
+ {{ if .Values.supersetBeat.forceReload }}
+ # Optionally force the thing to reload
+ force-reload: {{ randAlphaNum 5 | quote }}
+ {{ end }}
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ spec:
+ securityContext:
+ runAsUser: 0 # Needed in order to allow pip install to work in bootstrap
+ {{- if .Values.supersetBeat.initContainers }}
Review comment:
```suggestion
{{- if .Values.supersetCeleryBeat.initContainers }}
```
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
Review comment:
```suggestion
{{- if .Values.supersetCeleryBeat.enabled -}}
```
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
+#
+# 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.
+#
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ template "superset.fullname" . }}-celerybeat
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ chart: {{ template "superset.chart" . }}
+ release: {{ .Release.Name }}
+ heritage: {{ .Release.Service }}
+spec:
+ # This must be a singleton
+ replicas: 1
+ selector:
+ matchLabels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ template:
+ metadata:
+ annotations:
+ checksum/superset_config.py: {{ include "superset-config" . | sha256sum }}
+ checksum/connections: {{ .Values.supersetNode.connections | toYaml | sha256sum }}
+ checksum/extraConfigs: {{ .Values.extraConfigs | toYaml | sha256sum }}
+ checksum/extraSecretEnv: {{ .Values.extraSecretEnv | toYaml | sha256sum }}
+ checksum/configOverrides: {{ .Values.configOverrides | toYaml | sha256sum }}
+ {{ if .Values.supersetBeat.forceReload }}
+ # Optionally force the thing to reload
+ force-reload: {{ randAlphaNum 5 | quote }}
+ {{ end }}
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ spec:
+ securityContext:
+ runAsUser: 0 # Needed in order to allow pip install to work in bootstrap
+ {{- if .Values.supersetBeat.initContainers }}
+ initContainers:
+ {{- tpl (toYaml .Values.supersetBeat.initContainers) . | nindent 6 }}
+ {{- end }}
+ containers:
+ - name: {{ .Chart.Name }}
+ image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}"
+ imagePullPolicy: {{ .Values.image.pullPolicy }}
+ command: {{ tpl (toJson .Values.supersetBeat.command) . }}
Review comment:
```suggestion
command: {{ tpl (toJson .Values.supersetCeleryBeat.command) . }}
```
##########
File path: helm/superset/values.yaml
##########
@@ -165,6 +165,25 @@ supersetWorker:
name: '{{ tpl .Values.envFromSecret . }}'
command: [ "/bin/sh", "-c", "until nc -zv $DB_HOST $DB_PORT -w1; do echo 'waiting for db'; sleep 1; done" ]
+##
+## Superset beat configuration (to trigger scheduled jobs like reports)
+supersetCeleryBeat:
+ # This is only required if you intend to use alerts and reports
+ enabled: false
+ command:
+ - "/bin/sh"
+ - "-c"
+ - ". {{ .Values.configMountPath }}/superset_bootstrap.sh; celery beat --app=superset.tasks.celery_app:app --pidfile /tmp/celerybeat.pid --schedule /tmp/celerybeat-schedule"
Review comment:
There is no trace of flower in the `master` chart in fact :open_mouth: To add it, we should do something really similar to this PR, plus a service dedicated to flower.
I think this is out of the scope of this PR, my team will switch back to the `master` charts, and we will open PR to add what's missing, but not sure when this will be. :confused:
If you have some time to do it, I would gladly help!
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
+#
+# 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.
+#
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ template "superset.fullname" . }}-celerybeat
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ chart: {{ template "superset.chart" . }}
+ release: {{ .Release.Name }}
+ heritage: {{ .Release.Service }}
+spec:
+ # This must be a singleton
+ replicas: 1
+ selector:
+ matchLabels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ template:
+ metadata:
+ annotations:
+ checksum/superset_config.py: {{ include "superset-config" . | sha256sum }}
+ checksum/connections: {{ .Values.supersetNode.connections | toYaml | sha256sum }}
+ checksum/extraConfigs: {{ .Values.extraConfigs | toYaml | sha256sum }}
+ checksum/extraSecretEnv: {{ .Values.extraSecretEnv | toYaml | sha256sum }}
+ checksum/configOverrides: {{ .Values.configOverrides | toYaml | sha256sum }}
+ {{ if .Values.supersetBeat.forceReload }}
Review comment:
```suggestion
{{ if .Values.supersetCeleryBeat.forceReload }}
```
##########
File path: helm/superset/templates/deployment-beat.yaml
##########
@@ -0,0 +1,95 @@
+{{- if .Values.supersetBeat.enabled -}}
+#
+# 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.
+#
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+ name: {{ template "superset.fullname" . }}-celerybeat
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ chart: {{ template "superset.chart" . }}
+ release: {{ .Release.Name }}
+ heritage: {{ .Release.Service }}
+spec:
+ # This must be a singleton
+ replicas: 1
+ selector:
+ matchLabels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ template:
+ metadata:
+ annotations:
+ checksum/superset_config.py: {{ include "superset-config" . | sha256sum }}
+ checksum/connections: {{ .Values.supersetNode.connections | toYaml | sha256sum }}
+ checksum/extraConfigs: {{ .Values.extraConfigs | toYaml | sha256sum }}
+ checksum/extraSecretEnv: {{ .Values.extraSecretEnv | toYaml | sha256sum }}
+ checksum/configOverrides: {{ .Values.configOverrides | toYaml | sha256sum }}
+ {{ if .Values.supersetBeat.forceReload }}
+ # Optionally force the thing to reload
+ force-reload: {{ randAlphaNum 5 | quote }}
+ {{ end }}
+ labels:
+ app: {{ template "superset.name" . }}-celerybeat
+ release: {{ .Release.Name }}
+ spec:
+ securityContext:
+ runAsUser: 0 # Needed in order to allow pip install to work in bootstrap
+ {{- if .Values.supersetBeat.initContainers }}
+ initContainers:
+ {{- tpl (toYaml .Values.supersetBeat.initContainers) . | nindent 6 }}
Review comment:
```suggestion
{{- tpl (toYaml .Values.supersetCeleryBeat.initContainers) . | nindent 6 }}
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779703070
> Also, we need to add documentation on the K8S part about this celery beat, I think this PR is the good one to do it!
> Otherwise, we can add it in the other one that document Alerts&Reports, but seem more atomic to do it here.
> I can help on this, I'm on the Superset's Slack if you want to reach me 😉
Yes, I agree this deserves a documentation update.
Another thing I've been wondering about is Celery Flower... I'm a total noob about Celery / Flask... and in fact Python in general, so I'm not 100% sure what `flower` does... but I have the impression we might need one pod for it as well?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] dpgaspar commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
dpgaspar commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576735084
##########
File path: helm/superset/values.yaml
##########
@@ -165,6 +165,25 @@ supersetWorker:
name: '{{ tpl .Values.envFromSecret . }}'
command: [ "/bin/sh", "-c", "until nc -zv $DB_HOST $DB_PORT -w1; do echo 'waiting for db'; sleep 1; done" ]
+##
+## Superset beat configuration (to trigger scheduled jobs like reports)
+supersetCeleryBeat:
+ # This is only required if you intend to use alerts and reports
+ enabled: false
+ command:
+ - "/bin/sh"
+ - "-c"
+ - ". {{ .Values.configMountPath }}/superset_bootstrap.sh; celery beat --app=superset.tasks.celery_app:app --pidfile /tmp/celerybeat.pid --schedule /tmp/celerybeat-schedule"
Review comment:
Agree, but flower by default does not support auth, and it exposes dangerous functionality and sensitive info. May be a bit out of scope
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779711287
[Flower](https://flower.readthedocs.io/en/latest/) is an interface that allow us to monitor celery workers and see which worker run which task!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on a change in pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on a change in pull request #13116:
URL: https://github.com/apache/superset/pull/13116#discussion_r576681815
##########
File path: helm/superset/values.yaml
##########
@@ -165,6 +165,25 @@ supersetWorker:
name: '{{ tpl .Values.envFromSecret . }}'
command: [ "/bin/sh", "-c", "until nc -zv $DB_HOST $DB_PORT -w1; do echo 'waiting for db'; sleep 1; done" ]
+##
+## Superset beat configuration (to trigger scheduled jobs like reports)
+supersetBeat:
Review comment:
We also renamed this one to be consistent
```suggestion
supersetCeleryBeat:
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779718772
* Yes, we want to expose its port, it's done on our instance, I'll check what differs from `master` charts.
* I don't know if this instance must be a singleton or not, should check.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779732063
Sorry, I forgot to update the template to reflect the `supersetCeleryBeat` name change!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] vnourdin commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
vnourdin commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779061291
Also, we need to add documentation on the K8S part about this celery beat, I think this PR is the good one to do it!
Otherwise, we can add it in the other one that document Alerts&Reports, but seem more atomic to do it here.
I can help on this, I'm on the Superset's Slack if you want to reach me :wink:
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF commented on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF commented on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779713855
> [Flower](https://flower.readthedocs.io/en/latest/) is an interface that allow us to monitor celery workers and see which worker run which task!
OK. So from a Helm point of view this would mean that:
* We would also want a service to expose its port(s)
* Potentially we'll want to scale it - and potentially separately from the main pods
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org
[GitHub] [superset] Yann-OAF edited a comment on pull request #13116: feat(helm): Helm template for Celery beat (for reporting and alerting)
Posted by GitBox <gi...@apache.org>.
Yann-OAF edited a comment on pull request #13116:
URL: https://github.com/apache/superset/pull/13116#issuecomment-779835811
> LGTM, the suggestion on how to add the webdriver is not ideal. Calling @craig-rueda here for some additional thoughts
Yes I definitely agree... installing stuff at runtime isn't a really good practice since it creates extra risks and often requires running as `root`. The best would really be to have a pre-built image for it, but I'm not aware of any official ones, and this is out of scope of this PR anyway...
Btw I would argue that the same goes for the way extra pip packages are installed (which also requires running the containers as `root`...)
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@superset.apache.org
For additional commands, e-mail: notifications-help@superset.apache.org