QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-05-29 20:29:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor: rename docker-compose files and update references (#33790)

Browse Source 
Signed-off-by: Vladislav Polyakov <polRk@ydb.tech>
This commit is contained in:
Vladislav Polyakov
2025-06-20 22:00:34 +03:00
committed by GitHub
parent 63cb5807b6
commit a23a4ed054
14 changed files with 21 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/docs/installation/docker-compose.mdx
View File

@@ -28,14 +28,14 @@ way to launch a fully functioning **development environment** quickly.
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
1. **compose.yml:** for interactive development, where we mount your local folder with the
frontend/backend files that you can edit and experience the changes you
make in the app in real time
1. **docker-compose-non-dev.yml** where we just build a more immutable image based on the
1. **compose-non-dev.yml** where we just build a more immutable image based on the
local branch and get all the required images running. Changes in the local branch
at the time you fire this up will be reflected, but changes to the code
while `up` won't be reflected in the app
1. **docker-compose-image-tag.yml** where we fetch an image from docker-hub say for the
1. **compose-image-tag.yml** where we fetch an image from docker-hub say for the
`3.0.0` release for instance, and fire it up so you can try it. Here what's in
the local branch has no effects on what's running, we just fetch and run
pre-built images from docker-hub. For `docker compose` to work along with the
@@ -106,7 +106,7 @@ from within docker. This will slow down the startup, but will fix various npm-re
### Option #2 - build a set of immutable images from the local branch
```bash
docker compose -f docker-compose-non-dev.yml up
docker compose -f compose-non-dev.yml up
```
### Option #3 - boot up an official release
@@ -121,7 +121,7 @@ git fetch --depth=1 origin tag $TAG
# Checkout the corresponding git ref
git checkout $TAG
# Fire up docker compose
docker compose -f docker-compose-image-tag.yml up
docker compose -f compose-image-tag.yml up
```
Here various release tags, github SHA, and latest `master` can be referenced by the TAG env var.
@@ -179,7 +179,7 @@ that the logic runs a `from superset_config_docker import *`
:::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
do this is to modify the `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.
@@ -193,8 +193,8 @@ decisions about patching and long-term support. Scarf purges personally identifi
(PII) and provides only aggregated statistics.
To opt-out of this data collection for packages downloaded through the Scarf Gateway by your docker
compose based installation, edit the `x-superset-image:` line in your `docker-compose.yml` and
`docker-compose-non-dev.yml` files, replacing `apachesuperset.docker.scarf.sh/apache/superset` with
compose based installation, edit the `x-superset-image:` line in your `compose.yml` and
`compose-non-dev.yml` files, replacing `apachesuperset.docker.scarf.sh/apache/superset` with
`apache/superset` to pull the image directly from Docker Hub.
To disable the Scarf telemetry pixel, set the `SCARF_ANALYTICS` environment variable to `False` in
@@ -257,4 +257,4 @@ When running `docker compose up`, docker will build what is required behind the
may use the docker cache if assets already exist. Running `docker compose build` prior to
`docker compose up` or the equivalent shortcut `docker compose up --build` ensures that your
docker images matche the definition in the repository. This should only apply to the main
docker-compose.yml file (default) and not to the alternative methods defined above.
compose.yml file (default) and not to the alternative methods defined above.

2
docs/docs/installation/installation-methods.mdx
View File

@@ -19,7 +19,7 @@ The fundamental trade-off is between you needing to do more of the detail work y
If you're not just demoing the software, you'll need a moderate understanding of Docker to customize your deployment and avoid a few risks. Even when fully-optimized this is not as robust a method as Kubernetes when it comes to large-scale production deployments.
You manage a superset-config.py file and a docker-compose.yml file. Docker Compose brings up all the needed services - the Superset application, a Postgres metadata DB, Redis cache, Celery worker and beat. They are automatically connected to each other.
You manage a superset-config.py file and a compose.yml file. Docker Compose brings up all the needed services - the Superset application, a Postgres metadata DB, Redis cache, Celery worker and beat. They are automatically connected to each other.
**Responsibilities**