From 843ea542872f00772d7c8dd4613e82d6362881d9 Mon Sep 17 00:00:00 2001 From: github-actions Date: Wed, 2 Oct 2024 12:48:05 +0000 Subject: [PATCH] task-containers: Auto-update tekton pipelines resources\n\nURL: https://github.com/openshift-pipelines/task-containers\nIgnoredVersions: v0.1.0 --- tasks/task-buildah/0.4.2/README.md | 76 ++++++++++++++++++ tasks/task-s2i-dotnet/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-go/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-java/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-nodejs/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-perl/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-php/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-python/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-s2i-ruby/0.4.2/README.md | 83 ++++++++++++++++++++ tasks/task-skopeo-copy/0.4.2/README.md | 104 +++++++++++++++++++++++++ 10 files changed, 844 insertions(+) create mode 100644 tasks/task-buildah/0.4.2/README.md create mode 100644 tasks/task-s2i-dotnet/0.4.2/README.md create mode 100644 tasks/task-s2i-go/0.4.2/README.md create mode 100644 tasks/task-s2i-java/0.4.2/README.md create mode 100644 tasks/task-s2i-nodejs/0.4.2/README.md create mode 100644 tasks/task-s2i-perl/0.4.2/README.md create mode 100644 tasks/task-s2i-php/0.4.2/README.md create mode 100644 tasks/task-s2i-python/0.4.2/README.md create mode 100644 tasks/task-s2i-ruby/0.4.2/README.md create mode 100644 tasks/task-skopeo-copy/0.4.2/README.md diff --git a/tasks/task-buildah/0.4.2/README.md b/tasks/task-buildah/0.4.2/README.md new file mode 100644 index 00000000..8c0a41f0 --- /dev/null +++ b/tasks/task-buildah/0.4.2/README.md @@ -0,0 +1,76 @@ +`Buildah` Tekton Task +----------------------- + +# Abstract + +The `buildah` Task is meant to build [OCI][OCI] container images without the requirement of container runtime daemon like Docker daemon using [Buildah][Buildah], the Task results contain the image name and the SHA256 image digest. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: PipelineRun +metadata: {} +spec: + pipelineRef: + name: task-buildah + params: + - name: IMAGE + value: your-image-name + - name: TLS_VERIFY + value: true + - name: VERBOSE + value: false + workspaces: + - name: source + persistentVolumeClaim: + claimName: your-pvc-name +``` +You'll need to replace `your-image-name` with the actual name of the image you want to build, and `your-pvc-name` with the name of the PersistentVolumeClaim where your source code is stored. +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 | +| :------------ | :------------------------: | :--------------------------- | +| `source` | `false` | Container build context, like for instnace a application source code followed by a `Containerfile`. | + + +## Params + +| Param | Type | Default | Description | +| :------------ | :------------------------: | :--------------------------- | :------------------------- | +| `IMAGE` | `string` | (required) | Fully qualified source container image name, including tag, to be built by buildah. | +| `CONTAINERFILE_PATH` | `string` | `Containerfile` | Path to the `Containerfile` (or `Dockerfile`) relative to the `source` workspace. | +| `TLS_VERIFY` | `string` | `true` | Sets the TLS verification flags, `true` is recommended. | +| `VERBOSE` | `string` | `false` | Shows a more verbose (debug) output. | +| `SUBDIRECTORY` | `string` | `.` | Relative subdirectory to the `source` Workspace for the build-context. | +| `STORAGE_DRIVER` | `string` | `overlay` | Set buildah storage driver to reflect the currrent cluster node's settings. | +| `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. | +| `SKIP_PUSH` | `string` | `false` | Skip pushing the image to the container registry. | + + +## Results + +| Result | Description | +| :------------ | :------------------------- | +| `IMAGE_URL` | Fully qualified image name. | +| `IMAGE_DIGEST` | SHA256 digest of the image just built. | + +[tektonPipelineAuth]: https://tekton.dev/docs/pipelines/auth/#configuring-docker-authentication-for-docker +[Buildah]: https://github.com/containers/buildah +[OCI]: https://opencontainers.org/ + diff --git a/tasks/task-s2i-dotnet/0.4.2/README.md b/tasks/task-s2i-dotnet/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-dotnet/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-go/0.4.2/README.md b/tasks/task-s2i-go/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-go/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-java/0.4.2/README.md b/tasks/task-s2i-java/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-java/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-nodejs/0.4.2/README.md b/tasks/task-s2i-nodejs/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-nodejs/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-perl/0.4.2/README.md b/tasks/task-s2i-perl/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-perl/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-php/0.4.2/README.md b/tasks/task-s2i-php/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-php/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-python/0.4.2/README.md b/tasks/task-s2i-python/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-python/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-s2i-ruby/0.4.2/README.md b/tasks/task-s2i-ruby/0.4.2/README.md new file mode 100644 index 00000000..b86765b3 --- /dev/null +++ b/tasks/task-s2i-ruby/0.4.2/README.md @@ -0,0 +1,83 @@ +Source-to-Image Tekton Tasks (`s2i`) +------------------------------------ + +# Abstract + +Describes the Tekton Tasks supporting Source-to-Image for various ecosystems. + +# `s2i` Builder Images + +This section we explain each language ecosystem comes with a predefined set of builder images, supported by Red Hat. + +The `s2i` Task helps in building reproducible container images from source code i.e. task for supporting s2i functionality. + +The s2i Task has been customized with builder images specific to various languages and have been named appropriately as follows: + +| Task Name | Builder Image Used | +| ---------- | ---------------------------------------------------------------------- | +| s2i-python | http://registry.access.redhat.com/ubi8/python-39:latest | +| s2i-go | http://registry.access.redhat.com/ubi8/go-toolset:1.19.10-3 | +| s2i-java | http://registry.access.redhat.com/ubi8/openjdk-11:latest | +| s2i-dotnet | http://registry.access.redhat.com/ubi8/dotnet-60:6.0-37.20230802191230 | +| s2i-php | http://registry.access.redhat.com/ubi9/php-81:1-29 | +| s2i-nodejs | http://registry.access.redhat.com/ubi8/nodejs-18:latest | +| s2i-perl | http://registry.access.redhat.com/ubi9/perl-532:1-91 | +| s2i-ruby | http://registry.access.redhat.com/ubi9/ruby-31:1-50 | + +In case, the above builder images associated with the languages aren’t satisfactory for your source code, you can change it using appropriate parameter. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: s2i-python + params: + - name: IMAGE + value: registry.registry.svc.cluster.local:32222/task-containers/task-s2i-python:latest +``` + +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`. + +## Workspaces + +All of the s2i tasks use the `source` workspace which is meant to contain the Application source code, which acts as the build context for S2I workflow. + + +## Params + +| Param | Type | Default | Description | +| ----------------- | ------ | ------------------------ | ------------------------------------------------------------------------- | +| IMAGE | string | (required) | Fully qualified container image name to be built by s2i | +| IMAGE_SCRIPTS_URL | string | image:///usr/libexec/s2i | URL containing the default assemble and run scripts for the builder image | +| ENV_VARS | array | [] | Array containing string of Environment Variables as "KEY=VALUE” | +| SUBDIRECTORY | string | . | Relative subdirectory to the source Workspace for the build-context. | +| STORAGE_DRIVER | string | overlay | Set buildah storage driver to reflect the currrent cluster node's | +| settings. | +| 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. | +| SKIP_PUSH | string | false | Skip pushing the image to the container registry. | +| TLS_VERIFY | string | true | Sets the TLS verification flag, true is recommended. | +| VERBOSE | string | false | Turns on verbose logging, all commands executed will be printed out. | + +## Results + +| Result | Description | +| ------------ | ------------------------------- | +| IMAGE_URL | Fully qualified image name. | +| IMAGE_DIGEST | Digest of the image just built. | diff --git a/tasks/task-skopeo-copy/0.4.2/README.md b/tasks/task-skopeo-copy/0.4.2/README.md new file mode 100644 index 00000000..231ad032 --- /dev/null +++ b/tasks/task-skopeo-copy/0.4.2/README.md @@ -0,0 +1,104 @@ +Containers Tekton Tasks +----------------------- + +# Abstract + +Describes the Tekton Tasks supporting Skopeo-Copy + +# `skopeo-copy` Tekton Task + +The `skopeo-copy` Task is meant to replicate a container image from the `SOURCE_IMAGE_URL` registry to the `DESTINATION_IMAGE_URL` using [Skopeo][containersSkopeo], the Task results contain the SHA256 digests. + +# Usage + +Please, consider the usage example below: + +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: skopeo-copy + params: + - name: SOURCE_IMAGE_URL + value: docker://docker.io/busybox:latest + - name: DESTINATION_IMAGE_URL + value: docker://image-registry.openshift-image-registry.svc:5000/task-containers/busybox:latest +``` + +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`. + +In case multiple images need to be copied, or one image under multiple names/tags, a `url.txt` file can be provided: + +```text +docker://docker.io/library/busybox:latest docker://image-registry.openshift-image-registry.svc.cluster.local:5000/my-project/busybox:latest +docker://docker.io/library/busybox:1 docker://image-registry.openshift-image-registry.svc.cluster.local:5000/my-project/busybox:1 +``` + + +This file has to be present at the root and mounted under the workspace `images_url`, for example using a ConfigMap: +```yaml +--- +apiVersion: tekton.dev/v1beta1 +kind: TaskRun +metadata: {} +spec: + taskRef: + name: skopeo-copy + workspaces: + - name: images_url + configmap: + name: configmap-images +``` + +Referenced config map: + +```yaml +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: configmap-images +data: + url.txt: | + docker://docker.io/library/busybox:latest docker://image-registry.openshift-image-registry.svc.cluster.local:5000/my-project/busybox:latest + docker://docker.io/library/busybox:1 docker://image-registry.openshift-image-registry.svc.cluster.local:5000/my-project/busybox:1 + +``` + +## Workspace + +| Name | Optional | Description | +|:-------------|:--------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `images_url` | `true` | For storing image urls in case of more than one image to copy. It must have a url.txt file at the root path containing a source and a destination image separated by a space on each line. | + +## Params + +| Param | Type | Default | Description | +| :------------ | :------------------------: | :---------------------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `SOURCE_IMAGE_URL` | `string` | "" | Fully qualified source container image name, including tag, to be copied into `DESTINATION_IMAGE_URL` param. If more than one image needs to be copied, leave empty. | +| `DESTINATION_IMAGE_URL` | `string` | "" | Fully qualified destination container image name, including tag. If more than one image needs to be copied, leave empty. | +| `SRC_TLS_VERIFY` | `string` | `true` | Sets the TLS verification flags for the source registry, `true` is recommended. | +| `DEST_TLS_VERIFY` | `string` | `true` | Sets the TLS verification flags for the destination registry, `true` is recommended. | +| `VERBOSE` | `string` | `false` | Shows a more verbose (debug) output. | + +## Results + +| Result | Description | +| :------------ |:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `SOURCE_DIGEST` | If a single image is copied it contains a source image SHA256 digest. When copying multiple images it contains SHA256 digests of all source images separated by a space. | +| `DESTINATION_DIGEST` | If a single image is copied it contains a destination image SHA256 digest. When copying multiple images it contains SHA256 digests of all destination images separated by a space. | + +[tektonPipelineAuth]: https://tekton.dev/docs/pipelines/auth/#configuring-docker-authentication-for-docker +[containersSkopeo]: https://github.com/containers/skopeo