docs: Define name convention for ingress objects (#122)

Change-Id: Iaec559b47df6e9911f1bf8fad4f7ec710b21a9b5
epam · Feb 18, 2024 · 977b8c1 · 977b8c1
1 parent 66989f0
commit 977b8c1
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 11 deletions.
diff --git a/charts/pipelines-library/README.md b/charts/pipelines-library/README.md
@@ -78,7 +78,7 @@ Follows [Tekton Interceptor](https://tekton.dev/vault/triggers-main/clusterinter
 | dashboard.image.repository | string | `"gcr.io/tekton-releases/github.com/tektoncd/dashboard/cmd/dashboard"` | Define tekton dashboard docker image name |
 | dashboard.image.tag | string | `"v0.43.1"` | Define tekton dashboard docker image tag |
 | dashboard.ingress.annotations | object | `{}` | Annotations for Ingress resource |
-| dashboard.ingress.enabled | bool | `true` | Deploy EDP Dashboard ingress as a part of pipeline library when true. Default: true |
+| dashboard.ingress.enabled | bool | `true` | Enable external endpoint access. Default Ingress/Route host pattern: tekton-{{ .Release.Namespace }}.{{ .Values.global.dnsWildCard }} |
 | dashboard.ingress.tls | list | `[]` | Uncomment it to enable tekton-dashboard OIDC on EKS cluster nginx.ingress.kubernetes.io/auth-signin: 'https://<oauth-ingress-host>/oauth2/start?rd=https://$host$request_uri' nginx.ingress.kubernetes.io/auth-url: 'http://oauth2-proxy.<edp-project>.svc.cluster.local:8080/oauth2/auth' |
 | dashboard.nameOverride | string | `"edp-tekton-dashboard"` |  |
 | dashboard.openshift_proxy | object | `{"enabled":false,"image":{"repository":"quay.io/openshift/origin-oauth-proxy","tag":"4.9.0"},"resources":{"limits":{"cpu":"60m","memory":"70Mi"},"requests":{"cpu":"50m","memory":"40Mi"}}}` | For EKS scenario - uncomment dashboard.ingress.annotations block |

diff --git a/charts/pipelines-library/templates/dashboard/_helpers.tpl b/charts/pipelines-library/templates/dashboard/_helpers.tpl
@@ -32,10 +32,3 @@ Selector labels
 app.kubernetes.io/name: {{ include "tekton-dashboard.name" . }}
 app.kubernetes.io/instance: {{ .Release.Name }}
 {{- end }}
-
-{{/*
-Define Tekton Dashboard URL
-*/}}
-{{- define "tekton.tektonBaseUrl" -}}
-{{- printf "tekton-%s.%s" .Release.Namespace .Values.global.dnsWildCard  }}
-{{- end }}
diff --git a/charts/pipelines-library/templates/dashboard/route.yaml b/charts/pipelines-library/templates/dashboard/route.yaml
@@ -7,7 +7,7 @@ metadata:
     {{- include "tekton-dashboard.labels" . | nindent 4 }}
   name: {{ include "tekton-dashboard.name" . }}
 spec:
-  host: {{ include "tekton.tektonBaseUrl" . }}
+  host: tekton-{{ .Release.Namespace }}.{{ .Values.global.dnsWildCard }}
   path: /
   port:
     targetPort: http

diff --git a/charts/pipelines-library/values.yaml b/charts/pipelines-library/values.yaml
@@ -307,7 +307,7 @@ dashboard:
     tag: v0.43.1
 
   ingress:
-    # -- Deploy EDP Dashboard ingress as a part of pipeline library when true. Default: true
+    # -- Enable external endpoint access. Default Ingress/Route host pattern: tekton-{{ .Release.Namespace }}.{{ .Values.global.dnsWildCard }}
     enabled: true
     # -- Annotations for Ingress resource
     annotations: {}
@@ -317,7 +317,7 @@ dashboard:
     tls: []
     #  - secretName: chart-example-tls
     #    hosts:
-    #      - chart-example.local
+    #      - tekton-edp.example.com
 
 # Event listener to listen git webhooks
 eventListener: