From 48b3909e20f510228eb17465a7d17ad5dcf9ece4 Mon Sep 17 00:00:00 2001 From: Alfredo Gutierrez Date: Mon, 25 Nov 2024 09:58:47 -0600 Subject: [PATCH] updating chart installation instructions and publish package. Signed-off-by: Alfredo Gutierrez --- .github/workflows/release-push-image.yaml | 2 +- charts/hedera-block-node/README.md | 24 +++++++++++++++++------ 2 files changed, 19 insertions(+), 7 deletions(-) diff --git a/.github/workflows/release-push-image.yaml b/.github/workflows/release-push-image.yaml index 4fc95bd17..012cd79d7 100644 --- a/.github/workflows/release-push-image.yaml +++ b/.github/workflows/release-push-image.yaml @@ -137,4 +137,4 @@ jobs: - name: Push helm chart run: | - helm push hedera-block-node-chart-${{ env.VERSION }}.tgz oci://ghcr.io/hashgraph/hedera-block-node + helm push hedera-block-node-chart-${{ env.VERSION }}.tgz oci://ghcr.io/hashgraph/hedera-block-node/charts diff --git a/charts/hedera-block-node/README.md b/charts/hedera-block-node/README.md index 1a938661b..7f054e962 100644 --- a/charts/hedera-block-node/README.md +++ b/charts/hedera-block-node/README.md @@ -5,24 +5,36 @@ Installs the Hedera Block Node on a Kubernetes cluster. - Helm 3+ - Kubernetes 1.29+ -Set environment variables that will be used for the remainder of the document: +Set environment variables that will be used for the remainder of the document, replacing the values with the appropriate values for your environment: bn1 is short for block-node-1, but you can name you release as you wish. And use the version that you want to install. ```bash export RELEASE="bn1" +export VERSION="0.3.0-SNAPSHOT" ``` ## Template -To generate the K8 manifest files without installing the chart: +To generate the K8 manifest files without installing the chart, you need to clone this repo and navigate to `/charts` folder. ```bash helm template --name-template my-bn hedera-block-node/ --dry-run --output-dir out ``` -## Install -To install the chart: +## Install using released chart + +To pull the packaged chart from public repo: +```bash +helm pull oci://ghcr.io/hashgraph/hedera-block-node/charts/hedera-block-node-chart --version "${VERSION}" +``` + +To install the chart with default values: ```bash -helm repo add hedera-block-node https://hashgraph.github.io/hedera-block-node/charts -helm install "${RELEASE}" hedera-block-node/hedera-block-node -f +helm install "${RELEASE}" hedera-block-node/charts/hedera-block-node-chart-$VERSION.tgz ``` + +To install the chart with custom values: +```bash +helm install "${RELEASE}" hedera-block-node/charts/hedera-block-node-chart-$VERSION.tgz -f +``` + *Note:* If using the chart directly after cloning the github repo, there is no need to add the repo. and install can be directly. Assuming you are at the root folder of the repo. ```bash