Skip to content

Commit 9884a0b

Browse files
committed
DUPLO-13771 improve README.md
1 parent abdea22 commit 9884a0b

File tree

1 file changed

+38
-53
lines changed

1 file changed

+38
-53
lines changed

README.md

+38-53
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# duplo-jit
2+
23
Command-line tools for JIT Duplo, AWS and Kubernetes access
34

45
## Installation
@@ -23,15 +24,15 @@ This tool is intended to be used in your `~/.aws/config`. It provides just-in-t
2324

2425
Example `~/.aws/config` for admin access to Duplo:
2526

26-
```
27+
```ini
2728
[profile myduplo-admin]
2829
region=us-west-2
2930
credential_process=duplo-jit aws --admin --host https://MY-DUPLO-HOSTNAME.duplocloud.net --interactive
3031
```
3132

3233
Example `~/.aws/config` for tenant-level access to Duplo:
3334

34-
```
35+
```ini
3536
[profile myduplo-tenant]
3637
region=us-west-2
3738
credential_process=duplo-jit aws --tenant MY-TENANT-NAME --host https://MY-DUPLO-HOSTNAME.duplocloud.net --interactive
@@ -44,89 +45,73 @@ credential_process=duplo-jit aws --tenant MY-TENANT-NAME --host https://MY-DUPLO
4445
```
4546
Usage of duplo-jit:
4647
-admin
47-
Get admin credentials
48+
Get admin credentials
49+
-api-host string
50+
Specify an alternate DuploCloud API base URL if it differs from the UI host (defaults to the value of --host if omitted)
4851
-debug
49-
Turn on verbose (debugging) output
52+
Turn on verbose (debugging) output
5053
-duplo-ops
51-
Get Duplo operations credentials
54+
Get Duplo operations credentials
5255
-host string
53-
Duplo API base URL
56+
DuploCloud base URL
5457
-interactive
55-
Allow getting Duplo credentials via an interactive browser session
56-
-port
57-
Allow choosing a port for the interactive browser session. Default is random
58+
Allow getting Duplo credentials via an interactive browser session
5859
-no-cache
59-
Disable caching (not recommended)
60+
Disable caching (not recommended)
61+
-port int
62+
Port to use for the local web server
6063
-tenant string
61-
Get credentials for the given tenant
64+
Get credentials for the given tenant
6265
-token string
63-
Duplo API token
66+
DuploCloud API token
6467
-version
65-
Output version information and exit
68+
Output version information and exit
6669
```
6770

6871
### duplo-jit duplo --help
6972

7073
```
7174
Usage of duplo-jit:
75+
-api-host string
76+
Specify an alternate DuploCloud API base URL if it differs from the UI host (defaults to the value of --host if omitted)
7277
-debug
73-
Turn on verbose (debugging) output
78+
Turn on verbose (debugging) output
7479
-host string
75-
Duplo API base URL
80+
DuploCloud base URL
7681
-interactive
77-
Allow getting Duplo credentials via an interactive browser session
78-
-port
79-
Allow choosing a port for the interactive browser session. Default is random
82+
Allow getting Duplo credentials via an interactive browser session
8083
-no-cache
81-
Disable caching (not recommended)
84+
Disable caching (not recommended)
85+
-port int
86+
Port to use for the local web server
8287
-token string
83-
Duplo API token
88+
DuploCloud API token
8489
-version
85-
Output version information and exit
90+
Output version information and exit
8691
```
8792

8893
### duplo-jit k8s --help
8994

9095
```
9196
Usage of duplo-jit:
97+
-api-host string
98+
Specify an alternate DuploCloud API base URL if it differs from the UI host (defaults to the value of --host if omitted)
9299
-debug
93-
Turn on verbose (debugging) output
100+
Turn on verbose (debugging) output
94101
-host string
95-
Duplo API base URL
102+
DuploCloud base URL
96103
-interactive
97-
Allow getting Duplo credentials via an interactive browser session
104+
Allow getting Duplo credentials via an interactive browser session
98105
-no-cache
99-
Disable caching (not recommended)
106+
Disable caching (not recommended)
100107
-plan string
101-
Get credentials for the given plan
102-
-tenant string
103-
Get credentials for the given tenant
104-
-token string
105-
Duplo API token
106-
-version
107-
Output version information and exit
108-
```
109-
110-
## Deprecated: duplo-aws-credential-process --help
111-
112-
```
113-
Usage of duplo-aws-credential-process:
114-
-admin
115-
Get admin credentials
116-
-debug
117-
Turn on verbose (debugging) output
118-
-duplo-ops
119-
Get Duplo operations credentials
120-
-host string
121-
Duplo API base URL
122-
-interactive
123-
Allow getting Duplo credentials via an interactive browser session
124-
-no-cache
125-
Disable caching (not recommended)
108+
Get credentials for the given plan
109+
-port int
110+
Port to use for the local web server
126111
-tenant string
127-
Get credentials for the given tenant
112+
Get credentials for the given tenant
128113
-token string
129-
Duplo API token
114+
DuploCloud API token
130115
-version
131-
Output version information and exit
116+
Output version information and exit
132117
```

0 commit comments

Comments
 (0)