tmater opened a new pull request, #3173:
URL: https://github.com/apache/polaris/pull/3173
## Summary
This PR adds a `NOTES.txt` template to the Helm chart to improve the user
experience after installation. Users will immediately see how to access Polaris
(via port-forward commands), check the health endpoint, and view logs for
troubleshooting.
For now, this focuses on the essential getting-started information. In the
future, we could extend this to include database bootstrap commands
(polaris-admin), credential information, or other advanced setup instructions.
During `helm install` or `helm upgrade`, it prints the following:
## Current output
```
Apache Polaris deployed successfully!
Release: polaris
Namespace: default
Version: 1.2.0-incubating-SNAPSHOT (App: 1.2.0-incubating-SNAPSHOT)
⚠️ WARNING: Using IN-MEMORY persistence - data will be lost on pod restart!
Access Polaris:
kubectl port-forward -n default svc/polaris 8181:8181
kubectl port-forward -n default svc/polaris-mgmt 8182:8182
Then access:
API: http://localhost:8181
Health: http://localhost:8182/q/health
View logs:
kubectl logs -l app.kubernetes.io/name=polaris -n default --tail=50 -f
```
## Usage
The notes are displayed automatically after `helm install` or `helm upgrade`:
```bash
helm install polaris ./helm/polaris
```
To suppress the notes output, use the `--no-notes` flag:
```bash
helm install polaris ./helm/polaris --no-notes
```
You can view the notes later with:
```bash
helm get notes polaris
```
--
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]
