-
Notifications
You must be signed in to change notification settings - Fork 340
Add NOTES.txt to Helm chart with installation instructions #3173
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
tmater
wants to merge
3
commits into
apache:main
Choose a base branch
from
tmater:notes_txt
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| {{/* | ||
| Licensed to the Apache Software Foundation (ASF) under one | ||
| or more contributor license agreements. See the NOTICE file | ||
| distributed with this work for additional information | ||
| regarding copyright ownership. The ASF licenses this file | ||
| to you under the Apache License, Version 2.0 (the | ||
| "License"); you may not use this file except in compliance | ||
| with the License. You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, | ||
| software distributed under the License is distributed on an | ||
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| KIND, either express or implied. See the License for the | ||
| specific language governing permissions and limitations | ||
| under the License. | ||
| */}} | ||
| {{/* | ||
| Helper template to generate access instructions for a service. | ||
| Parameters: | ||
| - serviceType: ClusterIP, NodePort, or LoadBalancer | ||
| - serviceName: Kubernetes service name | ||
| - port: Service port number | ||
| - namespace: Kubernetes namespace | ||
| - label: Display label (e.g., "API" or "Health") | ||
| - path: Optional URL path (e.g., "/q/health") | ||
| - isFirstNodePort: Whether to export NODE_IP (set to true only for the first NodePort service to avoid duplicate exports) | ||
| */}} | ||
| {{- define "polaris.accessInstructions" -}} | ||
| {{- $serviceType := .serviceType -}} | ||
| {{- $serviceName := .serviceName -}} | ||
| {{- $port := .port -}} | ||
| {{- $namespace := .namespace -}} | ||
| {{- $label := .label -}} | ||
| {{- $path := .path | default "" -}} | ||
| {{- $isFirstNodePort := .isFirstNodePort | default false }} | ||
| {{- if eq $serviceType "LoadBalancer" }} | ||
| export {{ upper $label }}_IP=$(kubectl get svc -n {{ $namespace }} {{ $serviceName }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') | ||
| echo "{{ $label }}: http://${{ upper $label }}_IP:{{ $port }}{{ $path }}" | ||
| {{- else if eq $serviceType "NodePort" }} | ||
| {{- if $isFirstNodePort }} | ||
| export NODE_IP=$(kubectl get nodes -o jsonpath='{.items[0].status.addresses[?(@.type=="ExternalIP")].address}') | ||
| {{- end }} | ||
| export {{ upper $label }}_PORT=$(kubectl get svc -n {{ $namespace }} {{ $serviceName }} -o jsonpath='{.spec.ports[0].nodePort}') | ||
| echo "{{ $label }}: http://$NODE_IP:${{ upper $label }}_PORT{{ $path }}" | ||
| {{- else }} | ||
| {{ $label }}: http://localhost:{{ $port }}{{ $path }} | ||
| {{- end }} | ||
| {{- end -}} | ||
|
|
||
| Apache Polaris deployed successfully! | ||
|
|
||
| Release: {{ .Release.Name }} | ||
| Namespace: {{ .Release.Namespace }} | ||
| Version: {{ .Chart.Version }} (App: {{ .Chart.AppVersion }}) | ||
|
|
||
| {{- if eq .Values.persistence.type "in-memory" }} | ||
|
|
||
| ⚠️ WARNING: Using IN-MEMORY persistence - data will be lost on pod restart! | ||
| {{- end }} | ||
|
|
||
| Access Polaris: | ||
| {{- if eq .Values.service.type "ClusterIP" }} | ||
|
|
||
| kubectl port-forward -n {{ .Release.Namespace }} svc/{{ include "polaris.fullname" . }} {{ (first .Values.service.ports).port }}:{{ (first .Values.service.ports).port }} | ||
| {{- end }} | ||
| {{ include "polaris.accessInstructions" (dict "serviceType" .Values.service.type "serviceName" (include "polaris.fullname" .) "port" (first .Values.service.ports).port "namespace" .Release.Namespace "label" "API" "isFirstNodePort" true) }} | ||
| {{- if and (ne .Values.service.type "ClusterIP") (ne .Values.managementService.type "ClusterIP") }} | ||
|
|
||
| {{- end }} | ||
| {{- if and (ne .Values.service.type "ClusterIP") (eq .Values.managementService.type "ClusterIP") }} | ||
|
|
||
| kubectl port-forward -n {{ .Release.Namespace }} svc/{{ include "polaris.fullnameWithSuffix" (list . "mgmt") }} {{ (first .Values.managementService.ports).port }}:{{ (first .Values.managementService.ports).port }} | ||
| {{- else if and (eq .Values.service.type "ClusterIP") (eq .Values.managementService.type "ClusterIP") }} | ||
|
|
||
| kubectl port-forward -n {{ .Release.Namespace }} svc/{{ include "polaris.fullnameWithSuffix" (list . "mgmt") }} {{ (first .Values.managementService.ports).port }}:{{ (first .Values.managementService.ports).port }} | ||
| {{- end }} | ||
| {{ include "polaris.accessInstructions" (dict "serviceType" .Values.managementService.type "serviceName" (include "polaris.fullnameWithSuffix" (list . "mgmt")) "port" (first .Values.managementService.ports).port "namespace" .Release.Namespace "label" "Health" "path" "/q/health" "isFirstNodePort" (ne .Values.service.type "NodePort")) }} | ||
|
|
||
| View logs: | ||
|
|
||
| kubectl logs -l app.kubernetes.io/name={{ include "polaris.name" . }} -n {{ .Release.Namespace }} --tail=50 -f | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if we should customize the instructions if
.Values.service.typeis notClusterIP? E.g. if the service is aNodePortorLoadBalancer, there are other ways to connect to the service than port-forwarding.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point, I wasn’t sure how detailed the output should be and I’m still a bit unsure.
I’ve rewritten
NOTES.txtwith all the combinations and updated the description to reflect that.