From 1122ce147b4c068193c458000d5c231fb70884e0 Mon Sep 17 00:00:00 2001 From: abir-oumghar Date: Thu, 30 Apr 2026 06:49:47 +0200 Subject: [PATCH 1/2] docs: hive-metastore documentation audit - helm/hive-metastore/Chart.yaml: add the missing description field - helm/hive-metastore/README.md(.gotmpl): complete the Prerequisites section with PostgreSQL + S3 infrastructure dependencies - README.md: align badges, branding and footer with okdp-sandbox conventions --- README.md | 36 ++++++++++++++++++---------- helm/hive-metastore/Chart.yaml | 2 +- helm/hive-metastore/README.md | 11 +++++++++ helm/hive-metastore/README.md.gotmpl | 11 +++++++++ 4 files changed, 46 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 0e42455..a5192ff 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,39 @@ [![ci](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml) [![release-please](https://github.com/okdp/hive-metastore/actions/workflows/release-please.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/release-please.yml) +[![Release](https://img.shields.io/github/v/release/okdp/hive-metastore)](https://github.com/okdp/hive-metastore/releases/latest)   +[![Helm](https://img.shields.io/badge/helm-3+-blue.svg)](https://helm.sh/) +[![Kubernetes](https://img.shields.io/badge/kubernetes-1.19+-blue.svg)](https://kubernetes.io/)   [![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) + + + -

- -

+An [Apache Hive Metastore](https://cwiki.apache.org/confluence/display/hive/design#Design-Metastore) Docker image and Helm chart for Kubernetes, part of the [OKDP](https://okdp.io) (Open Kubernetes Data Platform) ecosystem. -This repo contains: +This repository contains: -- A Dockerfile and associated scripts to build the `hive-metastore` docker image. -- A corresponding helm chart. +- A **Dockerfile** and associated scripts to build the `hive-metastore` Docker image — published to [quay.io/okdp/hive-metastore](https://quay.io/repository/okdp/hive-metastore) +- A corresponding **Helm chart** — published to [quay.io/okdp/charts/hive-metastore](https://quay.io/repository/okdp/charts/hive-metastore) -A postgresql server with an empty database is to be provided. An init job will take care of creating the DB schema. +A PostgreSQL server with an empty database is to be provided. An init job will take care of creating the DB schema. Also, access to the target S3 service is required. -## Installation - -Refer to [README](helm/hive-metastore/README.md) for the customization and installation guide. - ## Requirements - Kubernetes cluster - [Helm](https://helm.sh/) installed +## Installation + +Refer to the [Helm chart README](helm/hive-metastore/README.md) for the customization and installation guide. + > [!NOTE] -> An OKDP sandbox, with all these helm charts installed, is under development and you can use it once released. -> +> An OKDP sandbox with all these helm charts pre-installed and ready to use is available at [okdp-sandbox](https://github.com/OKDP/okdp-sandbox). + +--- + +**Built for the OKDP Community** + + + diff --git a/helm/hive-metastore/Chart.yaml b/helm/hive-metastore/Chart.yaml index 7daa25a..ac82df9 100644 --- a/helm/hive-metastore/Chart.yaml +++ b/helm/hive-metastore/Chart.yaml @@ -14,9 +14,9 @@ # limitations under the License. # -# File generated by Makefile apiVersion: v2 name: hive-metastore +description: A Helm chart to deploy Apache Hive Metastore on Kubernetes, with PostgreSQL backend and S3 warehouse storage. version: 1.4.0 sources: - https://github.com/okdp/hive-metastore diff --git a/helm/hive-metastore/README.md b/helm/hive-metastore/README.md index e4723f0..2a42880 100644 --- a/helm/hive-metastore/README.md +++ b/helm/hive-metastore/README.md @@ -16,6 +16,15 @@ --> +[![ci](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml) +[![Release](https://img.shields.io/github/v/release/okdp/hive-metastore)](https://github.com/okdp/hive-metastore/releases/latest)   +[![Helm](https://img.shields.io/badge/helm-3+-blue.svg)](https://helm.sh/) +[![Kubernetes](https://img.shields.io/badge/kubernetes-1.19+-blue.svg)](https://kubernetes.io/)   +[![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) + + + + # hive-metastore ## Introduction @@ -26,6 +35,8 @@ This chart bootstraps a [Hive Metastore](https://cwiki.apache.org/confluence/dis - Helm >= 3 - Kubernetes >= 1.19 +- A PostgreSQL server with an empty database (an init job will create the schema automatically) +- Access to an S3 service for the warehouse storage ## Installing the chart diff --git a/helm/hive-metastore/README.md.gotmpl b/helm/hive-metastore/README.md.gotmpl index b0adec3..328b650 100644 --- a/helm/hive-metastore/README.md.gotmpl +++ b/helm/hive-metastore/README.md.gotmpl @@ -16,6 +16,15 @@ --> +[![ci](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml/badge.svg)](https://github.com/okdp/hive-metastore/actions/workflows/ci.yml) +[![Release](https://img.shields.io/github/v/release/okdp/hive-metastore)](https://github.com/okdp/hive-metastore/releases/latest)   +[![Helm](https://img.shields.io/badge/helm-3+-blue.svg)](https://helm.sh/) +[![Kubernetes](https://img.shields.io/badge/kubernetes-1.19+-blue.svg)](https://kubernetes.io/)   +[![License Apache2](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) + + + + {{ template "chart.header" . }} {{ template "chart.description" . }} @@ -30,6 +39,8 @@ This chart bootstraps a [Hive Metastore](https://cwiki.apache.org/confluence/dis - Helm >= 3 - Kubernetes >= 1.19 +- A PostgreSQL server with an empty database (an init job will create the schema automatically) +- Access to an S3 service for the warehouse storage ## Installing the chart From 330a21270e06d350f5fc4fc6a5e936b5a12e3c1b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 30 Apr 2026 04:59:20 +0000 Subject: [PATCH 2/2] [helm-docs] Update readme --- helm/hive-metastore/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/helm/hive-metastore/README.md b/helm/hive-metastore/README.md index 2a42880..3da15e0 100644 --- a/helm/hive-metastore/README.md +++ b/helm/hive-metastore/README.md @@ -27,6 +27,8 @@ # hive-metastore +A Helm chart to deploy Apache Hive Metastore on Kubernetes, with PostgreSQL backend and S3 warehouse storage. + ## Introduction This chart bootstraps a [Hive Metastore](https://cwiki.apache.org/confluence/display/hive/design#Design-Metastore) deployment using the [Helm](https://helm.sh) package manager.