From 981b9886230c912bd9bb4c6a90f94689de69b0f9 Mon Sep 17 00:00:00 2001 From: "Matt Moore (via sockpuppet)" Date: Wed, 22 May 2019 14:00:47 +0000 Subject: [PATCH] Format markdown Produced via: `prettier --write --prose-wrap=always $(find -name '*.md' | grep -v vendor | grep -v .github)` --- docs/developers/README.md | 8 +++++--- docs/resources.md | 35 ++++++++++++++++++++++++----------- 2 files changed, 29 insertions(+), 14 deletions(-) diff --git a/docs/developers/README.md b/docs/developers/README.md index ef1ffa67430..77c0da17e5c 100644 --- a/docs/developers/README.md +++ b/docs/developers/README.md @@ -149,7 +149,9 @@ If the image is a private registry, the service account should include an ## Builder namespace on containers -The `/builder/` namespace is reserved on containers for various system tools, such as the following: +The `/builder/` namespace is reserved on containers for various system tools, +such as the following: - - The environment variable HOME is set to `/builder/home`, used by the builder tools and injected on into all of the step containers - - Default location for output-images `/builder/output-images` \ No newline at end of file +- The environment variable HOME is set to `/builder/home`, used by the builder + tools and injected on into all of the step containers +- Default location for output-images `/builder/output-images` diff --git a/docs/resources.md b/docs/resources.md index aef0c3e9206..a6a65c91e3c 100644 --- a/docs/resources.md +++ b/docs/resources.md @@ -164,9 +164,17 @@ spec: #### Surfacing the image digest built in a task -To surface the image digest in the output of the `taskRun` the builder tool should produce this information in a [OCI Image Spec](https://github.com/opencontainers/image-spec/blob/master/image-layout.md) `index.json` file. This file should be placed on a location as specified in the task definition under the resource `outputImageDir`. Annotations in `index.json` will be ignored, and if there are multiple versions of the image, the latest will be used. +To surface the image digest in the output of the `taskRun` the builder tool +should produce this information in a +[OCI Image Spec](https://github.com/opencontainers/image-spec/blob/master/image-layout.md) +`index.json` file. This file should be placed on a location as specified in the +task definition under the resource `outputImageDir`. Annotations in `index.json` +will be ignored, and if there are multiple versions of the image, the latest +will be used. + +For example this build-push task defines the `outputImageDir` for the +`builtImage` resource in `/workspace/buildImage` -For example this build-push task defines the `outputImageDir` for the `builtImage` resource in `/workspace/buildImage` ```yaml apiVersion: tekton.dev/v1alpha1 kind: Task @@ -175,20 +183,24 @@ metadata: spec: inputs: resources: - - name: workspace - type: git + - name: workspace + type: git outputs: resources: - - name: builtImage - type: image - outputImageDir: /workspace/builtImage + - name: builtImage + type: image + outputImageDir: /workspace/builtImage steps: ... ``` -If no value is specified for `outputImageDir`, it will default to `/builder/image-outputs/{resource-name}`. -*Please check the builder tool used on how to pass this path to create the output file.* +If no value is specified for `outputImageDir`, it will default to +`/builder/image-outputs/{resource-name}`. + +_Please check the builder tool used on how to pass this path to create the +output file._ -The `taskRun` will include the image digest in the `resourcesResult` field that is part of the `taskRun.Status` +The `taskRun` will include the image digest in the `resourcesResult` field that +is part of the `taskRun.Status` for example: @@ -201,7 +213,8 @@ status: ... ``` -If the `index.json` file is not produced, the image digest will not be included in the `taskRun` output. +If the `index.json` file is not produced, the image digest will not be included +in the `taskRun` output. ### Cluster Resource