diff --git a/modules/ROOT/nav.adoc b/modules/ROOT/nav.adoc index 46ab2b92..32e9c934 100644 --- a/modules/ROOT/nav.adoc +++ b/modules/ROOT/nav.adoc @@ -20,6 +20,16 @@ ** xref:proc_creating-applications-with-cicd-pipelines.adoc[4.1 Creating-applications with CI/CD pipelines] ** xref:proc_interacting-with-pipelines-using-the-developer-perspective.adoc[4.2 Interacting with pipelines using the Developer perspective] * xref:assembly_cli-reference.adoc[5. CLI Reference] -** xref:proc_installing-cli.adoc[5.1 Installing CLI] -** xref:ref_cli-reference.adoc[5.2 Basic Commands] +** xref:proc_installing-cli.adoc[5.1 Installing tkn] +** xref:op-tkn-reference.adoc[5.2 Basic tkn commands] +*** xref:op-tkn-utility-commands.adoc[5.2.1 Utility commands] +*** xref:op-tkn-pipeline-management.adoc[5.2.2 Pipeline management commands] +*** xref:op-tkn-pipeline-run.adoc[5.2.3 Pipelinerun commands] +*** xref:op-tkn-task-management.adoc[5.2.4 Task management commands] +*** xref:op-tkn-task-run.adoc[5.2.5 Taskrun commands] +*** xref:op-tkn-condition-management.adoc[5.2.6 Condition management commands] +*** xref:op-tkn-pipeline-resource-management.adoc[5.2.7 Pipeline resource management commands] +*** xref:op-tkn-clustertask-management.adoc[5.2.8 Clustertask management commands] +*** xref:op-tkn-trigger-management.adoc[5.2.9 Trigger management commands] + * xref:release_notes.adoc[Release Notes] diff --git a/modules/ROOT/pages/assembly_cli-reference.adoc b/modules/ROOT/pages/assembly_cli-reference.adoc index 3c82a247..7c2502ff 100644 --- a/modules/ROOT/pages/assembly_cli-reference.adoc +++ b/modules/ROOT/pages/assembly_cli-reference.adoc @@ -5,7 +5,7 @@ :context: cli-reference -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. +With the Tekton (tkn) 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. // CLI Installation Guide @@ -13,7 +13,7 @@ include::proc_installing-cli.adoc[leveloffset=+1] // CLI Reference -include::ref_cli-reference.adoc[leveloffset=+1] +include::op-tkn-reference.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/op-tkn-clustertask-management.adoc b/modules/ROOT/pages/op-tkn-clustertask-management.adoc new file mode 100644 index 00000000..108aa1fb --- /dev/null +++ b/modules/ROOT/pages/op-tkn-clustertask-management.adoc @@ -0,0 +1,46 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-reference.adoc + +[id="op-tkn-clustertask-management-commands_{context}"] += Clustertask management commands + +== tkn clustertask +Manage clustertasks. + +.Example: Display help +---- +$ tkn clustertask --help +---- + +== tkn clustertask delete +Delete a clustertask resource in a cluster. + +.Example: Delete `mytask1` and `mytask2` clustertasks +---- +$ tkn clustertask delete mytask1 mytask2 +---- + + +== tkn clustertask describe +Describe a clustertask. + +.Example: Describe the `mytask` clustertask +---- +$ tkn clustertask describe mytask1 +---- + +== tkn clustertask list +List clustertasks in a namespace. + +.Example: List clustertasks in a namespace +---- +$ tkn clustertask list -n myspace +---- +== tkn clustertask start +Start clustertasks. + +.Example: Start the `mytask` clustertask in a namespace +---- +$ tkn clustertask start mytask -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-condition-management.adoc b/modules/ROOT/pages/op-tkn-condition-management.adoc new file mode 100644 index 00000000..65deab80 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-condition-management.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-references.adoc + +[id="op-tkn-condition-management_{context}"] += Condition management commands + +== tkn condition +Manage conditions. + +.Example: Display help +---- +$ tkn condition --help +---- + +== tkn condition delete +Delete a condition in a namespace. + +.Example: Delete the `mycondition1` condition from a namespace +---- +$ tkn condition delete mycondition1 -n myspace +---- + +== tkn condition list +List conditions in a namespace. + +.Example: List conditions in a namespace +---- +$ tkn condition list -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-pipeline-management.adoc b/modules/ROOT/pages/op-tkn-pipeline-management.adoc new file mode 100644 index 00000000..0901b26e --- /dev/null +++ b/modules/ROOT/pages/op-tkn-pipeline-management.adoc @@ -0,0 +1,63 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-references.adoc + +[id="op-tkn-pipeline-management_{context}"] += Pipelines management commands + +== tkn pipeline +Manage pipelines. + +.Example: Display help +---- +$ pipeline --help +---- + +== tkn pipeline create +Create a pipeline in a namespace. + +.Example: Create a pipeline defined by the `mypipeline.yaml` file in a namespace +----- +$ tkn pipeline create -f mypipeline.yaml -n myspace +----- + +== tkn pipeline delete + +Delete a pipeline in a namespace. + +.Example: Delete the `mypipeline` pipeline from a namespace +---- +$ tkn pipeline delete mypipeline -n myspace +---- + +== tkn pipeline describe +Describe a pipeline in a namespace. + +.Example: Describe `mypipeline` pipeline +---- +$ tkn pipeline describe mypipeline +---- + +== tkn pipeline list +List pipelines in a namespace. + +.Example: Display a list of pipelines +----- +$ tkn pipeline list +----- + +== tkn pipeline logs +Display pipeline logs for a specific pipeline. + +.Example: Stream live logs for the `mypipeline` pipeline +---- +$ tkn pipeline logs -f mypipeline +---- + +== tkn pipeline start +Start a pipeline. + +.Example: Start `mypipeline` pipeline +---- +$ tkn pipeline start mypipeline +---- diff --git a/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc b/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc new file mode 100644 index 00000000..799244cb --- /dev/null +++ b/modules/ROOT/pages/op-tkn-pipeline-resource-management.adoc @@ -0,0 +1,45 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-reference.adoc + +[id="op-tkn-pipeline-resource-management_{context}"] += Pipeline resource management commands + +== tkn resource +Manage pipeline resources. + +.Example: Display help +---- +$ tkn resource -h +---- + +== tkn resource create +Create a pipeline resource in a namespace. + +.Example: Create pipeline resource defined by the `myresource.yaml` file in a namespace +---- +$ tkn resource create -f myresource.yaml -n myspace +---- + +== tkn resource delete +Delete a pipeline resource in a namespace. + +.Example: Delete the `myresource` pipeline resource from a namespace +---- +$ tkn resource delete myresource -n myspace +---- + +== tkn resource describe +Describes a pipeline resource in a namespace. + +.Example: Describe the `myresource` pipeline resource +---- +$ tkn resource describe myresource -n `myspace` +---- +== tkn resource list +List pipeline resources in a namespace. + +.Example: List all pipeline resources in a namespace +---- +$ tkn resource list -n `myspace` +---- diff --git a/modules/ROOT/pages/op-tkn-pipeline-run.adoc b/modules/ROOT/pages/op-tkn-pipeline-run.adoc new file mode 100644 index 00000000..808482de --- /dev/null +++ b/modules/ROOT/pages/op-tkn-pipeline-run.adoc @@ -0,0 +1,55 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-references.adoc + +[id="op-tkn-pipeline-run_{context}"] += Pipelinerun commands + + +== tkn pipelinerun +Manage pipelineruns. + +.Example: Display help +---- +$ tkn pipelinerun -h +---- + +== tkn pipelinerun cancel +Cancel a pipelinerun in a namespace. + +.Example: Cancel the `mypipelinerun` pipelinerun from a namespace +---- +$ tkn pipeline cancel mypipelinerun -n myspace +---- + +== tkn pipelinerun delete +Delete pipelinerun in a namespace. + +.Example: Delete pipelineruns from a namespace +---- +$ tkn pipelinerun delete mypipelinerun1 mypipelinerun2 -n myspace +---- + +== tkn pipelinerun describe +Describe a pipelinerun in a namespace. + +.Example: Describe the `mypipelinerun` pipelinerun in a namespace +---- +tkn pipelinerun describe mypipelinerun -n myspace +---- + +== tkn pipelinerun list +Display a list of pipelineruns in a namespace. + +.Example: Display a list of pipelineruns in a namespace +---- +$ tkn pipelinerun list -n myspace +---- + +== tkn pipelinerun logs +Show the logs of pipelinerun. + +.Example: Display the logs of the `mypipelinerun` pipelinerun with all tasks and steps in a namespace +---- +$ tkn pipelinerun logs mypipeline -a -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-reference.adoc b/modules/ROOT/pages/op-tkn-reference.adoc new file mode 100644 index 00000000..e4d4e7d3 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-reference.adoc @@ -0,0 +1,24 @@ +[id='op-tkn-reference'] += Pipeline `tkn` reference +//include::modules/common-attributes.adoc[] +:context: op-tkn-reference +toc::[] + + +This section lists basic `tkn` CLI commands. For a more detailed description, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI]. + +== Basic Syntax +`tkn [command or options] [arguments...]` + +== Global Options +`--help, -h` + +include::op-tkn-utility-commands.adoc[leveloffset=+1] +include::op-tkn-pipeline-management.adoc[leveloffset=+1] +include::op-tkn-pipeline-run.adoc[leveloffset=+1] +include::op-tkn-task-management.adoc[leveloffset=+1] +include::op-tkn-task-run.adoc[leveloffset=+1] +include::op-tkn-condition-management.adoc[leveloffset=+1] +include::op-tkn-pipeline-resource-management.adoc[leveloffset=+1] +include::op-tkn-clustertask-management.adoc[leveloffset=+1] +include::op-tkn-trigger-management.adoc[leveloffset=+1] diff --git a/modules/ROOT/pages/op-tkn-task-management.adoc b/modules/ROOT/pages/op-tkn-task-management.adoc new file mode 100644 index 00000000..a1bc6b1f --- /dev/null +++ b/modules/ROOT/pages/op-tkn-task-management.adoc @@ -0,0 +1,62 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-reference.adoc + +[id="op-tkn-task-management_{context}"] += Task management commands + +== tkn task +Manage tasks. + +.Example: Display help +---- +$ tkn task -h +---- + +== tkn task create +Create a task in a namespace. + +.Example: Create a task defined by the `mytask.yaml` file in a namespace +---- +$ tkn task create -f mytask.yaml -n myspace +---- + +== tkn task delete +Delete task resources in a namespace. + +.Example: Delete `mytask1` and `mytask2` tasks from a namespace +---- +$ tkn task delete mytask1 mytask2 -n myspace +---- + +== tkn task describe +Describe a task in a namespace. + +.Example: Describe the `mytask` task in a namespace +---- +$ tkn task describe mytask -n myspace +---- + +== tkn task list +List tasks in a namespace. + +.Example: List all the tasks in a namespace +---- +$ tkn task list -n myspace +---- + +== tkn task logs +Display task logs. + +.Example: Display logs for the `mytaskrun` taskrun of the `mytask` task +---- +$ tkn task logs mytask mytaskrun -n myspace +---- + +== tkn task start +Start a task. + +.Example: Start the `mytask` task in a namespace +---- +$ tkn task start mytask -s -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-task-run.adoc b/modules/ROOT/pages/op-tkn-task-run.adoc new file mode 100644 index 00000000..fc52efb6 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-task-run.adoc @@ -0,0 +1,56 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-reference.adoc + +[id="op-tkn-task-run_{context}"] += Taskrun commands + +== tkn taskrun +Manage taskruns. + +.Example: Display help +---- +$ tkn taskrun -h +---- + +== tkn taskrun cancel +Cancel a taskrun in a namespace. + +.Example: Cancel the `mytaskrun` taskrun from a namespace +---- +$ tkn taskrun cancel mytaskrun -n myspace +---- + +== tkn taskrun delete +Delete taskruns in a namespace. + +.Example: Delete `mytaskrun1` and `mytaskrun2` taskruns from a namespace +---- +$ tkn taskrun delete mytaskrun1 mytaskrun2 -n myspace +---- + +== tkn taskrun describe +Describe a taskrun in a namespace. + +.Example: Describe the `mytaskrun` taskrun in a namespace +---- +$ tkn taskrun describe mytaskrun -n myspace +---- + +== tkn taskrun list +List taskruns in a namespace. + +.Example: List all taskruns in a namespace +---- +$ tkn taskrun list -n myspace +---- + + +== tkn taskrun logs +Display taskruns logs. + +.Example: Display live logs for the `mytaskrun` taskrun in a namespace ` + +---- +$ tkn taskrun logs -f mytaskrun -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-trigger-management.adoc b/modules/ROOT/pages/op-tkn-trigger-management.adoc new file mode 100644 index 00000000..8b87f355 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-trigger-management.adoc @@ -0,0 +1,77 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-reference.adoc + +[id="op-tkn-trigger-management_{context}"] += Trigger management commands + +== tkn eventlistener +Manage event listeners. + +.Example: Display help +---- +$ tkn eventlistener -h +---- + +== tkn eventlistener delete +Delete event listeners in a namespace. + +.Example: Delete `mylistener1` and `mylistener2` event listeners in a namespace +---- +$ tkn eventlistener delete mylistener1 mylistener2 -n myspace +---- + +== tkn eventlistener list +Lists event listeners in a namespace. + +.Example: List all event listeners in a namespace +---- +$ tkn eventlistener list -n myspace +---- + +== tkn triggerbinding +Manage trigger bindings. + +.Example: Display trigger bindings help +---- +$ tkn triggerbinding -h +---- + +== tkn triggerbinding delete +Delete trigger bindings in a namespace. + +.Example: Delete `mybinding1` and `mybinding2` trigger bindings in a namespace +---- +$ tkn triggerbinding delete mybinding1 mybinding2 -n myspace +---- + +== tkn triggerbinding list +List trigger bindings in a namespace. + +.Example: List all trigger bindings in a namespace +---- +$ tkn triggerbinding list -n myspace +---- + +== tkn triggertemplate +Manage trigger templates. + +.Example: Display trigger template help +---- +$ tkn triggertemplate -h +---- +== tkn triggertemplate delete +Delete trigger templates in a namespace. + +.Example: Delete `mytemplate1` and `mytemplate2` trigger templates in a namespace +---- +$ tkn triggertemplate delete mytemplate1 mytemplate2 -n `myspace` +---- + +== tkn triggertemplate list +Lists trigger templates in a namespace. + +.Example: List all trigger templates in a namespace +---- +$ tkn triggertemplate list -n myspace +---- diff --git a/modules/ROOT/pages/op-tkn-utility-commands.adoc b/modules/ROOT/pages/op-tkn-utility-commands.adoc new file mode 100644 index 00000000..e36f2700 --- /dev/null +++ b/modules/ROOT/pages/op-tkn-utility-commands.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * pipelines/op-tkn-reference.adoc + +[id="op-tkn-utility-commands_{context}"] += Utility commands + +== tkn +Parent command for `tkn` CLI. + +.Example:Display all options +----- +$ tkn +----- + +== tkn completion [shell] +Print shell completion code which must be evaluated to provide interactive completion. Supported shells are `bash` and `zsh`. + +.Example: Completion code for `bash` shell +---- +$ tkn completion bash +---- + +== tkn version +Print version information of the `tkn` CLI. + +.Example: Check for the availability of a newer version +----- +$ tkn version -c +----- diff --git a/modules/ROOT/pages/ref_cli-reference.adoc b/modules/ROOT/pages/ref_cli-reference.adoc deleted file mode 100644 index 3ab02ff1..00000000 --- a/modules/ROOT/pages/ref_cli-reference.adoc +++ /dev/null @@ -1,85 +0,0 @@ -[id="basic-tekton-cli-commands_{context}"] -= Basic Tekton CLI commands - -This section lists basic Tekton CLI commands. For a more detailed desciption, see link:https://github.com/tektoncd/cli[Tekton Pipelines CLI]. - -== Syntax -`tkn [command or options] [arguments...]` - -== Global Options -`--help, -h` - -== Utility commands - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn.md[tkn] -Parent command for Tekton CLI. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_completion.md[tkn completion] -Prints shell completion scripts. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_version.md[tkn version] -Prints version information. - -== Managing and running pipelines -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline.md[tkn pipeline] -Manages pipelines. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_describe.md[tkn pipeline describe] -Describes a pipeline in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_list.md[tkn pipeline list] -Lists pipelines in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_logs.md[tkn pipeline logs] -Shows pipeline logs. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipeline_start.md[tkn pipeline start] -Starts pipelines. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun.md[tkn pipelinerun] -Manages pipelineruns. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun_describe.md[tkn pipelinerun describe] -Describes a pipelinerun in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun_list.md[tkn pipelinerun list] -Lists pipelineruns in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_pipelinerun_logs.md[tkn pipelinerun logs] -Shows pipelinerun logs. - -== Managing pipeline resources - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_resource.md[tkn resource] -Manages pipeline resources. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_resource_describe.md[tkn resource describe] -Describes a pipeline resource in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_resource_list.md[tkn resource list] -Lists pipeline resources in a namespace. - -== Managing and running tasks - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_task.md[tkn task] -Manages tasks. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_task_list.md[tkn task list] -Lists tasks in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_taskrun.md[tkn taskrun] -Manages taskruns. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_taskrun_list.md[tkn taskrun list] -Lists taskruns in a namespace. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_taskrun_logs.md[tkn taskrun logs] -Shows taskruns logs. - -== Managing clusters - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_clustertask.md[tkn clustertask] -Manages clustertasks. - -=== link:https://github.com/tektoncd/cli/blob/release-v0.4.0/docs/cmd/tkn_clustertask_list.md[tkn clustertask list] -Lists clustertasks in a namespace.