openhouse

KO | EN

gitlite — search

#javascript #ios #ansible #android #java #nodejs #ubuntu #hacktoberfest #wordpress #typescript #chrome-extension #erlang

★ 395 Open GitHub ↗

Open Control Plane for Tables in Data Lakehouse

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<html>
  <div align="center">
    <img src="docs/images/openhouse-logo.jpeg" alt="OpenHouse" width="400" height="300">
  </div>
  <h3 align="center">
    Control Plane for Tables in Open Data Lakehouses
  </h3>
  <div align="center">
    <a href="https://github.com/linkedin/openhouse/actions?query=branch%3Amain">
      <img src="https://img.shields.io/github/actions/workflow/status/linkedin/openhouse/build-tag-publish.yml" alt="CI/CD">
    </a>
    <a href="https://github.com/linkedin/openhouse/commits/main/">
      <img src="https://img.shields.io/github/commit-activity/m/linkedin/openhouse/main" alt="Commit Activity">
    </a>
    <a href="https://www.openhousedb.org/docs/intro/">
      <img src="https://img.shields.io/badge/docs-grey" alt="Docs">
    </a>
  </div>
  <div align="center">
    <a href="https://linkedin.github.io/openhouse/">
      <img src="https://img.shields.io/badge/github-%23121011.svg?logo=github&logoColor=white" alt="GitHub">
    </a>
    <a href="https://join.slack.com/t/openhouse-bap9266/shared_invite/zt-2bsi0t8pi-wUOeDvQr8j8d5yl3X8WQJQ">
      <img src="https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=white" alt="Slack">
    </a>
  </div>
</html>

OpenHouse is an open source control plane designed for efficient management of tables within open data lakehouse
deployments. The control plane comprises a **declarative catalog** and a suite of **data services**. Users can
seamlessly define Tables, their schemas, and associated metadata declaratively within the catalog.
OpenHouse reconciles the observed state of Tables with the desired state by orchestrating various
data services.

## Getting Started

### Prerequisites

For building and running locally in [Docker Compose](SETUP.md), you would need the following:

- [Java](https://www.oracle.com/java/technologies/downloads/)
  - OpenHouse is currently built with Java 17.
  - Set the `JAVA_HOME` environment variable to the location of your JDK-17.
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
- [Python3](https://www.python.org/downloads/)

For deploying OpenHouse to [Kubernetes](DEPLOY.md), you would need the following:
- [Helm](https://helm.sh/docs/intro/install/)
- [Kubernetes](https://kubernetes.io/docs/setup/)

### Building OpenHouse

To build OpenHouse, you can use the following command:
```bash
./gradlew build
```

### Running OpenHouse with Docker Compose

The quickest way to run OpenHouse locally:
```bash
# Build JARs, Docker images, and start containers (default: oh-hadoop-spark recipe)
./gradlew dockerUp

# Or use a lighter recipe for faster startup
./gradlew dockerUp -Precipe=oh-only

# Stop containers
./gradlew dockerDown
```

For detailed configuration options and testing instructions, see the [SETUP](SETUP.md) guide.

### Deploying OpenHouse to Kubernetes

To deploy OpenHouse to Kubernetes, you can use the [DEPLOY](DEPLOY.md) guide. You would build the container images for
all the OpenHouse services, and deploy them to a Kubernetes cluster using Helm.

### Compability Matrix

OpenHouse is built with the following versions of the open-source projects:

| Project | Version |
| --- | --- |
| [Apache Iceberg](https://iceberg.apache.org/releases/#120-release) | 1.2.0 |
| [Apache Spark](https://spark.apache.org/releases/) | 3.1.2 |
| [Apache Livy](https://livy.apache.org/) | 0.7.0-incubating |
| [Apache Hadoop Client](https://hadoop.apache.org/releases.html) | 2.10.0 |
| [Springboot Framework](https://spring.io/projects/spring-boot) | 2.6.6 |
| [OpenAPI](https://swagger.io/specification/) | 3.0.3 |

## Contributing

We welcome contributions to OpenHouse. To get involved:

- Join [OpenHouse Slack](https://join.slack.com/t/openhouse-bap9266/shared_invite/zt-2bsi0t8pi-wUOeDvQr8j8d5yl3X8WQJQ)
- Open [Github Issue](https://github.com/linkedin/openhouse/issues) for the feature or bug you want to collaborate on

Please refer to the [CONTRIBUTING](CONTRIBUTING.md) guide for more details.
To get started on the high-level architecture, please refer to the [ARCHITECTURE](ARCHITECTURE.md) guide.

openhouse

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README