Skip to content

Add docs demonstrating how to share a Workspace with Sidecars #3322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from Oct 6, 2020
Merged

Add docs demonstrating how to share a Workspace with Sidecars #3322

merged 1 commit into from Oct 6, 2020

Conversation

ghost
Copy link

@ghost ghost commented Oct 2, 2020

Changes

Prior to this commit we didn't have any documentation showing how to share
a Workspace between Steps of a Task and the Task's Sidecars. In fact
there were two bugs that prevented this from working correctly. Those
bugs have since been squashed.

This commit adds documentation and an example yaml showing how to share a
Workspace between a Task's Steps and its Sidecars.

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Includes docs (if user facing)
  • Commit messages follow commit message best practices
  • Release notes block has been filled in or deleted (only if no user facing changes)

Release Notes

Added an example and documentation showing how to share a Workspace between Steps and Sidecars in a Task.

/kind documentation

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Oct 2, 2020
@ghost
Copy link
Author

ghost commented Oct 2, 2020 •
edited by ghost
Loading

This commit depends on two bugs fixes being merged: #3315 and #3318

@ghost
Copy link
Author

ghost commented Oct 2, 2020 •
edited by ghost
Loading

/hold

... until those bugs are merged.

@tekton-robot tekton-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 2, 2020
@ghost ghost added this to the Pipelines v0.17 milestone Oct 2, 2020
@ghost
Copy link
Author

ghost commented Oct 2, 2020

Integration failures are accurate but fixed by PRs mentioned in above comment.

@ghost
Copy link
Author

ghost commented Oct 5, 2020

/hold cancel

both dependent bugs are fixed now.

@tekton-robot tekton-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Oct 5, 2020
@ghost
Copy link
Author

ghost commented Oct 5, 2020

/retest

@ghost
Copy link
Author

ghost commented Oct 5, 2020

/test pull-tekton-pipeline-integration-tests

@ghost
Copy link
Author

ghost commented Oct 5, 2020 •
edited by ghost
Loading

It looks like the TaskRun's pod is timing out before the first step gets to run its few lines of script.

Edit: yup; bumped timeout to 30s and now it passes. Our test cluster must take quite a long time spinning up all the example containers at once.

Add docs demonstrating how to share a Workspace with Sidecars
a89ffee 
Prior to this commit we didn't have any documentation showing how to share
a Workspace between Steps of a Task and the Task's Sidecars. In fact
there were two bugs that prevented this from working correctly. Those
bugs have since been squashed.

This commit adds documentation and an example yaml showing how to share a
Workspace between a Task's Steps and its Sidecars.
@ghost
Copy link
Author

ghost commented Oct 5, 2020

/remove-kind documentation

@tekton-robot tekton-robot removed the kind/documentation Categorizes issue or PR as related to documentation. label Oct 5, 2020
@ghost
Copy link
Author

ghost commented Oct 5, 2020

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 5, 2020
@ghost
Copy link
Author

ghost commented Oct 5, 2020

/remove-kind documentation

@tekton-robot tekton-robot removed the kind/documentation Categorizes issue or PR as related to documentation. label Oct 5, 2020
@ghost
Copy link
Author

ghost commented Oct 5, 2020

/kind documentation

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Oct 5, 2020
vdemeester
vdemeester approved these changes Oct 6, 2020
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 6, 2020
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: 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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 6, 2020
@tekton-robot tekton-robot merged commit 3e90648 into tektoncd:master Oct 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afrittoli afrittoli Awaiting requested review from afrittoli

@bobcatfish bobcatfish Awaiting requested review from bobcatfish

Assignees

@vdemeester vdemeester

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
Pipelines v0.17
Development

Successfully merging this pull request may close these issues.
2 participants
@tekton-robot @vdemeester