QT/superset2
1
0
Fork 0
mirror of https://github.com/apache/superset.git synced 2026-04-24 18:44:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): docker instructions use docker compose instead of the deprecated docker-compose (#30030)

Browse Source
This commit is contained in:
Evan Rusackas
2024-08-29 16:42:53 -06:00
committed by GitHub
parent e2c4435cab
commit 4fe3000275
12 changed files with 34 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/docs/contributing/development.mdx
View File

@@ -6,13 +6,13 @@ version: 1
# Setting up a Development Environment
The documentation in this section is a bit of a patchwork of knowledge representing the
multitude of ways that exist to run Superset (`docker-compose`, just "docker", on "metal", using
multitude of ways that exist to run Superset (`docker compose`, just "docker", on "metal", using
a Makefile).
:::note
Now we have evolved to recommend and support `docker-compose` more actively as the main way
Now we have evolved to recommend and support `docker compose` more actively as the main way
to run Superset for development and preserve your sanity. **Most people should stick to
the first few sections - ("Fork & Clone", "docker-compose" and "Installing Dev Tools")**
the first few sections - ("Fork & Clone", "docker compose" and "Installing Dev Tools")**
:::
## Fork and Clone
@@ -27,12 +27,12 @@ git clone git@github.com:your-username/superset.git
cd superset
```
## docker-compose (recommended!)
## docker compose (recommended!)
Setting things up to squeeze an "hello world" into any part of Superset should be as simple as
```bash
docker-compose up
docker compose up
```
Note that:
@@ -54,9 +54,9 @@ Note that:
- You can login with admin/admin
:::caution
Since `docker-compose` is primarily designed to run a set of containers on **a single host**
Since `docker compose` is primarily designed to run a set of containers on **a single host**
and can't credibly support **high availability** as a result, we do not support nor recommend
using our `docker-compose` constructs to support production-type use-cases. For single host
using our `docker compose` constructs to support production-type use-cases. For single host
environments, we recommend using [minikube](https://minikube.sigs.k8s.io/docs/start/) along
our [installing on k8s](https://superset.apache.org/docs/installation/running-on-kubernetes)
documentation.
@@ -66,10 +66,10 @@ configured to be secure.
## Installing Development Tools
:::note
While docker-compose simplifies a lot of the setup, there are still
While `docker compose` simplifies a lot of the setup, there are still
many things you'll want to set up locally to power your IDE, and things like
**commit hooks**, **linters**, and **test-runners**. Note that you can do these
things inside docker images with commands like `docker-compose exec superset_app bash` for
things inside docker images with commands like `docker compose exec superset_app bash` for
instance, but many people like to run that tooling from their host.
:::
@@ -137,11 +137,11 @@ You can also run the pre-commit checks manually in various ways:
of available hooks in the `.pre-commit-config.yaml` file.
## Alternatives to docker-compose
## Alternatives to `docker compose`
:::caution
This part of the documentation is a patchwork of information related to setting up
development environments without `docker-compose` and are documented/supported to varying
development environments without `docker compose` and are documented/supported to varying
degrees. It's been difficult to maintain this wide array of methods and insure they're
functioning across environments.
:::
@@ -652,7 +652,7 @@ For debugging locally using VSCode, you can configure a launch configuration fil
}
```
#### Raw Docker (without docker-compose)
#### Raw Docker (without `docker compose`)
Follow these instructions to debug the Flask app running inside a docker container. Note that
this will run a barebones Superset web server,
@@ -771,7 +771,7 @@ See (set capabilities for a container)[https://kubernetes.io/docs/tasks/configur
Once the pod is running as root and has the SYS_PTRACE capability it will be able to debug the Flask app.
You can follow the same instructions as in the docker-compose. Enter the pod and install the required library and packages; gdb, netstat and debugpy.
You can follow the same instructions as in `docker compose`. Enter the pod and install the required library and packages; gdb, netstat and debugpy.
Often in a Kubernetes environment nodes are not addressable from outside the cluster. VSCode will thus be unable to remotely connect to port 5678 on a Kubernetes node. In order to do this you need to create a tunnel that port forwards 5678 to your local machine.