This repository was archived by the owner on Dec 4, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 574
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #141 from IrmantasM/master
Adding missing pages
- Loading branch information
Showing
2 changed files
with
107 additions
and
2 deletions.
There are no files selected for viewing
This file contains 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 |
|---|---|---|
| @@ -1,6 +1,55 @@ | ||
| --- | ||
| layout: docs | ||
| chapter: Reference | ||
| chapter: Reference - CLI | ||
| title: target | ||
| permalink: /docs/reference/cli/target/ | ||
| --- | ||
|
|
||
| [Back to CLI Commands](/adop-docker-compose/docs/reference/cli/) | ||
|
|
||
| ## Command | ||
|
|
||
| `./adop target <subcommand>` | ||
|
|
||
| Used for setting up environment variables to connect with ADOP stack. | ||
|
|
||
| ## Subcommands | ||
|
|
||
| ### set | ||
|
|
||
| <table style="font-size:12px"> | ||
| <tr> <!-- Splitter --> | ||
| <th>Subcommand</th> | ||
| <th></th> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">set [<options>]</td> | ||
| <td>Sets the environment variables to point to ADOP stack.</td> | ||
| </tr> | ||
| <tr> <!-- Splitter --> | ||
| <th>Option</th> | ||
| <th></th> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">-t [<ENDPOINT>]</td> | ||
| <td>Sets the endpoint URL to connect to ADOP stack, where <b><ENDPOINT></b> the URL to ADOP stack (required) (hint: https://54.77.198.55/).</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">-u [<USERNAME>]</td> | ||
| <td>Sets the username required for authentication with ADOP stack, where <b><USERNAME></b> the username with permissions to access ADOP stack (required).</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">-p [<PASSWORD>]</td> | ||
| <td>Sets the password required for authentication with ADOP stack, where <b><PASSWORD></b> the password with permissions to access ADOP stack (required).</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ### unset | ||
|
|
||
| Unsets the environment variables pointing to ADOP stack. | ||
|
|
||
| ### help | ||
|
|
||
| Prints out help information. | ||
|
|
||
| ## Examples [WIP] |
This file contains 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 |
|---|---|---|
| @@ -1,6 +1,62 @@ | ||
| --- | ||
| layout: docs | ||
| chapter: Command Line Interface | ||
| chapter: Reference - CLI | ||
| title: workspace | ||
| permalink: /docs/reference/cli/workspace/ | ||
| --- | ||
|
|
||
| [Back to CLI Commands](/adop-docker-compose/docs/reference/cli/) | ||
|
|
||
| ## Command | ||
|
|
||
| `./adop workspace [<options>] <subcommand>` | ||
|
|
||
| Used for setting up workspaces to store projects. | ||
|
|
||
| ## Options | ||
|
|
||
| <table style="font-size:12px"> | ||
| <tr> <!-- Splitter --> | ||
| <th>Option</th> | ||
| <th></th> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap"> -w <WORKSPACE_NAME> </td> | ||
| <td>Sets the name for the workspace, where <b><WORKSPACE_NAME></b> is the name of the workspace that you are creating (required).</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Subcommands | ||
|
|
||
| ### create | ||
|
|
||
| <table style="font-size:12px"> | ||
| <tr> <!-- Splitter --> | ||
| <th>Subcommand</th> | ||
| <th></th> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">create [<options>]</td> | ||
| <td>Creates a new workspace in Jenkins.</td> | ||
| </tr> | ||
| <tr> <!-- Splitter --> | ||
| <th>Option</th> | ||
| <th></th> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">-a [<ADMIN_USERS>]</td> | ||
| <td>Sets users with admin permissions on the workspace, where <b><ADMIN_USERS></b> is a comma separated list of users (optional) (default: blank).</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">-d [<DEVELOPER_USERS>]</td> | ||
| <td>Sets users with developer permissions on the workspace, where <b><DEVELOPER_USERS></b> is a comma separated list of users (optional) (default: blank).</td> | ||
| </tr> | ||
| <tr> | ||
| <td style="white-space: nowrap">-v [<VIEWER_USERS>]</td> | ||
| <td>Sets users with viewer (read-only) permissions on the workspace, where <b><VIEWER_USERS></b> is a comma separated list of users (optional) (default: blank).</td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| ## Examples [WIP] | ||
|
|
||
| `./adop workspace -w <WORKSPACE_NAME> create [<options>]` - creates a new workspace in Jenkins. |