bitflicker64 commented on code in PR #3363:
URL: https://github.com/apache/hugegraph/pull/3363#discussion_r4297179109
##########
helm/hugegraph/README.md:
##########
@@ -6,11 +6,27 @@ The OCI chart is named `hugegraph-helm`; the application and
default Kubernetes
`hugegraph`. This chart targets HugeGraph 1.8.0 and later; earlier service
releases
are not supported.
-See [distribution and offline installation](docs/distribution.md) for versioned
-GHCR/Docker Hub commands. Source installs below use the same chart in
-`helm/hugegraph`.
+## Install a published Chart
-## Install and open Hubble
+For a quick trial, install the latest available Chart from GHCR:
+
+```bash
+helm install hugegraph oci://ghcr.io/hugegraph/hugegraph-helm --devel \
+ -n hugegraph --create-namespace --wait --timeout 15m
+```
+
+> [!TIP]
+> `--devel` selects the highest Chart version, including development and stable
+> versions, without limiting the version series. For production or reproducible
+> installs, replace it with `--version <published-version>` and review the
images.
+
+See [distribution and offline installation](docs/distribution.md) for Docker
Hub,
+the single-node preset and internal OCI/HTTP repositories. Development Charts
may
+use `latest` images; pin component `image.digest` values when needed.
+The source installation and configuration examples below assume a repository
+checkout and commands run from its root.
+
+## Install from source and open Hubble
Review Comment:
Minor: The storage prerequisite now sits under the source-only heading,
while the new quick trial above installs the same default topology without it.
`helm install hugegraph oci://ghcr.io/hugegraph/hugegraph-helm --devel`
renders the default 3 PD + 3 Store + Hubble claims (7 volumes). On a cluster
without a default StorageClass or matching PVs, the PVCs stay Pending and
`--wait --timeout 15m` times out. A reader of "Install a published Chart" has
no reason to read the "Install from source" section first. The merged website
page puts this prerequisite before both install paths.
Move the StorageClass / 7-volume paragraph (and the `kubectl get
storageclass` check) above "Install a published Chart", or link to it from the
quick trial.
##########
helm/hugegraph/README.md:
##########
@@ -6,11 +6,27 @@ The OCI chart is named `hugegraph-helm`; the application and
default Kubernetes
`hugegraph`. This chart targets HugeGraph 1.8.0 and later; earlier service
releases
are not supported.
-See [distribution and offline installation](docs/distribution.md) for versioned
-GHCR/Docker Hub commands. Source installs below use the same chart in
-`helm/hugegraph`.
+## Install a published Chart
-## Install and open Hubble
+For a quick trial, install the latest available Chart from GHCR:
+
+```bash
+helm install hugegraph oci://ghcr.io/hugegraph/hugegraph-helm --devel \
Review Comment:
Minor: README line 4 says this Chart requires Helm 3.8+, but the published
Chart this command installs does not render before Helm 3.10.
With 0.2.0-dev.14 from GHCR, `helm template hugegraph
oci://ghcr.io/hugegraph/hugegraph-helm --devel` fails on Helm 3.8.0 and 3.9.4
with `_helpers.tpl:201:64: executing "hugegraph.server.authSecretPassword" at
<"data">: wrong type for value; expected map[string]interface {}; got string`.
The single, cluster and strict presets fail the same way; 3.10.0 renders all of
them. Line 201 needs `and` to stop at the empty `lookup` result, which Go
templates only do from Go 1.18, and 3.10.0 is the first Helm built with it.
With an admin password set, 3.9.4 still fails at `_helpers.tpl:571`. OCI pull
itself works on 3.8.0, so the OCI note in distribution.md is fine.
Please raise the minimum to Helm 3.10+ in README.md line 4 and on the
website.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
