Add a Workspaces doc #2230
Add a Workspaces doc #2230
Conversation
ghost
added
kind/documentation
googlebot
added
the
cla: yes
tekton-robot
added
the
size/XL
ghost
requested a review
from
tekton-robot
added
size/L
docs/pipelineruns.md
Outdated
| secretName: my-secret | ||
| ``` | ||
| Tekton supports several different kinds of `Volume` in `Workspaces`. For a list of | ||
| the different kinds see the section of `workspaces.md` on |
There was a problem hiding this comment.
Nit: backtick around workspaces.md looks odd, make it a link? workspaces
There was a problem hiding this comment.
Leave out the workspaces.md filename and avoid repetition. Just say "For more information, see VolumeSources....
docs/taskruns.md
Outdated
| secretName: my-secret | ||
| ``` | ||
| Tekton supports several different kinds of `Volume` in `Workspaces`. For a list of | ||
| the different kinds see the section of `workspaces.md` on |
There was a problem hiding this comment.
Nit: same as above, backtick around workspaces.md looks odd
| @@ -0,0 +1,336 @@ | |||
| # Workspaces | |||
|
|
|||
| - [Workspaces](#workspaces) | |||
There was a problem hiding this comment.
good catch, thanks, generated a new TOC.
docs/workspaces.md
Outdated
| ## Examples | ||
|
|
||
| - [TaskRun example](../examples/v1beta1/taskruns/workspace.yaml) | ||
| - [PipelineRun example](../examples/v1beta1/pipelineruns/workspace.yaml) |
There was a problem hiding this comment.
the link results in 404, it should be PipelineRun example
There was a problem hiding this comment.
PipelineRuns example is named ../examples/v1beta1/pipelineruns/workspaces.yaml instead of ../examples/v1beta1/pipelineruns/workspace.yaml
There was a problem hiding this comment.
For the sake of expediency, I'll do an editorial pass on this new doc once you merge the PR. LGTM for now.
|
thanks @sbwsg, couple of minor nits, and one example link is broken, otherwise |
|
Thank you for writing this up, Scott! I will review this later today.
…On Mon, Mar 16, 2020, 02:39 Priti Desai ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/workspaces.md
<#2230 (comment)>:
> + - Using a `Secret` as a `Workspace` has the following caveats:
+ 1. `Secret` volume sources are always mounted as read-only. `Step`s
+ cannot write content to them and may error out if a write is attempted.
+ 2. The `Secret` you want to use as a `Workspace` must exist prior to
+ the `TaskRun` being submitted.
+ 3. `Secret`s have a [size limit of 1MB](https://github.com/kubernetes/kubernetes/blob/f16bfb069a22241a5501f6fe530f5d4e2a82cf0e/pkg/apis/core/validation/validation.go#L5042).
+ - [Kubernetes docs for `secret` volumes](https://kubernetes.io/docs/concepts/storage/volumes/#secret)
+
+> If you need support for a `VolumeSource` not listed here
+> [please open an issue](https://github.com/tektoncd/pipeline/issues) or feel free to
+> [contribute a PR](https://github.com/tektoncd/pipeline/blob/master/CONTRIBUTING.md).
+
+## Examples
+
+- [TaskRun example](../examples/v1beta1/taskruns/workspace.yaml)
+- [PipelineRun example](../examples/v1beta1/pipelineruns/workspace.yaml)
PipelineRuns example is named
../examples/v1beta1/pipelineruns/workspaces.yaml instead of
../examples/v1beta1/pipelineruns/workspace.yaml
—
You are receiving this because your review was requested.
Reply to this email directly, view it on GitHub
<#2230 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AG3UR4X3WWEMX3O6SDPMMUDRHXCRRANCNFSM4LJAZD7A>
.
|
docs/taskruns.md
Outdated
| secretName: my-secret | ||
| ``` | ||
| Tekton supports several different kinds of `Volume` in `Workspaces`. For a list of | ||
| the different kinds see the section of `workspaces.md` on |
There was a problem hiding this comment.
Leave out the workspaces.md filename and avoid repetition. Just say "For more information, see VolumeSources....
There's been a bit of feedback since workspaces were released that having their documentation spread across tasks.md, taskruns.md, pipelines.md, and pipelineruns.md made understanding the feature harder. Having the information organized this way also makes maintenance more difficult, particularly of those sections which are duplicated across multiple files. This PR adds a new doc, workspaces.md, that consolidates all of the information about workspaces. This doc is then linked to from each of the individual CRD docs mentioned above.
|
/test pull-tekton-pipeline-build-tests |
1 similar comment
|
/test pull-tekton-pipeline-build-tests |
|
thanks for updates @sbwsg |
|
In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sergetron, vdemeester The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
ghost
removed
the
needs-cherry-pick
Changes
There's been a bit of feedback since workspaces were released that
having their documentation spread across tasks.md, taskruns.md,
pipelines.md, and pipelineruns.md made understanding the feature harder.
Having the information organized this way also makes maintenance more
difficult, particularly of those sections which are duplicated across
multiple files.
This PR adds a new doc, workspaces.md, that consolidates all of the
information about workspaces. This doc is then linked to from each of
the individual CRD docs mentioned above which are also updated to
include a very short description of the need for workspaces and a short
example YAML.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you
review them:
Release Notes