Updated docs

Optum · Oct 15, 2019 · 221ccdf · 221ccdf
1 parent 66d7c90
commit 221ccdf
Show file tree

Hide file tree

Showing 24 changed files with 245 additions and 26 deletions.
diff --git a/docs/dce.md b/docs/dce.md
@@ -21,8 +21,9 @@ Disposable Cloud Environment (DCE)
 ### SEE ALSO
 
 * [dce accounts](dce_accounts.md)	 - Manage dce accounts
-* [dce configure](dce_configure.md)	 - Configure DCE cli
+* [dce auth](dce_auth.md)	 - Login to dce
+* [dce init](dce_init.md)	 - First time DCE cli setup. Creates config file at ~/.dce.yaml
 * [dce leases](dce_leases.md)	 - Manage dce leases
 * [dce system](dce_system.md)	 - Deploy and configure the DCE system
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_accounts.md b/docs/dce_accounts.md
@@ -24,7 +24,6 @@ Manage dce accounts
 * [dce accounts add](dce_accounts_add.md)	 - Add one or more accounts to the accounts pool.
 * [dce accounts describe](dce_accounts_describe.md)	 - describe an account
 * [dce accounts list](dce_accounts_list.md)	 - list accounts
-* [dce accounts login](dce_accounts_login.md)	 - Login to a DCE account
 * [dce accounts remove](dce_accounts_remove.md)	 - Remove one or more accounts from the accounts pool.
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_accounts_add.md b/docs/dce_accounts_add.md
@@ -13,8 +13,10 @@ dce accounts add [flags]
 ### Options
 
 ```
-  -E, --existing string   Bring an existing account into the accounts pool. (WARNING: Account will be nuked.)
-  -h, --help              help for add
+  -a, --account-id string       The ID of the existing account to add to the DCE accounts pool (WARNING: Account will be nuked.)
+  -r, --admin-role-arn string   The admin role arn to be assumed by the DCE master account. Trust policy must be configured with DCE master account as trusted entity.
+  -h, --help                    help for add
+  -n, --new                     Create a new account rather than specifying an exiting one.
 ```
 
 ### Options inherited from parent commands
@@ -27,4 +29,4 @@ dce accounts add [flags]
 
 * [dce accounts](dce_accounts.md)	 - Manage dce accounts
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_accounts_describe.md b/docs/dce_accounts_describe.md
@@ -26,4 +26,4 @@ dce accounts describe [flags]
 
 * [dce accounts](dce_accounts.md)	 - Manage dce accounts
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_accounts_list.md b/docs/dce_accounts_list.md
@@ -26,4 +26,4 @@ dce accounts list [flags]
 
 * [dce accounts](dce_accounts.md)	 - Manage dce accounts
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_accounts_remove.md b/docs/dce_accounts_remove.md
@@ -13,7 +13,8 @@ dce accounts remove [flags]
 ### Options
 
 ```
-  -h, --help   help for remove
+  -a, --account-id string   The ID of the account to remove from the accounts pool.
+  -h, --help                help for remove
 ```
 
 ### Options inherited from parent commands
@@ -26,4 +27,4 @@ dce accounts remove [flags]
 
 * [dce accounts](dce_accounts.md)	 - Manage dce accounts
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_auth.md b/docs/dce_auth.md
@@ -0,0 +1,30 @@
+## dce auth
+
+Login to dce
+
+### Synopsis
+
+Login to dce
+
+```
+dce auth [flags]
+```
+
+### Options
+
+```
+  -h, --help                  help for auth
+  -u, --url-override string   Override the DCE login url
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce](dce.md)	 - Disposable Cloud Environment (DCE)
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_init.md b/docs/dce_init.md
@@ -0,0 +1,29 @@
+## dce init
+
+First time DCE cli setup. Creates config file at ~/.dce.yaml
+
+### Synopsis
+
+First time DCE cli setup. Creates config file at ~/.dce.yaml
+
+```
+dce init [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for init
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce](dce.md)	 - Disposable Cloud Environment (DCE)
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_leases.md b/docs/dce_leases.md
@@ -21,9 +21,10 @@ Manage dce leases
 ### SEE ALSO
 
 * [dce](dce.md)	 - Disposable Cloud Environment (DCE)
-* [dce leases add](dce_leases_add.md)	 - Add one or more leases to the leases pool.
+* [dce leases create](dce_leases_create.md)	 - Create a lease.
+* [dce leases describe](dce_leases_describe.md)	 - describe a lease
+* [dce leases end](dce_leases_end.md)	 - Cause a lease to immediately expire
 * [dce leases list](dce_leases_list.md)	 - list leases
-* [dce leases remove](dce_leases_remove.md)	 - Remove one or more leases from the leases pool.
-* [dce leases remove](dce_leases_remove.md)	 - Remove one or more leases from the leases pool.
+* [dce leases login](dce_leases_login.md)	 - Login to a leased DCE account
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_leases_create.md b/docs/dce_leases_create.md
@@ -0,0 +1,33 @@
+## dce leases create
+
+Create a lease.
+
+### Synopsis
+
+Create a lease.
+
+```
+dce leases create [flags]
+```
+
+### Options
+
+```
+  -b, --budget-amount float      The leased accounts budget amount
+  -c, --budget-currency string   The leased accounts budget currency (default "USD")
+  -e, --email stringArray        The email address that budget notifications will be sent to
+  -h, --help                     help for create
+  -p, --principle-id string      Principle ID for the user of the leased account
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce leases](dce_leases.md)	 - Manage dce leases
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_leases_describe.md b/docs/dce_leases_describe.md
@@ -0,0 +1,29 @@
+## dce leases describe
+
+describe a lease
+
+### Synopsis
+
+describe a lease
+
+```
+dce leases describe [flags]
+```
+
+### Options
+
+```
+  -h, --help   help for describe
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce leases](dce_leases.md)	 - Manage dce leases
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_leases_end.md b/docs/dce_leases_end.md
@@ -0,0 +1,31 @@
+## dce leases end
+
+Cause a lease to immediately expire
+
+### Synopsis
+
+Cause a lease to immediately expire
+
+```
+dce leases end [flags]
+```
+
+### Options
+
+```
+  -a, --account-id string     Account ID associated with the lease you wish to end
+  -h, --help                  help for end
+  -p, --principle-id string   Principle ID for the user of the leased account
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce leases](dce_leases.md)	 - Manage dce leases
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_leases_list.md b/docs/dce_leases_list.md
@@ -26,4 +26,4 @@ dce leases list [flags]
 
 * [dce leases](dce_leases.md)	 - Manage dce leases
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_leases_login.md b/docs/dce_leases_login.md
@@ -0,0 +1,32 @@
+## dce leases login
+
+Login to a leased DCE account
+
+### Synopsis
+
+Login to a leased DCE account
+
+```
+dce leases login [flags]
+```
+
+### Options
+
+```
+  -a, --account-id string   Account ID to login to
+  -h, --help                help for login
+  -l, --lease-id string     Lease ID for the account to login to
+  -b, --open-browser        Opens web broswer to AWS console instead of printing credentials
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce leases](dce_leases.md)	 - Manage dce leases
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system.md b/docs/dce_system.md
@@ -21,8 +21,8 @@ Deploy and configure the DCE system
 ### SEE ALSO
 
 * [dce](dce.md)	 - Disposable Cloud Environment (DCE)
-* [dce system init](dce_system_init.md)	 - Initialize a DCE configuration file at the specified location (Defaults to ~/.dce.yaml)
+* [dce system deploy](dce_system_deploy.md)	 - Deploy the DCE system
 * [dce system logs](dce_system_logs.md)	 - View logs
 * [dce system users](dce_system_users.md)	 - Manage users
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_deploy.md b/docs/dce_system_deploy.md
@@ -0,0 +1,31 @@
+## dce system deploy
+
+Deploy the DCE system
+
+### Synopsis
+
+Deploy the DCE system
+
+```
+dce system deploy [flags]
+```
+
+### Options
+
+```
+  -h, --help               help for deploy
+  -n, --namespace string   Set a custom terraform namespace (Optional)
+  -p, --path string        Path to local DCE repo
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $HOME/.dce.yaml)
+```
+
+### SEE ALSO
+
+* [dce system](dce_system.md)	 - Deploy and configure the DCE system
+
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_logs.md b/docs/dce_system_logs.md
@@ -26,4 +26,4 @@ View logs
 * [dce system logs reset](dce_system_logs_reset.md)	 - View reset logs
 * [dce system logs usage](dce_system_logs_usage.md)	 - View usage logs
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_logs_accounts.md b/docs/dce_system_logs_accounts.md
@@ -26,4 +26,4 @@ dce system logs accounts [flags]
 
 * [dce system logs](dce_system_logs.md)	 - View logs
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_logs_leases.md b/docs/dce_system_logs_leases.md
@@ -26,4 +26,4 @@ dce system logs leases [flags]
 
 * [dce system logs](dce_system_logs.md)	 - View logs
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_logs_reset.md b/docs/dce_system_logs_reset.md
@@ -26,4 +26,4 @@ dce system logs reset [flags]
 
 * [dce system logs](dce_system_logs.md)	 - View logs
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_logs_usage.md b/docs/dce_system_logs_usage.md
@@ -26,4 +26,4 @@ dce system logs usage [flags]
 
 * [dce system logs](dce_system_logs.md)	 - View logs
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_users.md b/docs/dce_system_users.md
@@ -24,4 +24,4 @@ Manage users
 * [dce system users add](dce_system_users_add.md)	 - Add users
 * [dce system users remove](dce_system_users_remove.md)	 - Remove users
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_users_add.md b/docs/dce_system_users_add.md
@@ -26,4 +26,4 @@ dce system users add [flags]
 
 * [dce system users](dce_system_users.md)	 - Manage users
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
diff --git a/docs/dce_system_users_remove.md b/docs/dce_system_users_remove.md
@@ -26,4 +26,4 @@ dce system users remove [flags]
 
 * [dce system users](dce_system_users.md)	 - Manage users
 
-###### Auto generated by spf13/cobra on 4-Oct-2019
+###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce accounts describe [flags]

		* [dce accounts](dce_accounts.md) - Manage dce accounts

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce accounts list [flags]

		* [dce accounts](dce_accounts.md) - Manage dce accounts

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce leases list [flags]

		* [dce leases](dce_leases.md) - Manage dce leases

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce system logs accounts [flags]

		* [dce system logs](dce_system_logs.md) - View logs

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce system logs leases [flags]

		* [dce system logs](dce_system_logs.md) - View logs

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce system logs reset [flags]

		* [dce system logs](dce_system_logs.md) - View logs

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce system logs usage [flags]

		* [dce system logs](dce_system_logs.md) - View logs

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce system users add [flags]

		* [dce system users](dce_system_users.md) - Manage users

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ dce system users remove [flags]

		* [dce system users](dce_system_users.md) - Manage users

		###### Auto generated by spf13/cobra on 4-Oct-2019
		###### Auto generated by spf13/cobra on 15-Oct-2019