Skip to content

Commit f05cea4

Browse files
committed
Move docker readme to docs
1 parent 2d082ae commit f05cea4

File tree

3 files changed

+31
-18
lines changed

3 files changed

+31
-18
lines changed

docker/README.md renamed to docs/docker.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,21 @@
22

33
The Docker image of Trino Gateway is designed for the following use cases:
44

5-
* Manual usage in front of Trino clusters by mounting in a configuration file
6-
* Automated usage with an orchestration system like Kubernetes to simplify
7-
deployment
5+
* Manual usage in front of Trino clusters with `docker` or `docker-compose`
6+
commands for development and testing.
7+
* Automated usage with [Helm chart for deployment of the container on
8+
Kubernetes](installation.md#helm).
9+
10+
The latest version of the Trino Gateway container image is available on
11+
DockerHub with the identifier `trinodb/trino-gateway`. Append where
12+
`:<version>` with a version number to use a specific release, for example
13+
`trinodb/trino-gateway:11`.
814

915
## Production setup
1016

11-
The healthcheck configurations in the `docker-compose` file is for suitable for development and testing purposes only.
12-
Change the configuration for your production deployment based on the workload and your specific requirements.
17+
The healthcheck configurations in the `docker-compose` file is for suitable
18+
for development and testing purposes only. Change the configuration for
19+
your production deployment based on the workload and your specific requirements.
1320

1421
## Build requirements
1522

@@ -18,12 +25,12 @@ This docker build process requires the following software:
1825
* [Docker Compose V2](https://docs.docker.com/compose/)
1926
* jq
2027

21-
# Building a custom Docker image
28+
## Building a custom Docker image
2229

2330
Use the following steps to build a Docker image from your local Trino Gateway
2431
codebase
2532

26-
First, run the [Maven build in the project root](../docs/development.md).
33+
First, run the [Maven build in the project root](development.md).
2734

2835
Then build the image for your desired processor architecture in the `docker` directory:
2936

@@ -44,10 +51,10 @@ number and`-yyy` is the processor architecture:
4451

4552
```bash
4653
$ docker images
47-
REPOSITORY TAG IMAGE ID CREATED SIZE
48-
trino-gateway 6-SNAPSHOT-ppc64le a72b750d2745 33 seconds ago 547MB
49-
trino-gateway 6-SNAPSHOT-arm64 bc5e8b0db63c 35 seconds ago 523MB
50-
trino-gateway 6-SNAPSHOT-amd64 6c066fa5b0c5 36 seconds ago 518MB
54+
REPOSITORY TAG IMAGE ID CREATED SIZE
55+
trino-gateway 6-SNAPSHOT-ppc64le a72b750d2745 33 seconds ago 547MB
56+
trino-gateway 6-SNAPSHOT-arm64 bc5e8b0db63c 35 seconds ago 523MB
57+
trino-gateway 6-SNAPSHOT-amd64 6c066fa5b0c5 36 seconds ago 518MB
5158
...
5259
```
5360

@@ -58,8 +65,8 @@ the `-r` option. The build script downloads all the required artifacts:
5865
./build.sh -r 4
5966
```
6067

61-
Set the environment variable `TRINO_GATEWAY_BASE_IMAGE` to use a specific base image
62-
to build Trino Gateway image.
68+
Set the environment variable `TRINO_GATEWAY_BASE_IMAGE` to use a specific base
69+
image to build Trino Gateway image.
6370

6471
```bash
6572
export TRINO_GATEWAY_BASE_IMAGE=<image>
@@ -92,7 +99,7 @@ Use a published image from Docker Hub.
9299
export TRINO_GATEWAY_IMAGE="trinodb/trino-gateway:latest"
93100
```
94101

95-
The release process publishes images for Trino Gateway 6 and newer to Docker Hub.
102+
The release process publishes images for Trino Gateway 6 and newer to DockerHub.
96103

97104
Next set the image and platform:
98105

docs/installation.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,15 @@
22

33
Trino Gateway is distributed as an executable JAR file. The [release
44
notes](release-notes.md) contain links to download specific versions.
5-
Alternatively, you can look at the [development instructions](development.md) to
6-
build the JAR file or use the TrinoGatewayRunner for local testing.
5+
6+
Every Trino Gateway release includes a [Docker container](docker.md) and a
7+
[Helm chart](installation.md#helm) as alternative deployment methods.
8+
9+
Follow the [development instructions](development.md) to
10+
build the JAR file and the Docker image instructions or use the
11+
`TrinoGatewayRunner` class for local testing.
712
The [quickstart guide](quickstart.md) contains instructions for running the
8-
application locally.
13+
application locally.
914

1015
Following are instructions for installing Trino Gateway for production
1116
environments.
@@ -196,7 +201,7 @@ java -XX:MinRAMPercentage=50 -XX:MaxRAMPercentage=80 \
196201
-jar gateway-ha.jar gateway-config.yml
197202
```
198203

199-
### Helm
204+
### Helm <a name="helm"></a>
200205

201206
Helm manages the deployment of Kubernetes applications by templating Kubernetes
202207
resources with a set of Helm charts. The Trino Gateway Helm chart consists

mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,5 +94,6 @@ nav:
9494
- Migration to Airlift: migration-to-airlift.md
9595
- Contribute:
9696
- Code: development.md
97+
- Docker: docker.md
9798
- Routers: routers.md
9899
- Documentation: docs.md

0 commit comments

Comments
 (0)