-
Notifications
You must be signed in to change notification settings - Fork 8.1k
feat: documentation for docker-pass CLI plugin #23814
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
Merged
+157
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| datafolder: secrets-engine | ||
| datafile: docker_pass | ||
| title: docker pass | ||
| layout: cli | ||
| --- | ||
|
|
||
| {{< summary-bar feature_name="Docker Pass" >}} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| datafolder: secrets-engine | ||
| datafile: docker_pass_get | ||
| title: docker pass get | ||
| layout: cli | ||
| --- | ||
|
|
||
| {{< summary-bar feature_name="Docker Pass" >}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| datafolder: secrets-engine | ||
| datafile: docker_pass_ls | ||
| title: docker pass ls | ||
| layout: cli | ||
| --- | ||
|
|
||
| {{< summary-bar feature_name="Docker Pass" >}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| datafolder: secrets-engine | ||
| datafile: docker_pass_rm | ||
| title: docker pass rm | ||
| layout: cli | ||
| --- | ||
|
|
||
| {{< summary-bar feature_name="Docker Pass" >}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| datafolder: secrets-engine | ||
| datafile: docker_pass_set | ||
| title: docker pass set | ||
| layout: cli | ||
| --- | ||
|
|
||
| {{< summary-bar feature_name="Docker Pass" >}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,64 @@ | ||
| command: docker pass | ||
| short: Manage your local OS keychain secrets. | ||
| long: |- | ||
| Docker Pass is a helper that allows you to store secrets securely in your | ||
| local OS keychain and inject them into containers later. | ||
|
|
||
| On Windows: Uses the Windows Credential Manager API. | ||
|
|
||
| On macOS: Uses macOS Keychain services API. | ||
|
|
||
| On Linux: `org.freedesktop.secrets` API (requires DBus and `gnome-keyring` or | ||
| `kdewallet` to be installed). | ||
| usage: docker pass set|get|ls|rm | ||
| pname: docker | ||
| plink: docker.yaml | ||
| cname: | ||
| - docker pass set | ||
| - docker pass get | ||
| - docker pass ls | ||
| - docker pass rm | ||
| clink: | ||
| - docker_pass_set.yaml | ||
| - docker_pass_get.yaml | ||
| - docker_pass_ls.yaml | ||
| - docker_pass_rm.yaml | ||
| deprecated: false | ||
| experimental: true | ||
| experimentalcli: true | ||
| kubernetes: false | ||
| swarm: false | ||
| examples: |- | ||
| ### Using keychain secrets in containers | ||
|
|
||
| Create a secret: | ||
|
|
||
| ```console | ||
| $ docker pass set GH_TOKEN=123456789 | ||
| ``` | ||
|
|
||
| Creating a secret from STDIN: | ||
|
|
||
| ```console | ||
| echo 123456789 > token.txt | ||
| cat token.txt | docker pass set GH_TOKEN | ||
| ``` | ||
|
|
||
| Run a container that uses the secret: | ||
|
|
||
| ```console | ||
| $ docker run -e GH_TOKEN= -dt --name demo busybox | ||
| ``` | ||
|
|
||
| Inspect your secret from inside the container | ||
|
|
||
| ```console | ||
| $ docker exec demo sh -c 'echo $GH_TOKEN' | ||
| 123456789 | ||
| ``` | ||
|
|
||
| Explicitly assigning a secret to another environment variable: | ||
|
|
||
| ```console | ||
| $ docker run -e GITHUB_TOKEN=se://GH_TOKEN -dt --name demo busybox | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| command: docker pass get | ||
| short: Get a secret | ||
| usage: docker pass get NAME | ||
| pname: docker pass | ||
| plink: docker_pass.yaml | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: true | ||
| experimentalcli: true | ||
| kubernetes: false | ||
| swarm: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| command: docker pass ls | ||
| short: List secrets | ||
| usage: docker pass ls | ||
| pname: docker pass | ||
| plink: docker_pass.yaml | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: true | ||
| experimentalcli: true | ||
| kubernetes: false | ||
| swarm: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| command: docker pass rm | ||
| short: Remove a secret | ||
| usage: docker pass rm NAME | ||
| pname: docker pass | ||
| plink: docker_pass.yaml | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: true | ||
| experimentalcli: true | ||
| kubernetes: false | ||
| swarm: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| command: docker pass set | ||
| short: Set a secret | ||
| usage: docker pass set NAME=VALUE | ||
| long: |- | ||
| Secrets can also be created from STDIN: | ||
|
|
||
| ```console | ||
| <some command> | docker pass set <name> | ||
| ``` | ||
| pname: docker pass | ||
| plink: docker_pass.yaml | ||
| deprecated: false | ||
| hidden: false | ||
| experimental: true | ||
| experimentalcli: true | ||
| kubernetes: false | ||
| swarm: false |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.