Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ commercial_package
.vale/styles/AsciiDocDITA
.vale/styles/OpenShiftAsciiDoc
.vale/styles/RedHat
.vale-cqa.ini
1 change: 1 addition & 0 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ StylesPath = .vale/styles
MinAlertLevel = suggestion

Packages = RedHat, AsciiDoc, OpenShiftAsciiDoc, https://github.com/jhradilek/asciidoctor-dita-vale/releases/latest/download/AsciiDocDITA.zip
Vocab = OpenShiftDocs

# Ignore files in dirs starting with `.` to avoid raising errors for `.vale/fixtures/*/testinvalid.adoc` files
[[!.]*.adoc]
Expand Down
33 changes: 20 additions & 13 deletions .vale/styles/Vocab/OpenShiftDocs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,57 +8,64 @@ args
Assisted Installer
Atlassian
backoff
buildah
[Bb]uildah
Buildpacks
Control Plane Machine Set Operator
Cron
cron
[Cc]ron
custom resource
custom resources
defaultRetention
destinationCACertificate
docstore
Docdb
[Dd]ocstore
dotnet
enablement
finalizer
finalizers
Forgejo
Fulcio
Git's
Gitea
gosmee
[Gg]osmee
Grafeas
jq
Kaniko
[Kk]aniko
keyless
kubeconfig
maxRetention
MetalLB
multiline
nonproduction
opc
[Oo][Pp][Cc]
[Pp][Aa][Cc]
Operator
Operators
param
pipelinerun
[Pp]ipeline[Rr]un
pipelinerun_status
Postgres
prepopulated
prepopulates
pull_request_number
proxying
pylint
refetching
Rekor
repo
Repo
[Rr]epo
resource_type
resync
retryable
reusability
Roxctl
sbom
[Ss][Bb][Oo][Mm]
SCCs
semver
Sigstore
skopeo
[Ss]kopeo
subprocesses
substring
sudo
taskrun
[Tt]ask[Rr]un
tkn
unencrypted
unschedulable
Expand Down
18 changes: 11 additions & 7 deletions .vale/styles/Vocab/RedHat/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,33 @@ backoff
Buildpacks
[Cc]ron
defaultRetention
docstore
Docdb
[Dd]ocstore
dotnet
enablement
finalizer
finalizers
Forgejo
Fulcio
Git's
Gitea
[Gg]itlab
gosmee
Grafeas
jq
Kaniko
[Kk]aniko
keyless
maxRetention
nonproduction
opc
[Oo][Pp][Cc]
[Pp][Aa][Cc]
param
pipelinerun
[Pp]ipeline[Rr]un
pipelinerun_status
prepopulated
prepopulates
proxying
pull_request_number
proxying
pylint
refetching
Rekor
Expand All @@ -40,14 +44,14 @@ resync
retryable
reusability
Roxctl
sbom
[Ss][Bb][Oo][Mm]
SCCs
semver
Sigstore
skopeo
subprocesses
sudo
taskrun
[Tt]ask[Rr]un
tkn
unencrypted
unschedulable
Expand Down
33 changes: 20 additions & 13 deletions .vale/styles/config/vocabularies/OpenShiftDocs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,57 +8,64 @@ args
Assisted Installer
Atlassian
backoff
buildah
[Bb]uildah
Buildpacks
Control Plane Machine Set Operator
Cron
cron
[Cc]ron
custom resource
custom resources
defaultRetention
destinationCACertificate
docstore
Docdb
[Dd]ocstore
dotnet
enablement
finalizer
finalizers
Forgejo
Fulcio
Git's
Gitea
gosmee
[Gg]osmee
Grafeas
jq
Kaniko
[Kk]aniko
keyless
kubeconfig
maxRetention
MetalLB
multiline
nonproduction
opc
[Oo][Pp][Cc]
[Pp][Aa][Cc]
Operator
Operators
param
pipelinerun
[Pp]ipeline[Rr]un
pipelinerun_status
Postgres
prepopulated
prepopulates
pull_request_number
proxying
pylint
refetching
Rekor
repo
Repo
[Rr]epo
resource_type
resync
retryable
reusability
Roxctl
sbom
[Ss][Bb][Oo][Mm]
SCCs
semver
Sigstore
skopeo
[Ss]kopeo
subprocesses
substring
sudo
taskrun
[Tt]ask[Rr]un
tkn
unencrypted
unschedulable
Expand Down
21 changes: 3 additions & 18 deletions about/understanding-openshift-pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,35 +30,20 @@ include::modules/op-about-pipelines.adoc[leveloffset=+2]
//About pipeline run
include::modules/op-about-pipelinerun.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../secure/authenticating-pipelines-repos-using-secrets.adoc#authenticating-pipelines-repos-using-secrets[Authenticating pipelines with repositories using secrets]

//Pod templates
include::modules/op-about-podtemplate.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* link:https://docs.openshift.com/container-platform/4.17/nodes/pods/nodes-pods-using.html[Using pods]

//About workspace
include::modules/op-about-workspace.adoc[leveloffset=+2]

//About stepactions
include::modules/op-about-stepactions.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources

* xref:../create/remote-pipelines-tasks-resolvers.adoc#remote-pipelines-tasks-resolvers[Specifying remote pipelines, tasks, and step actions using resolvers]

//About triggers
include::modules/op-about-triggers.adoc[leveloffset=+2]

[role="_additional-resources"]
== Additional resources

* xref:../install_config/installing-pipelines.adoc#installing-pipelines[Installing {pipelines-shortname}]
* xref:../create/creating-applications-with-cicd-pipelines.adoc#creating-applications-with-cicd-pipelines[Creating CI/CD solutions for applications using {pipelines-shortname}]
* xref:../create/creating-applications-with-cicd-pipelines.adoc#creating-applications-with-cicd-pipelines[Creating CI/CD solutions for applications by using {pipelines-shortname}]
* xref:../secure/authenticating-pipelines-repos-using-secrets.adoc#authenticating-pipelines-repos-using-secrets[Authenticating pipelines with repositories by using secrets]
* xref:../create/remote-pipelines-tasks-resolvers.adoc#remote-pipelines-tasks-resolvers[Specifying remote pipelines, tasks, and step actions by using resolvers]
* link:https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#re-encryption-termination[Re-encryption Termination]
* link:https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html[Secured routes]
35 changes: 9 additions & 26 deletions create/creating-applications-with-cicd-pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The following `pipelines-tutorial` example demonstrates the preceding tasks. The
* You have access to an {OCP} cluster.
* You have installed xref:../install_config/installing-pipelines.adoc#installing-pipelines[{pipelines-shortname}] using the {pipelines-title} Operator listed in the OpenShift OperatorHub. After you install it, it is applicable to the entire cluster.
* You have installed xref:../tkn_cli/installing-tkn.adoc#installing-tkn[{pipelines-shortname} CLI].
* You have forked the front-end link:https://github.com/openshift/pipelines-vote-ui/tree/{pipelines-ver}[`pipelines-vote-ui`] and back-end link:https://github.com/openshift/pipelines-vote-api/tree/{pipelines-ver}[`pipelines-vote-api`] Git repositories using your GitHub ID, and have administrator access to these repositories.
* You have forked the front-end link:https://github.com/openshift/pipelines-vote-ui/tree/{pipelines-ver}[`pipelines-vote-ui`] and back-end link:https://github.com/openshift/pipelines-vote-api/tree/{pipelines-ver}[`pipelines-vote-api`] Git repositories by using your GitHub ID, and have administrator access to these repositories.
* Optional: You have cloned the link:https://github.com/openshift/pipelines-tutorial/tree/{pipelines-ver}[`pipelines-tutorial`] Git repository.


Expand All @@ -42,21 +42,8 @@ include::modules/op-assembling-a-pipeline.adoc[leveloffset=+1]

include::modules/op-mirroring-images-to-run-pipelines-in-restricted-environment.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* link:https://docs.openshift.com/container-platform/latest/openshift_images/configuring-samples-operator.html#samples-operator-restricted-network-install[Configuring Samples Operator for a restricted cluster]

* link:https://docs.openshift.com/container-platform/4.17/disconnected/mirroring/index.html[About disconnected installation mirroring]

include::modules/op-running-a-pipeline.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../secure/authenticating-pipelines-repos-using-secrets.adoc#authenticating-pipelines-repos-using-secrets[Authenticating pipelines with repositories using secrets]


include::modules/op-adding-triggers.adoc[leveloffset=+1]

include::modules/op-configuring-eventlisteners-to-serve-multiple-namespaces.adoc[leveloffset=+1]
Expand All @@ -67,11 +54,6 @@ include::modules/op-triggering-a-pipelinerun.adoc[leveloffset=+1]

include::modules/op-enabling-monitoring-of-event-listeners-for-triggers-for-user-defined-projects.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* link:https://docs.openshift.com/container-platform/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html[Enabling monitoring for user-defined projects]

include::modules/op-configuring-pull-request-capabilities-in-GitHub-interceptor.adoc[leveloffset=+1]

include::modules/op-filtering-pull-requests-using-GitHub-interceptor.adoc[leveloffset=+2]
Expand All @@ -81,10 +63,11 @@ include::modules/op-validating-pull-requests-using-GitHub-interceptors.adoc[leve
[role="_additional-resources"]
== Additional resources

* To include {pac} along with the application source code in the same repository, see xref:../pac/about-pipelines-as-code.adoc#about-pipelines-as-code[About {pac}].
* For more details on pipelines in the *Developer* perspective, see the xref:../create/working-with-pipelines-web-console.adoc#working-with-pipelines-web-console[Working with {pipelines-shortname} in the web console] section.
* To learn more about Security Context Constraints (SCCs), see the link:https://docs.openshift.com/container-platform/latest/authentication/managing-security-context-constraints.html[Managing Security Context Constraints] section.
* For more examples of reusable tasks, see the link:https://github.com/openshift/pipelines-catalog[OpenShift Catalog] repository. Additionally, you can also see the Tekton Catalog in the Tekton project.
* To install and deploy a custom instance of {tekton-hub} for reusable tasks and pipelines, see xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-title}].
* For more details on re-encrypt TLS termination, see link:https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#re-encryption-termination[Re-encryption Termination].
* For more details on secured routes, see the link:https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html[Secured routes] section.
* xref:../pac/about-pipelines-as-code.adoc#about-pipelines-as-code[About {pac}]
* xref:../create/working-with-pipelines-web-console.adoc#working-with-pipelines-web-console[Working with {pipelines-shortname} in the web console]
* xref:../secure/authenticating-pipelines-repos-using-secrets.adoc#authenticating-pipelines-repos-using-secrets[Authenticating pipelines with repositories by using secrets]
* link:https://docs.openshift.com/container-platform/latest/authentication/managing-security-context-constraints.html[Managing Security Context Constraints]
* link:https://github.com/openshift/pipelines-catalog[OpenShift Catalog]
* xref:../hub/using-tekton-hub-with-openshift-pipelines.adoc#using-tekton-hub-with-openshift-pipelines[Using {tekton-hub} with {pipelines-title}]
* link:https://docs.openshift.com/container-platform/3.11/architecture/networking/routes.html#re-encryption-termination[Re-encryption Termination]
* link:https://docs.openshift.com/container-platform/latest/networking/routes/secured-routes.html[Secured routes]
2 changes: 1 addition & 1 deletion create/migrate-from-clustertask-to-cluster-resolver.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ include::modules/op-troubleshooting-general-debugging.adoc[leveloffset=+1]
[role="_additional-resources"]
== Additional resources

* xref:../create/remote-pipelines-tasks-resolvers.adoc#remote-pipelines-tasks-resolvers[Specifying remote pipelines, tasks, and step actions using resolvers]
* xref:../create/remote-pipelines-tasks-resolvers.adoc#remote-pipelines-tasks-resolvers[Specifying remote pipelines, tasks, and step actions by using resolvers]
* xref:../create/remote-pipelines-tasks-resolvers.adoc#resolver-cluster_remote-pipelines-tasks-resolvers[Specifying a pipeline, task, or step action from the same cluster]
* xref:../create/remote-pipelines-tasks-resolvers.adoc#resolver-cluster-tasks-ref_remote-pipelines-tasks-resolvers[Tasks provided in the {pipelines-shortname} namespace]
* link:https://tekton.dev/docs/pipelines/cluster-resolver/[Tekton Cluster Resolver documentation]
5 changes: 0 additions & 5 deletions create/using-manual-approval.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@ include::modules/op-approving-manual-approval-task-about.adoc[leveloffset=+1]

include::modules/op-approving-task-web-console.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources

* xref:../create/working-with-pipelines-web-console.adoc#op-enabling-plugin_working-with-pipelines-web-console[Enabling the {pipelines-shortname} console plugin]

include::modules/op-approving-task-command-line.adoc[leveloffset=+2]

include::modules/op-behavior-of-approvaltask-with-groups-and-users.adoc[leveloffset=+1]
Expand Down
10 changes: 5 additions & 5 deletions create/using-rh-entitlements-pipelines.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ toc::[]
[role="_abstract"]
If you have {op-system-base-full} entitlements, you can use these entitlements to build container images in your pipelines.

The Insight Operator automatically manages your entitlements after you import them into this Operator from Simple Common Access (SCA). This operator provides a secret named `etc-pki-entitlement` in the `openshift-config-managed` namespace.
The Insight Operator automatically manages your entitlements after you import them into this Operator from Simple Common Access (SCA). This Operator provides a secret named `etc-pki-entitlement` in the `openshift-config-managed` namespace.

You can use Red Hat entitlements in your pipelines in one of the following two ways:

Expand All @@ -19,15 +19,15 @@ You can use Red Hat entitlements in your pipelines in one of the following two w

== Prerequisites

* You logged on to your {OCP} cluster using the `oc` command line tool.
* You logged on to your {OCP} cluster by using the `oc` command line tool.

* You enabled the Insights Operator feature on your {OCP} cluster. If you want to use the Shared Resources CSI Driver operator to share the secret between namespaces, you must also enable the Shared Resources CSI driver. For information about enabling features, including the Insights Operator and Shared Resources CSI Driver, see link:https://docs.openshift.com/container-platform/latest/nodes/clusters/nodes-cluster-enabling-features.html[Enabling features using feature gates].
* You enabled the Insights Operator feature on your {OCP} cluster. If you want to use the Shared Resources CSI Driver Operator to share the secret between namespaces, you must also enable the Shared Resources CSI Driver. For information about enabling features, including the Insights Operator and Shared Resources CSI Driver, see link:https://docs.openshift.com/container-platform/latest/nodes/clusters/nodes-cluster-enabling-features.html[Enabling features by using feature gates].
+

+
[NOTE]
====
After you enable the Insights Operator, you must wait for some time to ensure that the cluster updates all the nodes with this operator. You can monitor the status of all nodes by entering the following command:
After you enable the Insights Operator, you must wait for some time to ensure that the cluster updates all the nodes with this Operator. You can monitor the status of all nodes by entering the following command:

[source,terminal]
----
Expand Down Expand Up @@ -64,5 +64,5 @@ include::modules/op-entitlements-shared-csi-driver.adoc[leveloffset=+1]
* link:https://access.redhat.com/articles/simple-content-access[Simple content access]
* link:https://docs.openshift.com/container-platform/4.14/support/remote_health_monitoring/using-insights-operator.html[Using Insights Operator]
* link:https://docs.openshift.com/container-platform/latest/support/remote_health_monitoring/insights-operator-simple-access.html[Importing simple content access entitlements with Insights Operator]
* https://docs.openshift.com/container-platform/4.14/storage/container_storage_interface/ephemeral-storage-shared-resource-csi-driver-operator.html[Shared Resource CSI Driver Operator]
* link:https://docs.openshift.com/container-platform/4.14/storage/container_storage_interface/ephemeral-storage-shared-resource-csi-driver-operator.html[Shared Resource CSI Driver Operator]
* xref:../install_config/customizing-configurations-in-the-tektonconfig-cr.adoc#op-changing-default-service-account_customizing-configurations-in-the-tektonconfig-cr[Changing the default service account for {pipelines-shortname}]
Loading