This is an automated email from the ASF dual-hosted git repository.
milenkovicm pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-ballista.git
The following commit(s) were added to refs/heads/main by this push:
new 50170849 chore(doc): Clean up deployment docs. (#1354)
50170849 is described below
commit 50170849e230b1f6361cdd34d6700960fbddbcee
Author: Louis Burke <[email protected]>
AuthorDate: Fri Jan 2 12:11:42 2026 +0000
chore(doc): Clean up deployment docs. (#1354)
* Rewords the introduction.
* Rewords the cargo install section.
* Rewords the docker section and updates builder Dockerfile.
* Rewords the docker compose, kubernetes, and scheduler sections.
* Rewords the docker compose, kubernetes, and scheduler sections.
* Adds a link to the docker section for the docker compose section.
* Adds a full stop
* Adds full stop
* Prettifies the docs.
* Rolls back change to builder Dockerfile.
---
docs/source/user-guide/deployment/cargo-install.md | 2 +-
.../source/user-guide/deployment/docker-compose.md | 22 +----------------
docs/source/user-guide/deployment/docker.md | 2 +-
docs/source/user-guide/deployment/kubernetes.md | 28 ++++------------------
docs/source/user-guide/introduction.md | 9 +++----
docs/source/user-guide/scheduler.md | 2 +-
6 files changed, 13 insertions(+), 52 deletions(-)
diff --git a/docs/source/user-guide/deployment/cargo-install.md
b/docs/source/user-guide/deployment/cargo-install.md
index 782073fd..9bd99e67 100644
--- a/docs/source/user-guide/deployment/cargo-install.md
+++ b/docs/source/user-guide/deployment/cargo-install.md
@@ -19,7 +19,7 @@
# Deploying a standalone Ballista cluster using cargo install
-A simple way to start a local cluster for testing purposes is to use cargo to
install
+Another simple way to start a local cluster for testing purposes is to use
cargo to install
the scheduler and executor crates.
```bash
diff --git a/docs/source/user-guide/deployment/docker-compose.md
b/docs/source/user-guide/deployment/docker-compose.md
index 3c7eb4f7..67f40b7a 100644
--- a/docs/source/user-guide/deployment/docker-compose.md
+++ b/docs/source/user-guide/deployment/docker-compose.md
@@ -23,27 +23,7 @@ Docker Compose is a convenient way to launch a cluster when
testing locally.
## Build Docker Images
-Run the following commands to download the [official Docker
image](https://github.com/apache/datafusion-ballista/pkgs/container/datafusion-ballista-standalone):
-
-```bash
-docker pull ghcr.io/apache/datafusion-ballista-standalone:latest
-```
-
-Altenatively run the following commands to clone the source repository and
build the Docker images from source:
-
-```bash
-git clone [email protected]:apache/datafusion-ballista.git -b latest
-cd datafusion-ballista
-./dev/build-ballista-docker.sh
-```
-
-This will create the following images:
-
-- `apache/datafusion-ballista-benchmarks:latest`
-- `apache/datafusion-ballista-cli:latest`
-- `apache/datafusion-ballista-executor:latest`
-- `apache/datafusion-ballista-scheduler:latest`
-- `apache/datafusion-ballista-standalone:latest`
+To create the required Docker images please refer to the [docker deployment
page](docker.md).
## Start a Cluster
diff --git a/docs/source/user-guide/deployment/docker.md
b/docs/source/user-guide/deployment/docker.md
index 971d1780..a0542377 100644
--- a/docs/source/user-guide/deployment/docker.md
+++ b/docs/source/user-guide/deployment/docker.md
@@ -27,7 +27,7 @@ Run the following commands to download the [official Docker
image](https://githu
docker pull ghcr.io/apache/datafusion-ballista-standalone:latest
```
-Altenatively run the following commands to clone the source repository and
build the Docker images from source:
+Alternatively run the following commands to clone the source repository and
build the Docker images from source:
```bash
git clone [email protected]:apache/datafusion-ballista.git
diff --git a/docs/source/user-guide/deployment/kubernetes.md
b/docs/source/user-guide/deployment/kubernetes.md
index f2b7e5ad..d3062ed8 100644
--- a/docs/source/user-guide/deployment/kubernetes.md
+++ b/docs/source/user-guide/deployment/kubernetes.md
@@ -41,27 +41,7 @@ microk8s enable dns
## Build Docker Images
-Run the following commands to download the [official Docker
image](https://github.com/apache/datafusion-ballista/pkgs/container/datafusion-ballista-standalone):
-
-```bash
-docker pull ghcr.io/apache/datafusion-ballista-standalone:0.12.0-rc4
-```
-
-Altenatively run the following commands to clone the source repository and
build the Docker images from source:
-
-```bash
-git clone [email protected]:apache/datafusion-ballista.git -b 0.12.0
-cd datafusion-ballista
-./dev/build-ballista-docker.sh
-```
-
-This will create the following images:
-
-- `apache/datafusion-ballista-benchmarks:0.12.0`
-- `apache/datafusion-ballista-cli:0.12.0`
-- `apache/datafusion-ballista-executor:0.12.0`
-- `apache/datafusion-ballista-scheduler:0.12.0`
-- `apache/datafusion-ballista-standalone:0.12.0`
+To create the required Docker images please refer to the [docker deployment
page](docker.md).
## Publishing Docker Images
@@ -267,9 +247,9 @@ kubectl delete -f cluster.yaml
## Autoscaling Executors
-Ballista supports autoscaling for executors through [Keda](http://keda.sh).
Keda allows scaling a deployment
-through custom metrics which are exposed through the Ballista scheduler, and
it can even scale the number of
-executors down to 0 if there is no activity in the cluster.
+Ballista supports autoscaling for executors through [Keda](http://keda.sh).
Keda allows for the scaling of a
+deployment through custom metrics which are exposed through the Ballista
scheduler, and it
+can even scale the number of executors down to 0 if there is no activity in
the cluster.
Keda can be installed in your kubernetes cluster through a single command line:
diff --git a/docs/source/user-guide/introduction.md
b/docs/source/user-guide/introduction.md
index 3f153de3..9fa01b05 100644
--- a/docs/source/user-guide/introduction.md
+++ b/docs/source/user-guide/introduction.md
@@ -21,9 +21,10 @@
Ballista is a distributed compute platform primarily implemented in Rust, and
powered by Apache DataFusion.
-Ballista has a scheduler and an executor process that are standard Rust
executables and can be executed directly, but
-Dockerfiles are provided to build images for use in containerized
environments, such as Docker, Docker Compose, and
-Kubernetes. See the [deployment guide](deployment.md) for more information
+Ballista has both scheduler and an executor component processes that are
standard Rust executables.
+
+Dockerfiles are also provided to build images for use in containerized
environments, such as Docker, Docker Compose,
+and Kubernetes. See the [deployment guide](deployment.md) for more information.
SQL and DataFrame queries can be submitted from Python and Rust, and SQL
queries can be submitted via the Arrow
Flight SQL JDBC driver, supporting your favorite JDBC compliant tools such as
[DataGrip](datagrip)
@@ -31,7 +32,7 @@ or [tableau](tableau). For setup instructions, please see the
[FlightSQL guide](
## How does this compare to Apache Spark?
-Although Ballista is largely inspired by Apache Spark, there are some key
differences.
+Although Ballista is largely inspired by Apache Spark, there are some key
differences:
- The choice of Rust as the main execution language means that memory usage is
deterministic and avoids the overhead
of GC pauses.
diff --git a/docs/source/user-guide/scheduler.md
b/docs/source/user-guide/scheduler.md
index be608ce6..26581f8c 100644
--- a/docs/source/user-guide/scheduler.md
+++ b/docs/source/user-guide/scheduler.md
@@ -23,7 +23,7 @@
The scheduler also provides a REST API that allows jobs to be monitored.
-> This is optional scheduler feature which should be enabled with `rest-api`
feature
+> This is optional scheduler feature which should be enabled with the
`rest-api` feature.
| API | Method | Description
|
| ------------------------------------ | ------ |
----------------------------------------------------------------- |
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
