Skip to content

Commit bf4b712

Browse files
authored
Merge pull request #57630 from openshift/revert-53813-pac-for-1-9
Revert "Pipelines as Code documentation for Pipelines 1.9"
2 parents 37f8eb9 + c374883 commit bf4b712

22 files changed

+49
-1533
lines changed

_attributes/common-attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ endif::[]
8888
//pipelines
8989
:pipelines-title: Red Hat OpenShift Pipelines
9090
:pipelines-shortname: Pipelines
91-
:pipelines-ver: pipelines-1.9
91+
:pipelines-ver: pipelines-1.8
9292
:tekton-chains: Tekton Chains
9393
:tekton-hub: Tekton Hub
9494
:pac: Pipelines as Code

cicd/pipelines/using-pipelines-as-code.adoc

Lines changed: 4 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
// :FeatureName: Pipelines as Code
9+
:FeatureName: Pipelines as Code
1010

1111
[role="_abstract"]
1212
With {pac}, cluster administrators and users with the required privileges can define pipeline templates as part of source code Git repositories. When triggered by a source code push or a pull request for the configured Git repository, the feature runs the pipeline and reports the status.
@@ -30,107 +30,20 @@ include::modules/op-installing-pipelines-as-code-on-an-openshift-cluster.adoc[le
3030

3131
include::modules/op-installing-pipelines-as-code-cli.adoc[leveloffset=+1]
3232

33-
[id="using-pipelines-as-code-with-a-git-repository-hosting-service-provider"]
34-
== Using {pac} with a Git repository hosting service provider
33+
include::modules/op-configuring-pipelines-as-code-for-a-git-repository-hosting-service-provider.adoc[leveloffset=+1]
3534

36-
[role="_abstract"]
37-
After installing {pac}, cluster administrators can configure a Git repository hosting service provider. Currently, the following services are supported:
38-
39-
* GitHub App
40-
* GitHub Webhook
41-
* GitLab
42-
* Bitbucket Server
43-
* Bitbucket Cloud
44-
45-
[NOTE]
46-
====
47-
GitHub App is the recommended service for using with {pac}.
48-
====
49-
50-
include::modules/op-using-pipelines-as-code-with-a-github-app.adoc[leveloffset=+1]
35+
include::modules/op-configuring-pipelines-as-code-for-a-github-app.adoc[leveloffset=+2]
5136

5237
include::modules/op-creating-a-github-application-in-administrator-perspective.adoc[leveloffset=+2]
5338

54-
include::modules/op-using-pipelines-as-code-with-github-webhook.adoc[leveloffset=+1]
55-
56-
.Additional resources
57-
58-
* link:https://docs.github.com/en/developers/webhooks-and-events/webhooks/creating-webhooks[GitHub Webhook documentation on GitHub]
59-
* link:https://docs.github.com/en/rest/guides/getting-started-with-the-checks-api[GitHub Check Runs documentation on GitHub]
60-
* link:https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token[Creating a personal access token on GitHub]
61-
* link:https://github.com/settings/tokens/new?description=pipelines-as-code-token&scopes=repo[Classic tokens with pre-filled permissions]
62-
63-
include::modules/op-using-pipelines-as-code-with-gitlab.adoc[leveloffset=+1]
64-
65-
.Additional resources
66-
67-
* link:https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html[GitLab Webhook documentation on GitLab]
68-
69-
include::modules/op-using-pipelines-as-code-with-bitbucket-cloud.adoc[leveloffset=+1]
70-
71-
.Additional resources
72-
73-
* link:https://support.atlassian.com/bitbucket-cloud/docs/app-passwords/[Create app password on Bitbucket Cloud]
74-
* link:https://developer.atlassian.com/cloud/bitbucket/bitbucket-api-changes-gdpr/#introducing-atlassian-account-id-and-nicknames[Introducing Altassian Account ID and Nicknames]
75-
76-
include::modules/op-using-pipelines-as-code-with-bitbucket-server.adoc[leveloffset=+1]
77-
78-
.Additional resources
79-
80-
* link:https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html[Create personal tokens on Bitbucket Server]
81-
* link:https://support.atlassian.com/bitbucket-cloud/docs/manage-webhooks/#Create-webhooks[Create webhooks on Bitbucket server]
82-
83-
include::modules/op-interfacing-pipelines-as-code-with-custom-certificates.adoc[leveloffset=+1]
84-
85-
.Additional resources
86-
87-
* xref:../../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object[Enabling the cluster-wide proxy]
88-
89-
include::modules/op-using-repository-crd-with-pipelines-as-code.adoc[leveloffset=+1]
90-
91-
include::modules/op-setting-concurrency-limits-in-repository-crd.adoc[leveloffset=+2]
92-
93-
include::modules/op-using-pipelines-as-code-resolver.adoc[leveloffset=+1]
94-
95-
include::modules/op-using-remote-task-annotations-with-pipelines-as-code.adoc[leveloffset=+2]
96-
97-
include::modules/op-using-remote-pipeline-annotations-with-pipelines-as-code.adoc[leveloffset=+2]
98-
99-
include::modules/op-creating-pipeline-run-using-pipelines-as-code.adoc[leveloffset=+1]
100-
101-
.Additional resources
102-
103-
* link:https://github.com/google/cel-spec/blob/master/doc/langdef.md[CEL language specification]
104-
105-
include::modules/op-running-pipeline-run-using-pipelines-as-code.adoc[leveloffset=+1]
106-
107-
include::modules/op-monitoring-pipeline-run-status-using-pipelines-as-code.adoc[leveloffset=+1]
108-
109-
.Additional resources
110-
111-
* link:https://github.com/chmouel/tekton-slack-task-status[An example task to send Slack messages on success or failure]
112-
* link:https://github.com/openshift-pipelines/pipelines-as-code/blob/7b41cc3f769af40a84b7ead41c6f037637e95070/.tekton/push.yaml[An example of a pipeline run with `finally` tasks triggered on push events]
113-
114-
include::modules/op-using-private-repositories-with-pipelines-as-code.adoc[leveloffset=+1]
115-
116-
.Additional resources
117-
118-
* link:https://github.com/openshift-pipelines/pipelines-as-code/blob/main/test/testdata/pipelinerun_git_clone_private.yaml[An example of the `git-clone` task used for cloning private repositories]
119-
120-
include::modules/op-cleaning-up-pipeline-run-using-pipelines-as-code.adoc[leveloffset=+1]
121-
122-
include::modules/op-using-incoming-webhook-with-pipelines-as-code.adoc[leveloffset=+1]
39+
include::modules/op-pipelines-as-code-command-reference.adoc[leveloffset=+1]
12340

12441
include::modules/op-customizing-pipelines-as-code-configuration.adoc[leveloffset=+1]
12542

126-
include::modules/op-pipelines-as-code-command-reference.adoc[leveloffset=+1]
127-
12843
[role="_additional-resources"]
12944
[id="additional-resources-pac"]
13045
== Additional resources
13146

132-
* link:https://github.com/openshift-pipelines/pipelines-as-code/tree/main/.tekton[An example of the `.tekton/` directory in the Pipelines as Code repository]
133-
13447
* xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[Installing OpenShift Pipelines]
13548

13649
* xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[Installing tkn]

modules/op-cleaning-up-pipeline-run-using-pipelines-as-code.adoc

Lines changed: 0 additions & 26 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// This module is included in the following assembly:
2+
//
3+
// *cicd/pipelines/using-pipelines-as-code.adoc
4+
5+
:_content-type: REFERENCE
6+
[id="configuring-pipelines-as-code-for-a-git-repository-hosting-service-provider_{context}"]
7+
= Configuring {pac} for a Git repository hosting service provider
8+
9+
[role="_abstract"]
10+
After installing {pac}, cluster administrators can configure a Git repository hosting service provider. Currently, the following services are supported:
11+
12+
* GitHub App
13+
* GitHub Webhook
14+
* GitLab
15+
* Bitbucket Server
16+
* Bitbucket Cloud
17+
18+
[NOTE]
19+
====
20+
GitHub App is the recommended service for using Pipelines as Code.
21+
====
22+

modules/op-using-pipelines-as-code-with-a-github-app.adoc renamed to modules/op-configuring-pipelines-as-code-for-a-github-app.adoc

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
// *cicd/pipelines/using-pipelines-as-code.adoc
44

55
:_content-type: PROCEDURE
6-
[id="using-pipelines-as-code-with-a-github-app_{context}"]
7-
= Using {pac} with a GitHub App
6+
[id="configuring-pipelines-as-code-for-a-github-app_{context}"]
7+
= Configuring {pac} for a GitHub App
88

99
[role="_abstract"]
1010
GitHub Apps act as a point of integration with {pipelines-title} and bring the advantage of Git-based workflows to OpenShift Pipelines. Cluster administrators can configure a single GitHub App for all cluster users. For GitHub Apps to work with Pipelines as Code, ensure that the webhook of the GitHub App points to the Pipelines as Code event listener route (or ingress endpoint) that listens for GitHub events.
@@ -40,6 +40,12 @@ To create and configure a GitHub App manually for {pac}, perform the following s
4040
* **GitHub Application Name**: `OpenShift Pipelines`
4141
* **Homepage URL**: OpenShift Console URL
4242
* **Webhook URL**: The {pac} route or ingress URL. You can find it by running the command `echo https://$(oc get route -n openshift-pipelines pipelines-as-code-controller -o jsonpath='{.spec.host}')`.
43+
+
44+
[NOTE]
45+
====
46+
If {pac} is installed without using the {pipelines-title} Operator, use the `pipelines-as-code` namespace instead of `openshift-pipelines`.
47+
====
48+
+
4349
* **Webhook secret**: An arbitrary secret. You can generate a secret by executing the command `openssl rand -hex 20`.
4450

4551
. Select the following **Repository permissions**:
@@ -78,14 +84,15 @@ To configure {pac} to access the newly created GitHub App, execute the following
7884

7985
[source,terminal]
8086
----
81-
$ oc -n openshift-pipelines create secret generic pipelines-as-code-secret \
82-
--from-literal github-private-key="$(cat <PATH_PRIVATE_KEY>)" \ <1>
83-
--from-literal github-application-id="<APP_ID>" \ <2>
84-
--from-literal webhook.secret="<WEBHOOK_SECRET>" <3>
87+
$ oc -n openshift-pipelines create secret generic pipelines-as-code-secret \ <1>
88+
--from-literal github-private-key="$(cat <PATH_PRIVATE_KEY>)" \ <2>
89+
--from-literal github-application-id="<APP_ID>" \ <3>
90+
--from-literal webhook.secret="<WEBHOOK_SECRET>" <4>
8591
----
86-
<1> The path to the private key you downloaded while configuring the GitHub App.
87-
<2> The **App ID** of the GitHub App.
88-
<3> The webhook secret provided when you created the GitHub App.
92+
<1> If {pac} is installed without using the {pipelines-title} Operator, use the `pipelines-as-code` namespace instead of `openshift-pipelines`.
93+
<2> The path to the private key you downloaded while configuring the GitHub App.
94+
<3> The **App ID** of the GitHub App.
95+
<4> The webhook secret provided when you created the GitHub App.
8996

9097

9198
[NOTE]

0 commit comments

Comments
 (0)