diff --git a/docs/docs/0.5/index.html b/docs/docs/0.5/index.html index 0f50d20f..fcf7e7ed 100644 --- a/docs/docs/0.5/index.html +++ b/docs/docs/0.5/index.html @@ -190,7 +190,7 @@

<
-
  • +
  • - 4. CLI Reference + 4. CLI Reference
    • @@ -142,7 +142,7 @@

    OpenShift Pipelines

    diff --git a/docs/docs/0.7/assembly_cli_reference.html b/docs/docs/0.7/assembly_cli_reference.html deleted file mode 100644 index f2fa6da6..00000000 --- a/docs/docs/0.7/assembly_cli_reference.html +++ /dev/null @@ -1,439 +0,0 @@ - - - - - - About Tekton CLI :: OpenShift Pipelines - - - - - -
    - -
    -
    -
    - -
    -
    - -
    -

    About Tekton CLI

    -
    -
    -
    -

    With the Tekton Pipelines command-line interface (CLI) you can interact with Tekton from a terminal. This section describes how to install it and lists the basic commands.

    -
    -
    -
    -
    -

    Installing the CLI

    -
    -
    -

    In order to interact with Tekton from a terminal, you need to install the Tekton CLI (tkn).

    -
    -
    -

    Installing from binary

    -
    -

    For macOS X

    -
    -
      -
    1. -

      Get the tar.gz:

      -
      -
      -
      curl -LO https://github.com/tektoncd/cli/releases/download/v0.4.0/tkn_0.4.0_Darwin_x86_64.tar.gz
      -
      -
      -
      2. -
    2. -

      Extract tkn to your PATH:

      -
      -
      -
      sudo tar xvzf tkn_0.4.0_Darwin_x86_64.tar.gz -C /usr/local/bin tkn
      -
      -
      -
      3. -
    -
    -
    -
    -

    For Linux AMD64

    -
    -
      -
    1. -

      Get the tar.gz:

      -
      -
      -
      curl -LO https://github.com/tektoncd/cli/releases/download/v0.4.0/tkn_0.4.0_Linux_x86_64.tar.gz
      -
      -
      -
      2. -
    2. -

      Extract tkn to your PATH:

      -
      -
      -
      sudo tar xvzf tkn_0.4.0_Linux_x86_64.tar.gz -C /usr/local/bin/ tkn
      -
      -
      -
      3. -
    -
    -
    -
    -

    For Linux ARM64

    -
    -
      -
    1. -

      Get the tar.gz:

      -
      -
      -
      curl -LO https://github.com/tektoncd/cli/releases/download/v0.4.0/tkn_0.4.0_Linux_arm64.tar.gz
      -
      -
      -
      2. -
    2. -

      Extract tkn to your PATH:

      -
      -
      -
      sudo tar xvzf tkn_0.4.0_Linux_arm64.tar.gz -C /usr/local/bin/ tkn
      -
      -
      -
      3. -
    -
    -
    -
    -

    For Windows

    -
    -
      -
    1. -

      Get the .zip file:

      -
      -
      -
      PS C:\Users\Admin\Downloads> curl -Uri https://github.com/tektoncd/cli/releases/download/v0.4.0/tkn_0.4.0_Windows_x86_64.zip
- -OutFile tkn_0.4.0_Windows_x86_64.zip
      -
      -
      -
      2. -
    2. -

      Extract tkn to your path:

      -
      3. -
    -
    -
    -
    -
    Expand-Archive -Path <sourcepath>/tkn_0.4.0_Windows_x86_64.zip -DestinationPath <destinationpath>
    -
    -
    -
    -
    -
    -
    -
    -

    Basic Tekton CLI commands

    -
    -
    -

    This section lists basic Tekton CLI commands. For a more detailed desciption, see Tekton Pipelines CLI.

    -
    -
    -

    Syntax

    -
    -

    tkn [command or options] [arguments…​]

    -
    -
    -
    -

    Global Options

    -
    -

    --help, -h

    -
    -
    -
    -

    Utility commands

    -
    -

    tkn

    -
    -

    Parent command for Tekton CLI.

    -
    -
    -
    -

    tkn completion

    -
    -

    Prints shell completion scripts.

    -
    -
    -
    -

    tkn version

    -
    -

    Prints version information.

    -
    -
    -
    -
    -

    Managing and running pipelines

    -
    -

    tkn pipeline

    -
    -

    Manages pipelines.

    -
    -
    -
    -

    tkn pipeline describe

    -
    -

    Describes a pipeline in a namespace.

    -
    -
    -
    -

    tkn pipeline list

    -
    -

    Lists pipelines in a namespace.

    -
    -
    -
    -

    tkn pipeline logs

    -
    -

    Shows pipeline logs.

    -
    -
    -
    -

    tkn pipeline start

    -
    -

    Starts pipelines.

    -
    -
    -
    -

    tkn pipelinerun

    -
    -

    Manages pipelineruns.

    -
    -
    -
    -

    tkn pipelinerun describe

    -
    -

    Describes a pipelinerun in a namespace.

    -
    -
    -
    -

    tkn pipelinerun list

    -
    -

    Lists pipelineruns in a namespace.

    -
    -
    -
    -

    tkn pipelinerun logs

    -
    -

    Shows pipelinerun logs.

    -
    -
    -
    -
    -

    Managing pipeline resources

    -
    -

    tkn resource

    -
    -

    Manages pipeline resources.

    -
    -
    -
    -

    tkn resource describe

    -
    -

    Describes a pipeline resource in a namespace.

    -
    -
    -
    -

    tkn resource list

    -
    -

    Lists pipeline resources in a namespace.

    -
    -
    -
    -
    -

    Managing and running tasks

    -
    -

    tkn task

    -
    -

    Manages tasks.

    -
    -
    -
    -

    tkn task list

    -
    -

    Lists tasks in a namespace.

    -
    -
    -
    -

    tkn taskrun

    -
    -

    Manages taskruns.

    -
    -
    -
    -

    tkn taskrun list

    -
    -

    Lists taskruns in a namespace.

    -
    -
    -
    -

    tkn taskrun logs

    -
    -

    Shows taskruns logs.

    -
    -
    -
    -
    -

    Managing clusters

    -
    -

    tkn clustertask

    -
    -

    Manages clustertasks.

    -
    -
    -
    -

    tkn clustertask list

    -
    -

    Lists clustertasks in a namespace.

    -
    -
    -
    -
    -
    -
    -
    -
    - - - - - diff --git a/docs/docs/0.7/assembly_installing-pipelines.html b/docs/docs/0.7/assembly_installing-pipelines.html index 4566ec39..6e8e31d7 100644 --- a/docs/docs/0.7/assembly_installing-pipelines.html +++ b/docs/docs/0.7/assembly_installing-pipelines.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/assembly_understanding-openshift-pipelines.html b/docs/docs/0.7/assembly_understanding-openshift-pipelines.html index 31fa0a4d..a5f73467 100644 --- a/docs/docs/0.7/assembly_understanding-openshift-pipelines.html +++ b/docs/docs/0.7/assembly_understanding-openshift-pipelines.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/assembly_using-pipelines.html b/docs/docs/0.7/assembly_using-pipelines.html index e284a056..fa68f88d 100644 --- a/docs/docs/0.7/assembly_using-pipelines.html +++ b/docs/docs/0.7/assembly_using-pipelines.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con-pipeline-resource-types.html b/docs/docs/0.7/con-pipeline-resource-types.html index 237d4179..24cea864 100644 --- a/docs/docs/0.7/con-pipeline-resource-types.html +++ b/docs/docs/0.7/con-pipeline-resource-types.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con_pipeline-cluster-resource.html b/docs/docs/0.7/con_pipeline-cluster-resource.html index e83ae2f2..a7f807af 100644 --- a/docs/docs/0.7/con_pipeline-cluster-resource.html +++ b/docs/docs/0.7/con_pipeline-cluster-resource.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con_pipeline-git-resources.html b/docs/docs/0.7/con_pipeline-git-resources.html index 2ef94773..67d3e17b 100644 --- a/docs/docs/0.7/con_pipeline-git-resources.html +++ b/docs/docs/0.7/con_pipeline-git-resources.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con_pipeline-image-resources.html b/docs/docs/0.7/con_pipeline-image-resources.html index c57f55d5..d270d2ae 100644 --- a/docs/docs/0.7/con_pipeline-image-resources.html +++ b/docs/docs/0.7/con_pipeline-image-resources.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con_pipeline-pull-request-resources.html b/docs/docs/0.7/con_pipeline-pull-request-resources.html index a62fa36f..600b5038 100644 --- a/docs/docs/0.7/con_pipeline-pull-request-resources.html +++ b/docs/docs/0.7/con_pipeline-pull-request-resources.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con_pipeline-task.html b/docs/docs/0.7/con_pipeline-task.html index c5f571b8..87121346 100644 --- a/docs/docs/0.7/con_pipeline-task.html +++ b/docs/docs/0.7/con_pipeline-task.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/con_pipelines-concepts.html b/docs/docs/0.7/con_pipelines-concepts.html index 836b54f9..55da6048 100644 --- a/docs/docs/0.7/con_pipelines-concepts.html +++ b/docs/docs/0.7/con_pipelines-concepts.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/0.7/index.html b/docs/docs/0.7/index.html index c38cec25..fcaf3430 100644 --- a/docs/docs/0.7/index.html +++ b/docs/docs/0.7/index.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • @@ -196,7 +196,7 @@

    <
    diff --git a/docs/docs/0.7/proc_installing-pipelines-operator.html b/docs/docs/0.7/proc_installing-pipelines-operator.html index 7cb78efe..b5d31457 100644 --- a/docs/docs/0.7/proc_installing-pipelines-operator.html +++ b/docs/docs/0.7/proc_installing-pipelines-operator.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • @@ -156,7 +156,7 @@

    Prerequisites

    diff --git a/docs/docs/0.7/ref_cli_reference.html b/docs/docs/0.7/ref_cli_reference.html deleted file mode 100644 index d6e29f54..00000000 --- a/docs/docs/0.7/ref_cli_reference.html +++ /dev/null @@ -1,342 +0,0 @@ - - - - - - Basic Tekton CLI commands :: OpenShift Pipelines - - - - - -
    - -
    -
    -
    - -
    -
    - -
    -

    Basic Tekton CLI commands

    -
    -
    -
    -

    This section lists basic Tekton CLI commands. For a more detailed desciption, see Tekton Pipelines CLI.

    -
    -
    -
    -
    -

    Syntax

    -
    -
    -

    tkn [command or options] [arguments…​]

    -
    -
    -
    -
    -

    Global Options

    -
    -
    -

    --help, -h

    -
    -
    -
    -
    -

    Utility commands

    -
    -
    -

    tkn

    -
    -

    Parent command for Tekton CLI.

    -
    -
    -
    -

    tkn completion

    -
    -

    Prints shell completion scripts.

    -
    -
    -
    -

    tkn version

    -
    -

    Prints version information.

    -
    -
    -
    -
    -
    -

    Managing and running pipelines

    -
    -
    -

    tkn pipeline

    -
    -

    Manages pipelines.

    -
    -
    -
    -

    tkn pipeline describe

    -
    -

    Describes a pipeline in a namespace.

    -
    -
    -
    -

    tkn pipeline list

    -
    -

    Lists pipelines in a namespace.

    -
    -
    -
    -

    tkn pipeline logs

    -
    -

    Shows pipeline logs.

    -
    -
    -
    -

    tkn pipeline start

    -
    -

    Starts pipelines.

    -
    -
    -
    -

    tkn pipelinerun

    -
    -

    Manages pipelineruns.

    -
    -
    -
    -

    tkn pipelinerun describe

    -
    -

    Describes a pipelinerun in a namespace.

    -
    -
    -
    -

    tkn pipelinerun list

    -
    -

    Lists pipelineruns in a namespace.

    -
    -
    -
    -

    tkn pipelinerun logs

    -
    -

    Shows pipelinerun logs.

    -
    -
    -
    -
    -
    -

    Managing pipeline resources

    -
    -
    -

    tkn resource

    -
    -

    Manages pipeline resources.

    -
    -
    -
    -

    tkn resource describe

    -
    -

    Describes a pipeline resource in a namespace.

    -
    -
    -
    -

    tkn resource list

    -
    -

    Lists pipeline resources in a namespace.

    -
    -
    -
    -
    -
    -

    Managing and running tasks

    -
    -
    -

    tkn task

    -
    -

    Manages tasks.

    -
    -
    -
    -

    tkn task list

    -
    -

    Lists tasks in a namespace.

    -
    -
    -
    -

    tkn taskrun

    -
    -

    Manages taskruns.

    -
    -
    -
    -

    tkn taskrun list

    -
    -

    Lists taskruns in a namespace.

    -
    -
    -
    -

    tkn taskrun logs

    -
    -

    Shows taskruns logs.

    -
    -
    -
    -
    -
    -

    Managing clusters

    -
    -
    -

    tkn clustertask

    -
    -

    Manages clustertasks.

    -
    -
    -
    -

    tkn clustertask list

    -
    -

    Lists clustertasks in a namespace.

    -
    -
    -
    -
    -
    -
    -
    - - - - - diff --git a/docs/docs/0.7/release_notes_0.7.html b/docs/docs/0.7/release_notes_0.7.html index f06322ec..14549f69 100644 --- a/docs/docs/0.7/release_notes_0.7.html +++ b/docs/docs/0.7/release_notes_0.7.html @@ -95,13 +95,13 @@

    OpenShift Pipelines

  • - 4. CLI Reference + 4. CLI Reference
    • diff --git a/docs/docs/index.html b/docs/docs/index.html new file mode 100644 index 00000000..e189d620 --- /dev/null +++ b/docs/docs/index.html @@ -0,0 +1,9 @@ + + + + + + +Redirect Notice +

    Redirect Notice

    +

    The page you requested has been relocated to https://openshift.github.io/pipelines-docs/docs/docs/0.7/index.html.

    diff --git a/docs/index.html b/docs/index.html index 3977999f..e189d620 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,9 +1,9 @@ - + Redirect Notice

    Redirect Notice

    -

    The page you requested has been relocated to https://openshift.github.io/pipelines-docs/docs/0.7/index.html.

    \ No newline at end of file +

    The page you requested has been relocated to https://openshift.github.io/pipelines-docs/docs/docs/0.7/index.html.

    diff --git a/index.html b/index.html index a2d8116e..aec9e6f8 100644 --- a/index.html +++ b/index.html @@ -1,11 +1,9 @@ - - - - - + + + Redirect Notice

    Redirect Notice

    -

    The page you requested has been relocated to https://openshift.github.io/pipelines-docs/docs/0.7/index.html.

    \ No newline at end of file +

    The page you requested has been relocated to https://openshift.github.io/pipelines-docs/docs/docs/0.7/index.html.

    diff --git a/modules/ROOT/pages/assembly_installing-pipelines.adoc b/modules/ROOT/pages/assembly_installing-pipelines.adoc index 457a6c53..0b9652e7 100644 --- a/modules/ROOT/pages/assembly_installing-pipelines.adoc +++ b/modules/ROOT/pages/assembly_installing-pipelines.adoc @@ -7,7 +7,9 @@ The following section describes how to install and uninstall OpenShift Pipelines. -include::proc_installing-pipelines-operator.adoc[leveloffset=+1] +include::proc_installing-pipelines-operator-in-web-console.adoc[leveloffset=+1] + +include::proc_installing-pipelines-operator-using-the-cli.adoc[leveloffset=+1] include::proc_uninstalling-pipelines-operator.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/proc_installing-pipelines-operator.adoc b/modules/ROOT/pages/proc_installing-pipelines-operator-in-web-console.adoc similarity index 95% rename from modules/ROOT/pages/proc_installing-pipelines-operator.adoc rename to modules/ROOT/pages/proc_installing-pipelines-operator-in-web-console.adoc index c725086b..57f75203 100644 --- a/modules/ROOT/pages/proc_installing-pipelines-operator.adoc +++ b/modules/ROOT/pages/proc_installing-pipelines-operator-in-web-console.adoc @@ -2,8 +2,8 @@ // assembly_installing-pipelines.adoc -[id="installing-the-pipelines-operator_{context}"] -= Installing the Pipelines Operator +[id="installing-the-pipelines-operator-in-web-console_{context}"] += Installing the Pipelines Operator in Web Console OpenShift Pipelines can be installed by using the operator listed in the OpenShift OperatorHub. When you install the pipelines operator, the custom resources required for the pipeline configuration are automatically installed along with the operator. diff --git a/modules/ROOT/pages/proc_installing-pipelines-operator-using-the-cli.adoc b/modules/ROOT/pages/proc_installing-pipelines-operator-using-the-cli.adoc new file mode 100644 index 00000000..4ab2629c --- /dev/null +++ b/modules/ROOT/pages/proc_installing-pipelines-operator-using-the-cli.adoc @@ -0,0 +1,40 @@ +// Module included in the following assemblies: +// +// * assembly_installing_pipelines.adoc + +[id="proc_installing-pipelines-operator-using-the-cli_{context}"] += Installing the OpenShift Pipelines operator using the CLI + +You can install OpenShift Pipelines operator from the OperatorHub using the CLI. + +.Prerequisites + +- Access to an OpenShift cluster using an admin account. + +- *oc* is installed on your system. + +.Procedure + +. Create a Subscription object YAML file to subscribe a namespace to the OpenShift Pipelines Operator, +for example, `sub.yaml`: ++ +---- +apiVersion: operators.coreos.com/v1alpha1 +kind: Subscription +metadata: + name: openshift-pipelines-operator + namespace: openshift-operators +spec: + channel: dev-preview + name: openshift-pipelines-operator + source: community-operators + sourceNamespace: openshift-marketplace +---- + +. Create the Subscription object: ++ +---- +$ oc apply -f sub.yaml +---- ++ +The OpenShift Pipelines operator is now installed in the default target namespace `openshift-pipelines`. diff --git a/modules/ROOT/pages/proc_triggering-and-running-a-pipeline.adoc b/modules/ROOT/pages/proc_triggering-and-running-a-pipeline.adoc index 8504e6e5..ce6d3b58 100644 --- a/modules/ROOT/pages/proc_triggering-and-running-a-pipeline.adoc +++ b/modules/ROOT/pages/proc_triggering-and-running-a-pipeline.adoc @@ -29,6 +29,7 @@ Pipelinerun started: petclinic-deploy-pipeline-run-q62p8 ==== Note: OpenShift Pipelines 0.7 does not automatically use the pipeline service account for running pipelineruns. This has been fixed in the OpenShift Pipelines 0.8 release. If you want to use the OpenShift Console developer perspective to start the pipeline with OpenShift Pipelines 0.7, run the following commands to elevate the permissions of the default service account used for running pipelineruns that are started by the OpenShift Console, as follows: ---- +$ oc adm policy add-scc-to-user privileged -z default $ oc adm policy add-role-to-user edit -z default ---- ==== diff --git a/modules/ROOT/pages/proc_working-with-pipelines-using-developer-perspective.adoc b/modules/ROOT/pages/proc_working-with-pipelines-using-developer-perspective.adoc index ab734354..779cbe90 100644 --- a/modules/ROOT/pages/proc_working-with-pipelines-using-developer-perspective.adoc +++ b/modules/ROOT/pages/proc_working-with-pipelines-using-developer-perspective.adoc @@ -25,7 +25,7 @@ To visually interact with the pipelines in your project: . In the *Pipelines* view of the Developer Perspective, select the project you created from the *Project* drop-down to see the pipelines listed in the *Pipelines* page. + -image::pipeine_list.png[Pipelines in the Developer perspective] +image::pipeline_list.png[Pipelines in the Developer perspective] . Click on the required pipeline to see the *Pipeline Details* page. The pipelines *Overview* provides a visual representation of all the serial and parallel tasks in the pipeline. +