From f3783956c027c0d66705e986a595f646e80132c9 Mon Sep 17 00:00:00 2001 From: Justin Mclean Date: Tue, 11 Mar 2025 19:17:45 +0800 Subject: [PATCH] [MINOR] Add note about known security vulnerabilities. (#6665) ### What changes were proposed in this pull request? Add note about known security vulnerabilities ### Why are the changes needed? Some users are using older versions of software used in conjunction with Gravitino than may contain known security vulnerabilities Fix: #N/A ### Does this PR introduce _any_ user-facing change? No. ### How was this patch tested? Locally. --- docs/how-to-build.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/how-to-build.md b/docs/how-to-build.md index a15b324169b..9b45ecc7366 100644 --- a/docs/how-to-build.md +++ b/docs/how-to-build.md @@ -25,6 +25,7 @@ license: "This software is licensed under the Apache License version 2." + Gravitino excludes all Docker-related tests by default. To run Docker-related tests, make sure you have installed Docker in your environment and either (1) set `skipDockerTests=false` in the `gradle.properties` file (or use `-PskipDockerTests=false` in the command) or (2) `export SKIP_DOCKER_TESTS=false` in the shell. Otherwise, all tests requiring Docker will be skipped. + macOS uses `docker-connector` to make the Gravitino Trino connector work with Docker for macOS. See [docker-connector](https://github.com/wenjunxiao/mac-docker-connector), `$GRAVITINO_HOME/dev/docker/tools/mac-docker-connector.sh`, and `$GRAVITINO_HOME/dev/docker/tools/README.md` for more details. + You can use OrbStack as a replacement for Docker for macOS. See [OrbStack](https://orbstack.dev/). With OrbStack, you can run Gravitino integration tests without needing to install `docker-connector`. ++ Depending on how you deploy Gravitino, other software used in conjunction with Gravitino may contain known security vulnerabilities. ::: ## Quick start