Skip to content

feat(chart): show real endpoints in Helm post-install notes #2801

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.

Sign up for GitHub

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
ghophp wants to merge 1 commit into
base: main
Choose a base branch
from
+140 −4
Open

feat(chart): show real endpoints in Helm post-install notes #2801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 108 additions & 4 deletions deployment/chainloop/templates/NOTES.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,115 @@ APP VERSION: {{ .Chart.AppVersion }}
CONFIGURE CLI
###########################################################################

Configure the CLI to point to this instance, for example
{{- $cpGrpcURL := include "chainloop.controlplane.external_grpc_url" . }}
{{- $casGrpcURL := include "chainloop.cas.external_grpc_url" . }}

chainloop --insecure config save \
--control-plane my-controlplane.acme.com:80 \
--artifact-cas cas.acme.com:80
{{- $cpSvcType := .Values.controlplane.serviceAPI.type }}
{{- $cpSvcPort := coalesce .Values.controlplane.serviceAPI.port .Values.controlplane.serviceAPI.ports.http }}
Copy link
Contributor

@Filip7656 Filip7656 Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.Values.controlplane.serviceAPI.port this key does not exist, it should be .ports

{{- $cpSvcName := printf "%s-api" (include "chainloop.controlplane.fullname" .) }}

{{- $casSvcType := .Values.cas.serviceAPI.type }}
{{- $casSvcPort := coalesce .Values.cas.serviceAPI.port .Values.cas.serviceAPI.ports.http }}
Copy link
Contributor

@Filip7656 Filip7656 Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.Values.cas.serviceAPI.port same here

{{- $casSvcName := printf "%s-api" (include "chainloop.cas.fullname" .) }}

{{- $namespace := include "common.names.namespace" . }}

{{- $cpHasTLS := or (and .Values.controlplane.ingressAPI.enabled .Values.controlplane.ingressAPI.tls) (ne (.Values.controlplane.tls.existingSecret | default "") "") }}
{{- $casHasTLS := or (and .Values.cas.ingressAPI.enabled .Values.cas.ingressAPI.tls) (ne (.Values.cas.tls.existingSecret | default "") "") }}
{{- $insecure := not (and $cpHasTLS $casHasTLS) }}

{{- if and (ne $cpGrpcURL "") (ne $casGrpcURL "") }}
{{- /* Both endpoints can be resolved - show a single ready-to-use command */ -}}

Configure the CLI to point to this instance:

chainloop {{ if $insecure }}--insecure {{ end }}config save \
--control-plane {{ $cpGrpcURL }} \
--artifact-cas {{ $casGrpcURL }}

{{- else }}

To configure the CLI, you need the Control Plane and Artifact CAS gRPC endpoints.
{{- /* --- CONTROL PLANE ENDPOINT --- */ -}}
{{- if ne $cpGrpcURL "" }}

1. The Control Plane gRPC API is available at:

{{ $cpGrpcURL }}
{{- else if eq $cpSvcType "LoadBalancer" }}

1. Get the Control Plane gRPC endpoint:

NOTE: It may take a few minutes for the LoadBalancer IP to be available.
Watch the status with: kubectl get --namespace {{ $namespace }} svc {{ $cpSvcName }} -w

export CP_HOST=$(kubectl get svc --namespace {{ $namespace }} {{ $cpSvcName }} --template "{{ "{{" }} range (index .status.loadBalancer.ingress 0) {{ "}}" }}{{ "{{" }} . {{ "}}" }}{{ "{{" }} end {{ "}}" }}")
export CP_PORT={{ $cpSvcPort }}
{{- else if eq $cpSvcType "NodePort" }}

1. Get the Control Plane gRPC endpoint:

export CP_HOST=$(kubectl get nodes --namespace {{ $namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
export CP_PORT=$(kubectl get --namespace {{ $namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ $cpSvcName }})
{{- else }}

1. The Control Plane gRPC API is not externally accessible (ClusterIP). Use port-forwarding:

kubectl port-forward --namespace {{ $namespace }} svc/{{ $cpSvcName }} 9000:{{ $cpSvcPort }} &
{{- end }}
{{- /* --- CAS ENDPOINT --- */ -}}
{{- if ne $casGrpcURL "" }}

2. The Artifact CAS gRPC API is available at:

{{ $casGrpcURL }}
{{- else if eq $casSvcType "LoadBalancer" }}

2. Get the Artifact CAS gRPC endpoint:

NOTE: It may take a few minutes for the LoadBalancer IP to be available.
Watch the status with: kubectl get --namespace {{ $namespace }} svc {{ $casSvcName }} -w

export CAS_HOST=$(kubectl get svc --namespace {{ $namespace }} {{ $casSvcName }} --template "{{ "{{" }} range (index .status.loadBalancer.ingress 0) {{ "}}" }}{{ "{{" }} . {{ "}}" }}{{ "{{" }} end {{ "}}" }}")
export CAS_PORT={{ $casSvcPort }}
{{- else if eq $casSvcType "NodePort" }}

2. Get the Artifact CAS gRPC endpoint:

export CAS_HOST=$(kubectl get nodes --namespace {{ $namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
export CAS_PORT=$(kubectl get --namespace {{ $namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ $casSvcName }})
{{- else }}

2. The Artifact CAS gRPC API is not externally accessible (ClusterIP). Use port-forwarding:

kubectl port-forward --namespace {{ $namespace }} svc/{{ $casSvcName }} 9001:{{ $casSvcPort }} &
{{- end }}

3. Configure the CLI:

{{- $cpRef := $cpGrpcURL -}}
{{- if eq $cpRef "" -}}
{{- if or (eq $cpSvcType "LoadBalancer") (eq $cpSvcType "NodePort") -}}
{{- $cpRef = "$CP_HOST:$CP_PORT" -}}
{{- else -}}
{{- $cpRef = "localhost:9000" -}}
{{- end -}}
{{- end -}}

{{- $casRef := $casGrpcURL -}}
{{- if eq $casRef "" -}}
{{- if or (eq $casSvcType "LoadBalancer") (eq $casSvcType "NodePort") -}}
{{- $casRef = "$CAS_HOST:$CAS_PORT" -}}
{{- else -}}
{{- $casRef = "localhost:9001" -}}
{{- end -}}
{{- end }}

chainloop {{ if $insecure }}--insecure {{ end }}config save \
--control-plane {{ $cpRef }} \
--artifact-cas {{ $casRef }}

{{- end }}

Refer to this link for more information
https://docs.chainloop.dev/get-started/setup
Expand Down
32 changes: 32 additions & 0 deletions deployment/chainloop/templates/_helpers.tpl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -328,6 +328,22 @@ null
{{- end -}}
{{- end -}}

{{/*
External gRPC URL the controlplane API can be reached at
This endpoint is used by the CLI to connect via gRPC
NOTE: Load balancer service type is not supported
*/}}
{{- define "chainloop.controlplane.external_grpc_url" -}}
{{- $service := .Values.controlplane.serviceAPI }}
{{- $ingress := .Values.controlplane.ingressAPI }}

{{- if (and $ingress $ingress.enabled $ingress.hostname) }}
{{- printf "%s:%s" $ingress.hostname (ternary "443" "80" $ingress.tls) }}
{{- else if (and (eq $service.type "NodePort") $service.nodePorts (not (empty $service.nodePorts.http))) }}
{{- printf "localhost:%s" $service.nodePorts.http }}
{{- end -}}
{{- end -}}

{{- define "chainloop.sentry" -}}
observability:
sentry:
Expand Down Expand Up @@ -417,6 +433,22 @@ NOTE: Load balancer service type is not supported
{{- end -}}
{{- end -}}

{{/*
External gRPC URL the CAS API can be reached at
This endpoint is used by the CLI to connect via gRPC
NOTE: Load balancer service type is not supported
*/}}
{{- define "chainloop.cas.external_grpc_url" -}}
{{- $service := .Values.cas.serviceAPI }}
{{- $ingress := .Values.cas.ingressAPI }}

{{- if (and $ingress $ingress.enabled $ingress.hostname) }}
{{- printf "%s:%s" $ingress.hostname (ternary "443" "80" $ingress.tls) }}
{{- else if (and (eq $service.type "NodePort") $service.nodePorts (not (empty $service.nodePorts.http))) }}
{{- printf "localhost:%s" $service.nodePorts.http }}
{{- end -}}
{{- end -}}

{{/*
Check for Development mode
*/}}
Expand Down
Loading