Skip to content

Commit

Permalink
Added documentation for opc task.
Browse files Browse the repository at this point in the history
  • Loading branch information
Senjuti256 authored and openshift-merge-bot[bot] committed Mar 22, 2024
1 parent df94de3 commit dfcac10
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
This repository provides various task related to OpenShift and OpenShift Pipelines.
- [openshift-client](docs/task-openshift-client.md)
- [tkn](docs/task-tkn.md)
- [opc](docs/task-opc.md)
- [kn](docs/task-kn.md)
- [kn-apply](docs/task-kn-apply.md)
56 changes: 56 additions & 0 deletions docs/task-opc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
`opc` Tekton Task
-----------------------

# Abstract

The `opc` Task makes it easy to work with Tekton resources in OpenShift Pipelines.

# Usage

Please, consider the usage example below:

```yaml
---
apiVersion: tekton.dev/v1
kind: PipelineRun
metadata: {}
spec:
pipelineRef:
name: task-opc
params:
- name: SCRIPT
value: "opc $@"
- name: ARGS
value: opc-command-you-want-to-execute

```
You'll need to replace `opc-command-you-want-to-execute` with opc CLI arguments based on what operation you want to perform with the Tekton resources in OpenShift Pipelines.
In case the Container Registry requires authentication, please consider the [Tekton Pipelines documentation][tektonPipelineAuth]. In a nutshell, you need to create a Kubernetes Secret describing the following attributes:

```bash
kubectl create secret docker-registry imagestreams \
--docker-server="image-registry.openshift-image-registry.svc:5000" \
--docker-username="${REGISTRY_USERNAME}" \
--docker-password="${REGISTRY_TOKEN}"
```

Then make sure the Secret is linked with the Service-Account running the `TaskRun`/`PipelineRun`.

## Workspace

| Name | Optional | Description |
| :------------ | :------------------------: | :--------------------------- |
| `kubeconfig_dir` | `true` | An optional workspace that allows you to provide a .kube/config file for opc to access the cluster. |


## Params

| Param | Type | Default | Description |
| :------------ | :------------------------: | :--------------------------- | :------------------------- |
| `SCRIPT` | `string` | (required) | opc CLI script to execute |
| `ARGS` | `array` | (required) | opc CLI arguments to run |



[tektonPipelineAuth]: https://tekton.dev/docs/pipelines/auth/#configuring-docker-authentication-for-docker

0 comments on commit dfcac10

Please sign in to comment.