Skip to content

Commit 8478345

Browse files
joe0BABdvdksn
authored andcommitted
feat: documentation for docker-pass CLI plugin
Signed-off-by: David Karlsson <[email protected]>
1 parent 64afb7e commit 8478345

File tree

11 files changed

+157
-0
lines changed

11 files changed

+157
-0
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
datafolder: secrets-engine
3+
datafile: docker_pass
4+
title: docker pass
5+
layout: cli
6+
---
7+
8+
{{< summary-bar feature_name="Docker Pass" >}}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
datafolder: secrets-engine
3+
datafile: docker_pass_get
4+
title: docker pass get
5+
layout: cli
6+
---
7+
8+
{{< summary-bar feature_name="Docker Pass" >}}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
datafolder: secrets-engine
3+
datafile: docker_pass_ls
4+
title: docker pass ls
5+
layout: cli
6+
---
7+
8+
{{< summary-bar feature_name="Docker Pass" >}}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
datafolder: secrets-engine
3+
datafile: docker_pass_rm
4+
title: docker pass rm
5+
layout: cli
6+
---
7+
8+
{{< summary-bar feature_name="Docker Pass" >}}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
datafolder: secrets-engine
3+
datafile: docker_pass_set
4+
title: docker pass set
5+
layout: cli
6+
---
7+
8+
{{< summary-bar feature_name="Docker Pass" >}}
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
command: docker pass
2+
short: Manage your local OS keychain secrets.
3+
long: |-
4+
Docker Pass is a helper that allows you to store secrets securely in your
5+
local OS keychain and inject them into containers later.
6+
7+
On Windows: Uses the Windows Credential Manager API.
8+
9+
On macOS: Uses macOS Keychain services API.
10+
11+
On Linux: `org.freedesktop.secrets` API (requires DBus and `gnome-keyring` or
12+
`kdewallet` to be installed).
13+
usage: docker pass set|get|ls|rm
14+
pname: docker
15+
plink: docker.yaml
16+
cname:
17+
- docker pass set
18+
- docker pass get
19+
- docker pass ls
20+
- docker pass rm
21+
clink:
22+
- docker_pass_set.yaml
23+
- docker_pass_get.yaml
24+
- docker_pass_ls.yaml
25+
- docker_pass_rm.yaml
26+
deprecated: false
27+
experimental: true
28+
experimentalcli: true
29+
kubernetes: false
30+
swarm: false
31+
examples: |-
32+
### Using keychain secrets in containers
33+
34+
Create a secret:
35+
36+
```console
37+
$ docker pass set GH_TOKEN=123456789
38+
```
39+
40+
Creating a secret from STDIN:
41+
42+
```console
43+
echo 123456789 > token.txt
44+
cat token.txt | docker pass set GH_TOKEN
45+
```
46+
47+
Run a container that uses the secret:
48+
49+
```console
50+
$ docker run -e GH_TOKEN= -dt --name demo busybox
51+
```
52+
53+
Inspect your secret from inside the container
54+
55+
```console
56+
$ docker exec demo sh -c 'echo $GH_TOKEN'
57+
123456789
58+
```
59+
60+
Explicitly assigning a secret to another environment variable:
61+
62+
```console
63+
$ docker run -e GITHUB_TOKEN=se://GH_TOKEN -dt --name demo busybox
64+
```
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
command: docker pass get
2+
short: Get a secret
3+
usage: docker pass get NAME
4+
pname: docker pass
5+
plink: docker_pass.yaml
6+
deprecated: false
7+
hidden: false
8+
experimental: true
9+
experimentalcli: true
10+
kubernetes: false
11+
swarm: false
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
command: docker pass ls
2+
short: List secrets
3+
usage: docker pass ls
4+
pname: docker pass
5+
plink: docker_pass.yaml
6+
deprecated: false
7+
hidden: false
8+
experimental: true
9+
experimentalcli: true
10+
kubernetes: false
11+
swarm: false
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
command: docker pass rm
2+
short: Remove a secret
3+
usage: docker pass rm NAME
4+
pname: docker pass
5+
plink: docker_pass.yaml
6+
deprecated: false
7+
hidden: false
8+
experimental: true
9+
experimentalcli: true
10+
kubernetes: false
11+
swarm: false
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
command: docker pass set
2+
short: Set a secret
3+
usage: docker pass set NAME=VALUE
4+
long: |-
5+
Secrets can also be created from STDIN:
6+
7+
```console
8+
<some command> | docker pass set <name>
9+
```
10+
pname: docker pass
11+
plink: docker_pass.yaml
12+
deprecated: false
13+
hidden: false
14+
experimental: true
15+
experimentalcli: true
16+
kubernetes: false
17+
swarm: false

0 commit comments

Comments
 (0)