Skip to content
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.

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

Expand documentation for --secret #13632

Closed
wants to merge 1 commit into from

Conversation

bossmc
Copy link

@bossmc bossmc commented Oct 1, 2021

Proposed changes

Expanded the documentation for the --secret and --mount=type=secret functions in the new buildkit/dockerfile 1.2 tooling.

Direct link to rendered version

Related issues (optional)

Adds documentation for moby/buildkit#1534 (as well as more general documentation of the feature)

@netlify
Copy link

netlify bot commented Oct 1, 2021

✔️ Deploy Preview for docsdocker ready!

🔨 Explore the source changes: 35cd491

🔍 Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/61575219f94cb7000861e3f5

😎 Browse the preview: https://deploy-preview-13632--docsdocker.netlify.app

@usha-mandya usha-mandya requested a review from tonistiigi October 8, 2021 09:21
@usha-mandya
Copy link
Member

@tonistiigi Could you PTAL?

have the secret file:
have the secret file._

The `type=secret` and `id` parameters are mandatory but the following optional
Copy link
Member

Choose a reason for hiding this comment

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

id is not mandatory if dst is set

have the secret file._

The `type=secret` and `id` parameters are mandatory but the following optional
parameters are also available if desired:
Copy link
Member

Choose a reason for hiding this comment

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

The `type=secret` and `id` parameters are mandatory but the following optional
parameters are also available if desired:

* `dst=<path>` - By default the secret file is created at `/run/secret/<id>` by
Copy link
Member

Choose a reason for hiding this comment

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

We do support dst for backwards compat with other flags that allowed ambiguity. But I think in examples we should normalize to target

@thaJeztah thaJeztah added the area/build Relates to Dockerfiles or docker build command label Dec 23, 2021
@docker-robott
Copy link
Collaborator

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions.
As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a /remove-lifecycle stale comment.
If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Relates to Dockerfiles or docker build command lifecycle/stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants