openhouse

(โ˜… 395)

Open Control Plane for Tables in Data Lakehouse

  • .gitignore
  • ARCHITECTURE.md
  • build.gradle
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • DEPLOY.md
  • gradle.properties
  • gradlew
  • housetables-service.Dockerfile
  • jobs-scheduler.Dockerfile
  • jobs-service.Dockerfile
  • LICENSE
  • NOTICE
  • README.md
  • run.sh
  • SECURITY.md
  • settings.gradle
  • SETUP.md
  • tables-service.Dockerfile

# Installation Guide

1. Get the code
git clone https://github.com/linkedin/openhouse

Downloads the entire project code from GitHub to your computer.

cd openhouse

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker compose -f infra/recipes/docker-compose/oh-abs-spark/docker-compose.yml up -d --build

Runs the command against the services defined in the compose file.

โœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Gradle (Java/Kotlin)

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • JDK (Java) Required to build and run Java/Kotlin projects.
  • Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.
./gradlew build

Builds the project using Gradle.

./gradlew dockerUp

Builds the project using Gradle.

./gradlew dockerUp -Precipe=oh-only

Builds the project using Gradle.

./gradlew dockerDown

Builds the project using Gradle.

โœ… A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
pip install -r scripts/python/requirements.txt

Installs the Python libraries listed in requirements.txt (or similar).

python <์‹คํ–‰ํ•  ํŒŒ์ผ๋ช…>.py # README์—์„œ ์ •ํ™•ํ•œ ์‹คํ–‰ ํŒŒ์ผ๋ช…์„ ํ™•์ธํ•˜์„ธ์š”

Runs the Python script (or module).

โœ… If it runs without errors and prints output in the terminal, it worked.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
โš ๏ธ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd integrations/python/dataloader

This project's files live in a subfolder, so move into it first.

make

Compiles the code based on the generated build configuration to produce an executable.

โœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation