TKNECO-93: Buildah Task Documentation #39
Conversation
Senjuti256
force-pushed
the
Documentation
branch
from
73203b4
to
83a5ed3
Compare
Senjuti256
added
documentation
doc/skopeo-copy.md
Outdated
There was a problem hiding this comment.
Please sync up with @Aneesh-M-Bhat's PR #40, check if there are any differences from what you're doing with his and merge into a single place.
doc/buildah.md
Outdated
| Containers Tekton Tasks | ||
| ----------------------- | ||
|
|
||
| # `Buildah` Tekton Task |
There was a problem hiding this comment.
Please the following snippet for the page tittle:
Buildah Tekton Task
-------------------
doc/buildah.md
Outdated
| 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`. |
There was a problem hiding this comment.
On the previous PR (#40) we end up repeating this part, let's please extract the container registry authentication configuration into a single .md file, so we can link this and future documentation to the same place.
doc/buildah.md
Outdated
There was a problem hiding this comment.
Let's use a docs folder, please.
There was a problem hiding this comment.
I have used it already.
doc/buildah.md
Outdated
| - name: TLS_VERIFY | ||
| value: true | ||
| - name: VERBOSE | ||
| value: false |
There was a problem hiding this comment.
For a shorter example, you can omit the Params with default values, like these two.
doc/buildah.md
Outdated
| | `BUILD_EXTRA_ARGS` | `string` | `""` | Extra parameters passed for the build command when building images. | | ||
| | `PUSH_EXTRA_ARGS` | `string` | `""` | Extra parameters passed for the push command when pushing images. | |
There was a problem hiding this comment.
Empty should just be ``, instead of "".
doc/buildah.md
Outdated
|
|
||
| # `Buildah` Tekton Task | ||
|
|
||
| The `buildah` Task is meant to build [OCI][OCI] container images without the requirement of container runtime daemon like Docker daemon using [Buildah][containersBuildah], the Task results contain the image name and the SHA256 image digest. |
There was a problem hiding this comment.
Please extract this paragraph on a # Abstract document section.
doc/buildah.md
Outdated
|
|
||
| The `buildah` Task is meant to build [OCI][OCI] container images without the requirement of container runtime daemon like Docker daemon using [Buildah][containersBuildah], the Task results contain the image name and the SHA256 image digest. | ||
|
|
||
| Please, consider the usage example below: |
There was a problem hiding this comment.
And let's create a new section named # Usage, please.
doc/buildah.md
Outdated
|
|
||
| Then make sure the Secret is linked with the Service-Account running the `TaskRun`/`PipelineRun`. | ||
|
|
||
| ## Params |
There was a problem hiding this comment.
Please add a new section for the Workspaces documentation.
otaviof
changed the title
Basic documentation as per story: https://issues.redhat.com/browse/TKNECO-92
Drafted a preliminary documentation for users to get a hold of the Buildah Task.