TP3 updates

YAML updates

operator in proxy envt

operator change

review edits

review edit 2

review edits

Author: Preeticp

cicd/pipelines/creating-applications-with-cicd-pipelines.adoc

@@ -19,17 +19,17 @@ To create a full-fledged, self-serving CI/CD pipeline for an application, you mu
 
 This section uses the `pipelines-tutorial` example to demonstrate the preceding tasks. The example uses a simple application which consists of:
 
-* A front-end interface, `vote-ui`, with the source code in the link:https://github.com/openshift-pipelines/vote-ui/tree/release-tech-preview-2[`ui-repo`] Git repository.
-* A back-end interface, `vote-api`, with the source code in the link:https://github.com/openshift-pipelines/vote-api/tree/release-tech-preview-2[`api-repo`]  Git repository.
-* The `apply-manifests` and `update-deployment` tasks in the link:https://github.com/openshift/pipelines-tutorial/tree/release-tech-preview-2[`pipelines-tutorial`] Git repository.
+* A front-end interface, `vote-ui`, with the source code in the link:https://github.com/openshift-pipelines/vote-ui/tree/pipelines-1.3[`ui-repo`] Git repository.
+* A back-end interface, `vote-api`, with the source code in the link:https://github.com/openshift-pipelines/vote-api/tree/pipelines-1.3[`api-repo`]  Git repository.
+* The `apply-manifests` and `update-deployment` tasks in the link:https://github.com/openshift/pipelines-tutorial/tree/pipelines-1.3[`pipelines-tutorial`] Git repository.
 
 == Prerequisites
 
 * You have access to an {product-title} cluster.
 * You have installed xref:../../cicd/pipelines/installing-pipelines.adoc#installing-pipelines[OpenShift Pipelines] using the {pipelines-title} Operator listed in the OpenShift OperatorHub. Once installed, it is applicable to the entire cluster.
 * You have installed xref:../../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[OpenShift Pipelines CLI].
-* You have forked the front-end link:https://github.com/openshift-pipelines/vote-ui/tree/release-tech-preview-2[`ui-repo`] and back-end link:https://github.com/openshift-pipelines/vote-api/tree/release-tech-preview-2[`api-repo`] Git repositories using your GitHub ID, and have Administrator access to these repositories.
-* Optional: You have cloned the link:https://github.com/openshift/pipelines-tutorial/tree/release-tech-preview-2[`pipelines-tutorial`] Git repository.
+* You have forked the front-end link:https://github.com/openshift-pipelines/vote-ui/tree/pipelines-1.3[`ui-repo`] and back-end link:https://github.com/openshift-pipelines/vote-api/tree/pipelines-1.3[`api-repo`] Git repositories 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-1.3[`pipelines-tutorial`] Git repository.
 
 
 include::modules/op-creating-project-and-checking-pipeline-service-account.adoc[leveloffset=+1]

cicd/pipelines/installing-pipelines.adoc

@@ -8,11 +8,6 @@ toc::[]
 
 This guide walks cluster administrators through the process of installing the {pipelines-title} Operator to an {product-title} cluster.
 
-[NOTE]
-====
-The {pipelines-title} Operator is supported for installation in a restricted network environment. For more information, see xref:../../operators/admin/olm-restricted-networks.adoc#olm-restricted-networks[Using Operator Lifecycle Manager on restricted networks].
-====
-
 // Prerequisites for installing OpenShift Operator
 [discrete]
 == Prerequisites
@@ -37,7 +32,21 @@ include::modules/op-installing-pipelines-operator-in-web-console.adoc[leveloffse
 
 include::modules/op-installing-pipelines-operator-using-the-cli.adoc[leveloffset=+1]
 
+// {pipelines-title} Operator in a restricted environment
+
+include::modules/op-pipelines-operator-in-restricted-environment.adoc[leveloffset=+1]
 
-.Additional Resources
+
+== Additional Resources
 
 * You can learn more about installing Operators on {product-title} in the xref:../../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[adding Operators to a cluster] section.
+
+* For more information on using pipelines in a restricted environment see:
+
+** xref:../../creating-applications-with-cicd-pipelines.adoc#op-mirroring-images-to-run-pipelines-in-restricted-environment_creating-applications-with-cicd-pipelines[Mirroring images to run pipelines in a restricted environment]
+
+** xref:../../openshift_images/configuring-samples-operator.adoc#samples-operator-restricted-network-install[Configuring Samples Operator for a restricted cluster]
+
+** xref:../../installing/install_config/installing-restricted-networks-preparations.adoc#installation-about-mirror-registry_installing-restricted-networks-preparations[Creating a cluster with a mirrored registry]
+
+** xref:../../cli_reference/developer_cli_odo/using_odo_in_a_restricted_environment/creating-and-deploying-a-component-to-the-disconnected-cluster.adoc#mirroring-a-supported-builder-image_creating-and-deploying-a-component-to-the-disconnected-cluster[Mirroring a supported builder image]

modules/op-about-pipelinerun.adoc

@@ -23,7 +23,7 @@ spec:
   - name: deployment-name
     value: vote-api
   - name: git-url
-    value: http://github.com/openshift-pipelines/vote-api.git
+    value: https://github.com/openshift-pipelines/vote-api.git
   - name: IMAGE
     value: image-registry.openshift-image-registry.svc:5000/pipelines-tutorial/vote-api
   workspaces: <6>

modules/op-about-pipelines.adoc

@@ -11,7 +11,7 @@ A `Pipeline` resource definition consists of a number of fields or attributes, w
 
 The following example shows the `build-and-deploy` pipeline, which builds an application image from a Git repository using the `buildah` `ClusterTask` resource:
 
-[source,yaml]
+[source,yaml,subs="attributes+"]
 ----
 apiVersion: tekton.dev/v1beta1 <1>
 kind: Pipeline <2>
@@ -30,7 +30,7 @@ spec: <4>
   - name: git-revision
     type: string
     description: revision to be used from repo of the code for deployment
-    default: "release-tech-preview-3"
+    default: "{pipelines-ver}"
   - name: IMAGE
     type: string
     description: image to be build from the code

modules/op-about-tasks.adoc

@@ -18,25 +18,23 @@ kind: Task <2>
 metadata:
   name: apply-manifests <3>
 spec: <4>
-  params:
-  - default: k8s
-    description: The directory in source that contains yaml manifests
-    name: manifest_dir
-    type: string
-  steps:
-  - args:
-    - |-
-      echo Applying manifests in $(inputs.params.manifest_dir) directory
-      oc apply -f $(inputs.params.manifest_dir)
-      echo -----------------------------------
-    command:
-    - /bin/bash
-    - -c
-    image: quay.io/openshift/origin-cli:latest
-    name: apply
-    workingDir: /workspace/source
   workspaces:
   - name: source
+  params:
+    - name: manifest_dir
+      description: The directory in source that contains yaml manifests
+      type: string
+      default: "k8s"
+  steps:
+    - name: apply
+      image: image-registry.openshift-image-registry.svc:5000/openshift/cli:latest
+      workingDir: /workspace/source
+      command: ["/bin/bash", "-c"]
+      args:
+        - |-
+          echo Applying manifests in $(inputs.params.manifest_dir) directory
+          oc apply -f $(inputs.params.manifest_dir)
+          echo -----------------------------------
 ----
 <1> Task API version `v1beta1`.
 <2> Specifies the type of Kubernetes object. In this example, `Task`.

modules/op-about-triggers.adoc

@@ -45,7 +45,8 @@ spec:
 
 
 The following example shows a code snippet of a `TriggerTemplate` resource, which creates a pipeline run using the Git repository information received from the `TriggerBinding` resource you just created:
-[source,yaml]
+
+[source,yaml,subs="attributes+"]
 ----
 apiVersion: triggers.tekton.dev/v1alpha1 <1>
 kind: TriggerTemplate <2>
@@ -57,7 +58,7 @@ spec:
     description: The git repository url
   - name: git-revision
     description: The git revision
-    default: master
+    default: {pipelines-ver}
   - name: git-repo-name
     description: The name of the deployment to be created / patched
 
@@ -110,7 +111,7 @@ spec:
   bindings:
     - ref: vote-app <5>
   template: <6>
-     name: vote-app
+     ref: vote-app
 ----
 <1> The API version of the `Trigger` resource. In this example, `v1alpha1`.
 <2> Specifies the type of Kubernetes object. In this example, `Trigger`.

modules/op-adding-triggers.adoc

@@ -117,7 +117,7 @@ spec:
   bindings:
     - ref: vote-app
   template:
-     name: vote-app
+     ref: vote-app
 ----
 
 . Create the `Trigger` resource:

modules/op-constructing-pipelines-using-pipeline-builder.adoc

@@ -5,7 +5,7 @@
 [id="op-constructing-pipelines-using-pipeline-builder_{context}"]
 = Constructing Pipelines using the Pipeline Builder
 
-In the *Developer* perspective of the console, you can use the *+Add* -> *Pipeline* -> *Pipeline Builder* option to:
+In the *Developer* perspective of the console, you can use the *+Add* -> *Pipeline* -> *Pipeline builder* option to:
 
 * Configure pipelines using either the *Pipeline builder* or the *YAML view*.
 * Construct a pipeline flow using existing tasks and cluster tasks. When you install the OpenShift Pipelines Operator, it adds reusable pipeline cluster tasks to your cluster.
@@ -16,7 +16,7 @@ In the *Developer* perspective of the console, you can use the *+Add* -> *Pipeli
 
 .Procedure
 
-. In the *+Add* view of the *Developer* perspective, click the *Pipeline* tile to see the *Pipeline Builder* page.
+. In the *+Add* view of the *Developer* perspective, click the *Pipeline* tile to see the *Pipeline builder* page.
 . Configure the pipeline using either the *Pipeline builder* view or the *YAML view*.
 +
 [NOTE]

modules/op-installing-pipelines-operator-in-web-console.adoc

@@ -4,41 +4,50 @@
 [id="op-installing-pipelines-operator-in-web-console_{context}"]
 = Installing the {pipelines-title} Operator in web console
 
-You can install {pipelines-title} using the Operator listed in the {product-title} OperatorHub. When you install the {pipelines-title} Operator, the Custom Resources (CRs) required for the Pipelines configuration are automatically installed along with the Operator.
+You can install {pipelines-title} using the Operator listed in the {product-title} OperatorHub. When you install the {pipelines-title} Operator, the custom resources (CRs) required for the pipelines configuration are automatically installed along with the Operator.
+
+The default Operator custom resource definition (CRD) `config.operator.tekton.dev` is now replaced by `tektonconfigs.operator.tekton.dev`.  In addition, the Operator provides the following additional CRDs to individually manage OpenShift Pipelines components:
+ `tektonpipelines.operator.tekton.dev`, `tektontriggers.operator.tekton.dev` and `tektonaddons.operator.tekton.dev`.
+
+If you have OpenShift Pipelines already installed on your cluster, the existing installation is seamlessly upgraded. The Operator will replace the instance of `config.operator.tekton.dev` on your cluster with an instance of `tektonconfigs.operator.tekton.dev` and additional objects of the other CRDs as necessary.
+
+[WARNING]
+====
+If you manually changed your existing installation, such as, changing the target namespace in the `config.operator.tekton.dev` CRD instance by making changes to the `resource name - cluster` field, then the upgrade path is not smooth. In such cases, the recommended workflow is to uninstall your installation and reinstall the {pipelines-title} Operator.
+====
+
+The {pipelines-title} Operator now provides the option to choose the components that you want to install by specifying profiles as part of the `TektonConfig` CR. The `TektonConfig` CR is automatically installed when the Operator is installed.
+The supported profiles are:
+
+* Basic: This installs only Tekton pipelines.
+* Default: This installs Tekton pipeline and Tekton triggers.
+* All: This is the default profile used when the `TektonConfig` CR is installed. This profile installs all of the Tekton components: Tekton Pipelines, Tekton Triggers, Tekton Addons(which include `ClusterTasks`, `ClusterTriggerBindings`, `ConsoleCLIDownload`, `ConsoleQuickStart` and `ConsoleYAMLSample` resources).
 
 [discrete]
 .Procedure
 
 . In the *Administrator* perspective of the web console, navigate to *Operators* -> *OperatorHub*.
 
-. Use the *Filter by keyword* box to search for `{pipelines-title} Operator` in the catalog. Click the *OpenShift Pipelines Operator* tile.
-+
-[NOTE]
-====
-Ensure that you do not select the *Community* version of the *OpenShift Pipelines Operator*.
-====
-+
-//image::op-installed-tile.png[]
-//Remove the note below once the community operator is removed from OperatorHub
+. Use the *Filter by keyword* box to search for `{pipelines-title}` Operator in the catalog. Click the *{pipelines-title}* Operator tile.
 
-. Read the brief description about the Operator on the *{pipelines-title} Operator* page. Click *Install*.
-+
-//image::op-install-subscription.png[]
+. Read the brief description about the Operator on the *{pipelines-title}* Operator page. Click *Install*.
 
 . On the *Install Operator* page:
++
+.. Select *All namespaces on the cluster (default)* for the *Installation Mode*. This mode installs the Operator in the default `openshift-operators` namespace, which enables the Operator to watch and be made available to all namespaces in the cluster.
 
-  .. Select *All namespaces on the cluster (default)* for the *Installation Mode*. This mode installs the Operator in the default `openshift-operators` namespace, which enables the Operator to watch and be made available to all namespaces in the cluster.
+.. Select *Automatic* for the *Approval Strategy*. This ensures that the future upgrades to the Operator are handled automatically by the Operator Lifecycle Manager (OLM). If you select the *Manual* approval strategy, OLM creates an update request. As a cluster administrator, you must then manually approve the OLM update request to update the Operator to the new version.
 
-  .. Select *Automatic* for the *Approval Strategy*. This ensures that the future upgrades to the Operator are handled automatically by the Operator Lifecycle Manager (OLM). If you select the *Manual* approval strategy, OLM creates an update request. As a cluster administrator, you must then manually approve the OLM update request to update the Operator to the new version.
-  .. Select an *Update Channel*.
-    *** The *ocp-<4.x>* channel enables installation of the latest stable release of the {pipelines-title} Operator.
-    *** The *preview* channel enables installation of the latest preview version of the {pipelines-title} Operator, which may contain features that are not yet available from the 4.x update channel.
-+
-    . Click *Install*. You will see the Operator listed on the *Installed Operators* page.
+.. Select an *Update Channel*.
+
+*** The *Stable* channel enables installation of the latest stable release of the {pipelines-title} Operator.
+*** The *preview* channel enables installation of the latest preview version of the {pipelines-title} Operator, which may contain features that are not yet available from the *Stable* channel.
+
+. Click *Install*. You will see the Operator listed on the *Installed Operators* page.
 +
 [NOTE]
 ====
 The Operator is installed automatically into the `openshift-operators` namespace.
 ====
-
++
 . Verify that the *Status* is set to *Succeeded Up to date*  to confirm successful installation of {pipelines-title} Operator.

modules/op-pipelines-operator-in-restricted-environment.adoc

@@ -0,0 +1,11 @@
+// Module included in the following assemblies:
+//
+// */openshift_pipelines/installing-pipelines.adoc
+[id="op-pipelines-operator-in-restricted-environment_{context}"]
+= {pipelines-title} Operator in a restricted environment
+
+The {pipelines-title} Operator enables support for installation of pipelines in a restricted network environment.
+
+The Operator installs a proxy webhook that sets the proxy environment variables in the containers of the pod created by tekton-controllers based on the `cluster` proxy object. It also sets the proxy environment variables in the `TektonPipelines`, `TektonTriggers`, `Controllers`, `Webhooks`, and `Operator Proxy Webhook` resources.
+
+By default, the proxy webhook is disabled for the `openshift-pipelines` namespace. To disable it for any other namespace, you can add the `operator.tekton.dev/disable-proxy: true` label to the `namespace` object.