From 2b0ffb01b654c1168a33870c668f938aea9afdbd Mon Sep 17 00:00:00 2001 From: Arjun Devarajan Date: Wed, 19 Jul 2023 09:16:20 -0400 Subject: [PATCH] feat: use Scarf Gateway for Superset helm charts/Docker compose downloads (#24432) --- docker-compose-non-dev.yml | 2 +- docker-compose.yml | 2 +- docs/.gitignore | 2 ++ docs/docs/frequently-asked-questions.mdx | 6 ++++++ .../installing-superset-using-docker-compose.mdx | 9 ++++++++- docs/docs/installation/running-on-kubernetes.mdx | 4 ++++ helm/superset/Chart.yaml | 2 +- helm/superset/README.md | 4 ++-- helm/superset/values.yaml | 2 +- 9 files changed, 26 insertions(+), 7 deletions(-) diff --git a/docker-compose-non-dev.yml b/docker-compose-non-dev.yml index 070a1bb12c..0ce96e00ba 100644 --- a/docker-compose-non-dev.yml +++ b/docker-compose-non-dev.yml @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -x-superset-image: &superset-image apache/superset:${TAG:-latest-dev} +x-superset-image: &superset-image apachesuperset.docker.scarf.sh/apache/superset:${TAG:-latest-dev} x-superset-depends-on: &superset-depends-on - db - redis diff --git a/docker-compose.yml b/docker-compose.yml index c6af8e54f3..bd965f156a 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -14,7 +14,7 @@ # See the License for the specific language governing permissions and # limitations under the License. # -x-superset-image: &superset-image apache/superset:${TAG:-latest-dev} +x-superset-image: &superset-image apachesuperset.docker.scarf.sh/apache/superset:${TAG:-latest-dev} x-superset-user: &superset-user root x-superset-depends-on: &superset-depends-on - db diff --git a/docs/.gitignore b/docs/.gitignore index b2d6de3062..9f2d3dbb1c 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -18,3 +18,5 @@ npm-debug.log* yarn-debug.log* yarn-error.log* + +docs/.zshrc diff --git a/docs/docs/frequently-asked-questions.mdx b/docs/docs/frequently-asked-questions.mdx index 381746e650..bbb94d617b 100644 --- a/docs/docs/frequently-asked-questions.mdx +++ b/docs/docs/frequently-asked-questions.mdx @@ -282,3 +282,9 @@ guarantees and are not recommended but may fit your use case temporarily: In the Edit Dataset view, you can specify a time offset. This field lets you configure the number of hours to be added or subtracted from the time column. This can be used, for example, to convert UTC time to local time. + +### Does Superset collect any telemetry data? + +Superset uses [Scarf](https://about.scarf.sh/) by default to collect basic telemetry data upon installing and/or running Superset. This data helps the maintainers of Superset better understand which versions of Superset are being used, in order to prioritize patch/minor releases and security fixes. +We use the [Scarf Gateway](https://docs.scarf.sh/gateway/) to sit in front of container registries, and the [scarf-js](https://about.scarf.sh/package-sdks) package to track `npm` installations. +Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track) and [here](https://docs.scarf.sh/package-analytics/#as-a-user-of-a-package-using-scarf-js-how-can-i-opt-out-of-analytics). Additional opt-out instructions for Docker users are available on the [Docker Installation](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose) page. diff --git a/docs/docs/installation/installing-superset-using-docker-compose.mdx b/docs/docs/installation/installing-superset-using-docker-compose.mdx index 7cfb76fce1..981fca8147 100644 --- a/docs/docs/installation/installing-superset-using-docker-compose.mdx +++ b/docs/docs/installation/installing-superset-using-docker-compose.mdx @@ -96,7 +96,14 @@ You can configure the Docker Compose environment varirables for dev and non-dev One important variable is `SUPERSET_LOAD_EXAMPLES` which determines whether the `superset_init` container will load example data and visualizations into the database and Superset. These examples are quite helpful for most people, but probably unnecessary for experienced users. The loading process can sometimes take a few minutes and a good amount of CPU, so you may want to disable it on a resource-constrained device. -**Note:** Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the `docker-compose-non-dev.yml` file and add your database as a service that the other services depend on (via `x-superset-depends-on`). Others have attempted to set `network_mode: host` on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solution for this, let us know! + +:::note +Users often want to connect to other databases from Superset. Currently, the easiest way to do this is to modify the `docker-compose-non-dev.yml` file and add your database as a service that the other services depend on (via `x-superset-depends-on`). Others have attempted to set `network_mode: host` on the Superset services, but these generally break the installation, because the configuration requires use of the Docker Compose DNS resolver for the service names. If you have a good solution for this, let us know! +::: + +:::note +Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telmetry data to better understand and support the need for patch versions of Sueprset. Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track). However, if you wish to opt-out of this in your Docker-based installation, you can simply edit your `docker-compose.yml` or `docker-compose-non-dev.yml` file and remove `apachesuperset.docker.scarf.sh/` from the `x-superset-image` setting, so that it's simply pulling `apache/superset:${TAG:-latest-dev}` +::: ### 4. Log in to Superset diff --git a/docs/docs/installation/running-on-kubernetes.mdx b/docs/docs/installation/running-on-kubernetes.mdx index 17b884aeea..2a63de9b46 100644 --- a/docs/docs/installation/running-on-kubernetes.mdx +++ b/docs/docs/installation/running-on-kubernetes.mdx @@ -121,6 +121,10 @@ init: . {{ .Values.configMountPath }}/superset_init.sh ``` +:::note +Superset uses [Scarf Gateway](https://about.scarf.sh/scarf-gateway) to collect telmetry data to better understand and support the need for patch versions of Sueprset. Scarf purges PII and provides aggregated statistics. Superset users can easily opt out of analytics in various ways documented [here](https://docs.scarf.sh/gateway/#do-not-track). However, if you wish to opt-out of this in your Helm-based installation, you can simply edit your `helm/superset/values.yaml` file and remove `apachesuperset.docker.scarf.sh/` from the `repository` field, so that it's simply pulling `apache/superset` +::: + #### Dependencies Install additional packages and do any other bootstrap configuration in the bootstrap script. diff --git a/helm/superset/Chart.yaml b/helm/superset/Chart.yaml index 3198e648ac..7582c560c4 100644 --- a/helm/superset/Chart.yaml +++ b/helm/superset/Chart.yaml @@ -29,7 +29,7 @@ maintainers: - name: craig-rueda email: craig@craigrueda.com url: https://github.com/craig-rueda -version: 0.10.4 +version: 0.10.5 dependencies: - name: postgresql version: 12.1.6 diff --git a/helm/superset/README.md b/helm/superset/README.md index 217b27b670..9ee8b9d12c 100644 --- a/helm/superset/README.md +++ b/helm/superset/README.md @@ -23,7 +23,7 @@ NOTE: This file is generated by helm-docs: https://github.com/norwoodj/helm-docs # superset -![Version: 0.10.4](https://img.shields.io/badge/Version-0.10.4-informational?style=flat-square) +![Version: 0.10.5](https://img.shields.io/badge/Version-0.10.5-informational?style=flat-square) Apache Superset is a modern, enterprise-ready business intelligence web application @@ -70,7 +70,7 @@ helm install my-superset superset/superset | fullnameOverride | string | `nil` | Provide a name to override the full names of resources | | hostAliases | list | `[]` | Custom hostAliases for all superset pods # https://kubernetes.io/docs/tasks/network/customize-hosts-file-for-pods/ | | image.pullPolicy | string | `"IfNotPresent"` | | -| image.repository | string | `"apache/superset"` | | +| image.repository | string | `"apachesuperset.docker.scarf.sh/apache/superset"` | | | image.tag | string | `""` | | | imagePullSecrets | list | `[]` | | | ingress.annotations | object | `{}` | | diff --git a/helm/superset/values.yaml b/helm/superset/values.yaml index bff8b30efd..660aac8af5 100644 --- a/helm/superset/values.yaml +++ b/helm/superset/values.yaml @@ -176,7 +176,7 @@ configMountPath: "/app/pythonpath" extraConfigMountPath: "/app/configs" image: - repository: apache/superset + repository: apachesuperset.docker.scarf.sh/apache/superset tag: "" pullPolicy: IfNotPresent