Repository navigation
EPMDEDP-17300: docs: Document authentication and TLS for Tekton Results in 3.16.1 - #439
Merged
Merged
Conversation
…ts in 3.16.1 3.16.1 turns on authentication and TLS for the Tekton Results API in edp-cluster-add-ons. Readers over http:// fail, and the portal shows no pipeline history or logs until it is configured for the HTTPS endpoint. - Add a required 3.16.1 upgrade step: copy the public CA to a ConfigMap, point the portal to the HTTPS Service, trust the CA with NODE_EXTRA_CA_CERTS, and enable the portal RoleBinding; renumber the following steps. - Describe what the Results API enforces, the portal configuration, its limits, and certificate renewal. - List authentication and TLS among the Tekton Results install customizations; cert-manager is required. Applied to the current docs and the 3.16 snapshot. Signed-off-by: Sergiy Kulanov <sergiy_kulanov@epam.com>
|
Azure Static Web Apps: Your stage site is ready! Visit it here: https://gentle-pebble-0839af61e-439.westus2.4.azurestaticapps.net |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
3.16.1 turns on authentication and TLS for the Tekton Results API (epam/edp-cluster-add-ons#462). The portal reads it over HTTPS with its ServiceAccount token (KubeRocketCI/krci-portal#442, merged). This PR documents the required setup in
docs/and the3.16snapshot only. 3.14 and 3.15 do not change.sequenceDiagram participant Portal as krci-portal (SA token) participant API as Tekton Results API (TLS) participant K8s as kube-apiserver Portal->>API: HTTPS, trusts ca.crt via NODE_EXTRA_CA_CERTS API->>K8s: TokenReview + SubjectAccessReview (results.tekton.dev, namespace) K8s-->>API: allowed (RoleBinding → tekton-results-readonly) API-->>Portal: results, records, logsEvidence
The documented steps were verified on a kind testbed (Kubernetes v1.36.4) with the add-ons manifest from #462 and the portal from #442:
http://):listResults → 400 Client sent an HTTP request to an HTTPS serverAfter (documented values + CA ConfigMap):
listResults → 200getPipelineRunResults → 200, 1 item,getPipelineRunLogs → 200, contains the step outputtls.crtoftekton-results-tls(TLS_PATH=/etc/tlsmount)cspellon the changed pages: 0 issues. In-page anchors after the renumbering: all resolve.Merge Danger
Door: two-way
Docs only. A revert restores the previous pages.
Blast Radius: 3.16-upgraders
install-tekton.mdappliesresults.yamlfrom add-onsmain, so the docs and the manifest must change at the same time.edp-installversion in the upgrade commands stays3.16.0. Update it when 3.16.1 is released.versioned_docs/version-3.15/operator-guide/install-tekton.mdalso appliesresults.yamlfrom add-onsmain. After #462, 3.15 users following it get the auth-enabled API.