Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
a280100
Auto-generated doc updates from code PR
Jul 10, 2025
7408012
Auto-generated doc updates from code PR
Jul 10, 2025
c4c07e8
Auto-generated doc updates from code PR
Jul 17, 2025
811059a
Auto-generated doc updates from code PR
Jul 17, 2025
1b42b29
Auto-generated doc updates from code PR
Jul 17, 2025
3951b56
Auto-generated doc updates from code PR
Jul 17, 2025
427a0e0
Auto-generated doc updates from code PR
Jul 17, 2025
ee7154b
Auto-generated doc updates from code PR
Jul 17, 2025
983b08b
Auto-generated doc updates from code PR
Jul 21, 2025
240f1a2
Auto-generated doc updates from code PR
Jul 21, 2025
985c2f5
Auto-generated doc updates from code PR
Jul 21, 2025
ed58ae7
Auto-generated doc updates from code PR
Jul 23, 2025
1439498
Auto-generated doc updates from code PR
Jul 29, 2025
accfedd
Auto-generated doc updates from code PR
Jul 29, 2025
88a3ecb
Auto-generated doc updates from code PR
Aug 5, 2025
cb66c33
Auto-generated doc updates from code PR
Aug 5, 2025
356bab0
Auto-generated doc updates from code PR
Aug 7, 2025
7660c8e
Auto-generated doc updates from code PR
Aug 11, 2025
f04b789
Auto-generated doc updates from code PR
Aug 18, 2025
672a90b
Auto-generated doc updates from code PR
Aug 18, 2025
d410f8c
Auto-generated doc updates from code PR
Aug 18, 2025
39a2f7c
Auto-generated doc updates from code PR
Aug 18, 2025
e3b6d3d
Auto-generated doc updates from code PR
Aug 18, 2025
d1700d9
Auto-generated doc updates from code PR
Aug 18, 2025
ab3dffa
Auto-generated doc updates from code PR
Aug 18, 2025
80d273a
Auto-generated doc updates from code PR
Aug 18, 2025
ed5b7c3
Auto-generated doc updates from code PR
Aug 18, 2025
f3e7d11
Auto-generated doc updates from code PR
Aug 18, 2025
0bf907b
Auto-generated doc updates from code PR
Aug 19, 2025
2164465
Auto-generated doc updates from code PR
Aug 19, 2025
964345f
Auto-generated doc updates from code PR
Aug 19, 2025
7ee4fbf
Auto-generated doc updates from code PR
Aug 19, 2025
8d75b6a
Auto-generated doc updates from code PR
Aug 19, 2025
51d45a4
Auto-generated doc updates from code changes
Aug 19, 2025
08fecbb
Auto-generated doc updates from code changes
Aug 19, 2025
4f58d5b
Auto-generated doc updates from code changes
Aug 26, 2025
0aa2aec
Auto-generated doc updates from code changes
Aug 26, 2025
2c6b45a
Merge branch 'main' into doc-update-from-pr
csoceanu Aug 26, 2025
c02809d
Auto-generated doc updates from code changes
Aug 26, 2025
d49ee38
Auto-generated doc updates from code changes
Aug 26, 2025
0cf58ab
Auto-generated doc updates from code changes
Aug 26, 2025
31856e4
Auto-generated doc updates from code changes
Sep 8, 2025
061781e
Auto-generated doc updates from code changes
Sep 8, 2025
c213cb2
Auto-generated doc updates from code changes
Sep 8, 2025
a4ad2fa
Auto-generated doc updates from code changes
Sep 16, 2025
d2d64ad
Auto-generated doc updates from code changes
Sep 16, 2025
d5d1f67
Auto-generated doc updates from code changes
Sep 16, 2025
1968b9c
Auto-generated doc updates from code changes
Oct 20, 2025
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
2 changes: 1 addition & 1 deletion modules/ROOT/pages/getting-started.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -156,4 +156,4 @@ include::partial${context}-additional-getting-started.adoc[]

== Getting started with the CLI

include::partial${context}-getting-started-with-the-cli.adoc[]
include::partial${context}-getting-started-with-the-cli.adoc[]
2 changes: 1 addition & 1 deletion modules/building/pages/configuration-as-code.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -319,4 +319,4 @@ If you follow this method to create an `application-b` composed of `component-c`

NOTE: You can also modify the project structure to fit your own needs by moving application bases and component definitions to different levels, but this configuration offers the most layered encapsulation across applications and application versions.

IMPORTANT: Managing multiple related components and applications can be challenging. Refer https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/proc_multiversion/ [Managing multiple software versions] to manage multiple related components and applications.
IMPORTANT: Managing multiple related components and applications can be challenging. Refer https://redhat-appstudio.github.io/docs.appstudio.io/Documentation/main/how-to-guides/proc_multiversion/ [Managing multiple software versions] to manage multiple related components and applications.
12 changes: 6 additions & 6 deletions modules/building/pages/creating-secrets.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ Some container builds may use parent images from registries that require authent

. Obtain the username and password login credentials for the container registry.
* For access to `registry.redhat.io`, you can create a registry service account at https://access.redhat.com/terms-based-registry/accounts.
. In the correct {ProductName} tenant namespace, go to **Secrets**.
. Click **Add secret**.
. In the correct {ProductName} tenant namespace, go to **Secrets**.
. Click **Add secret**.
. For **Secret type**, select **Image pull secret**.
. For **Authentication type**, select **Image registry credentials**.
. For **Registry server address** enter the image registry (for example `registry.redhat.io`).
Expand Down Expand Up @@ -77,11 +77,11 @@ Here is the YAML representation of the secret (for reference):
----
apiVersion: v1
data:
.dockerconfigjson: <base64-encoded-credentials>
.dockerconfigjson: <base64-encoded-credentials>
kind: Secret
metadata:
name: my-quay-secret
namespace: <your-tenant>
name: my-quay-secret
namespace: <your-tenant>
type: kubernetes.io/dockerconfigjson
----

Expand Down Expand Up @@ -277,4 +277,4 @@ include::partial${context}-secrets-external-vault.adoc[]

* For more information about GitLab access tokens, see link:https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html[Project access tokens].

* To configure push secrets for your Build and Release pipelines, see link:https://github.com/konflux-ci/konflux-ci?tab=readme-ov-file#configuring-a-push-secret-for-the-build-pipeline[Configuring push secrets] in the Konflux GitHub repository.
* To configure push secrets for your Build and Release pipelines, see link:https://github.com/konflux-ci/konflux-ci?tab=readme-ov-file#configuring-a-push-secret-for-the-build-pipeline[Configuring push secrets] in the Konflux GitHub repository.
8 changes: 8 additions & 0 deletions modules/building/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@

When creating a component, {ProductName} will push a Tekton PipelineRun to your component's source repository. This pipeline is yours to customize as needed for building your component and Tekton Chains will record the customizations in a detailed signed in-toto provenance attestation. This provenance enables Conforma to xref:compliance:index.adoc[manage compliance] to ensure the artifact's integrity and compliance with specific policies.

== Automated Documentation Updates

{ProductName} leverages an automated documentation update mechanism that responds to specific comments on Pull Requests. This system uses the `docs-enhancer.yml` workflow to automatically update documentation whenever a pull request comment contains `[update-docs]`.

This automation ensures that documentation remains current with code changes, streamlining the process of maintaining accurate and comprehensive project information.

== Additional resources [[additional-resources]]

* The sample pipelines that you can initially configure your components with depend on the {ProductName} deployment. This might include the pipelines provided by xref:installing:enabling-builds.adoc#available-pipelines[{ProductName}] or other additional pipelines.
* If you want to change the configured pipeline for your component after it is onboarded, see xref:building:reconfiguring-build-pipeline.adoc#changing-pipelines[reconfiguring the build pipeline].
* Since the Tekton PipelineRuns use link:https://pipelinesascode.com[Pipelines as Code] to trigger the jobs on the cluster, you can also use any of the link:https://pipelinesascode.com/docs/guide/authoringprs/#default-parameters[default parameters] in the PipelineRuns in your git repositories.
* The `kube-linter.yaml`, `pr.yaml`, and `codecov-main.yaml` GitHub workflows have been removed. This means the project no longer automatically checks Kubernetes YAMLs with `kube-linter` on pull requests, performs `golangci-lint`, `gosec` security scans, or `envtest` runs on pull requests, and no longer generates `codecov` reports on pushes to the `main` branch.
* The `config/default/kustomization.yaml` has been updated to include enhanced monitoring and webhook support, with standardized labeling (`app.kubernetes.io/name`, `app.kubernetes.io/component`, `monitoring`) and enabled network policies.
2 changes: 1 addition & 1 deletion modules/end-to-end/pages/building-tekton-tasks.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -260,4 +260,4 @@ spec:
After completing all the steps above we should now have:

* A task release as a bundle in our release repository
* An OCI artifact named *data-acceptable-bundles* in our release repository, containing a SHA reference of the latest task release as a trusted task (all the previous versions of the task will appear with the expires_on parameter)
* An OCI artifact named *data-acceptable-bundles* in our release repository, containing a SHA reference of the latest task release as a trusted task (all the previous versions of the task will appear with the expires_on parameter)
4 changes: 3 additions & 1 deletion modules/installing/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
** Installation
*** xref:index.adoc[Installing {ProductName}]
*** xref:enabling-builds.adoc[Enabling build pipelines]
*** xref:github-app.adoc[GitHub App]
*** xref:github-app.adoc[GitHub App]
*** xref:docs-automation.adoc[Documentation Automation]
*** xref:kustomization-config.adoc[Kustomization Configuration]
4 changes: 2 additions & 2 deletions modules/installing/pages/enabling-builds.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ This **ConfigMap** can contain references to any Tekton pipeline bundles. Additi
In order to support different use cases within {ProductName}, multiple Tekton pipeline bundles are available in the `quay.io/konflux-ci` organization.

NOTE: The tasks included in the pipeline definitions can be discovered using `yq` or `jq`. For example,
```bash
----
$ tkn bundle list -o yaml quay.io/konflux-ci/tekton-catalog/pipeline-docker-build:devel pipeline docker-build 2>/dev/null | yq ".spec.tasks.[].name"
init
clone-repository
Expand All @@ -54,7 +54,7 @@ sast-snyk-check
clamav-scan
apply-tags
push-dockerfile
```
----

==== _docker-build_ [[docker-build]]

Expand Down
14 changes: 13 additions & 1 deletion modules/installing/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,16 @@ Before tapping into the vast array of benefits offered by {ProductName}, the ini

. *Using Kubernetes manifests*: This option supports any image registry and involves fewer initial setup steps.

For detailed instructions, refer to the link:https://github.com/konflux-ci/konflux-ci/blob/main/README.md[installation guide].
For detailed instructions, refer to the link:https://github.com/konflux-ci/konflux-ci/blob/main/README.md[installation guide].

Additionally, {ProductName} now includes enhanced documentation automation. This feature automatically updates documentation based on code changes by commenting `[update-docs]` on a Pull Request. This ensures that the documentation always reflects the latest state of the codebase, improving accuracy and reducing manual effort.

[[enhanced-observability]]
==== Enhanced Observability

This update introduces enhanced monitoring, webhook support, and network policies for better observability and security within {ProductName}.

* *Monitoring*: Enabled standardized labeling for resource identification and monitoring, ensuring that pods running in namespaces labeled `metrics: enabled` can gather metrics.
* *Webhook Server*: The webhook server is now enabled for validation and mutation purposes. CRs that require webhooks and are applied on namespaces labeled `webhooks: enabled` can communicate with the webhook server.
* *Certificate Manager*: The certificate manager is enabled for automated TLS certificate management, which is required by webhook components.
* *Network Policies*: Network policies are enabled to enhance the security posture of the deployment.
4 changes: 2 additions & 2 deletions modules/patterns/pages/gitops-for-manual-releases.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Let's say you're preparing for an upcoming 1.3.0 release.
----
❯ yq -i '.metadata.name = "your-project-1-3-0-rc01"' releases/1.3.0/snapshot.yaml
# Confirm the name is as you expect
❯ yq .metadata.name releases/1.3.0/snapshot.yaml
❯ yq .metadata.name releases/1.3.0/snapshot.yaml
your-project-1-3-0-rc01
----

Expand Down Expand Up @@ -122,4 +122,4 @@ NOTE: Discuss this with your team. The decision depends on your process outside
[source]
----
❯ watch 'kubectl get releases your-project-1-3-0 -o yaml | yq .status'`
----
----
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,4 @@ NOTE: Once this change is merged, the nudged component will contain invalid refe
.*Verification*

. Commit a change to a nudging component, triggering a push event.
. After the build is completed, a pull request should be opened against your nudged component's git repository.
. After the build is completed, a pull request should be opened against your nudged component's git repository.
Original file line number Diff line number Diff line change
Expand Up @@ -107,4 +107,4 @@ reduce-snapshot
[reduce] SNAPSHOT_CREATION_COMPONENT: comp2
[reduce] Single Component mode is true and Snapshot type is component
[reduce] COMPONENT_COUNT: 1
--
--
2 changes: 1 addition & 1 deletion modules/reference/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,4 @@
*** xref:kube-apis/mintmaker.adoc#k8s-api-github-com-konflux-ci-release-service-api-v1alpha1-dependencyupdatecheck[DependencyUpdateCheck]
*** xref:kube-apis/project-controller.adoc#k8s-api-github-com-konflux-ci-project-controller-api-v1beta1-project[Project]
*** xref:kube-apis/project-controller.adoc#k8s-api-github-com-konflux-ci-project-controller-api-v1beta1-projectdevelopmentstream[ProjectDevelopmentStream]
*** xref:kube-apis/project-controller.adoc#k8s-api-github-com-konflux-ci-project-controller-api-v1beta1-projectdevelopmentstreamtemplate[ProjectDevelopmentStreamTemplate]
*** xref:kube-apis/project-controller.adoc#k8s-api-github-com-konflux-ci-project-controller-api-v1beta1-projectdevelopmentstreamtemplate[ProjectDevelopmentStreamTemplate]
Loading