CyberCoveLLC/threshold
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

step-by-step admin console instructions with videos (#583)

Browse Source 
* docs:  update step-by-step instructions in common workflows and add video placeholders for forthcoming clickthroughs

* docs: Link clickthrough videos to "Getting started > Run and Login" and "Common Workflows" sections

* style: make video a comfortable viewing size and visually distinguish from background

* docs: Fix "frist" typo to "first" under "Manage Scopes"

Co-authored-by: Susmitha Girumala <susmitha@hashicorp.com>
This commit is contained in:
Randall MoreyandSusmitha Girumala authored and GitHub committed 2020-10-09 15:01:51 -07:00
1 parent 5505d9a9ea
commit b1eead187c
6 files changed
+160 -69
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

website/content/docs/common-workflows/manage-identities.mdx
+52 -26
View File
@@ -55,14 +55,17 @@ Auth Method information:
<Tab heading="Admin Console">
Navigate to the generated org, then auth methods and select `new` auth method:
![](/img/manage-id-auth-method-undefined.png)
1. Navigate to an organization, then to auth methods.
1. Choose the **New** button.
1. Fill the auth method details.
1. Choose **Save** and view the auth method edit form page.
Fill in the auth method settings:
![](/img/manage-id-auth-method-setting.png)
See the new auth method for the organization in the auth method panel:
![](/img/manage-id-auth-method-defined.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261000-boundary-clickthrough-manage-identities-create-auth-method.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
@@ -115,16 +118,17 @@ Account information:
<Tab heading="Admin Console">
Navigate to the generated org, then auth methods, the auth method created above, then the accounts tab.
1. Navigate to organizations > auth methods > auth method, then to the **Accounts** tab.
1. Choose the **New** button.
1. Fill the account details.
1. Choose **Save** and view the account edit form page.
Select `new` account:
![](/img/manage-id-acct-undefined.png)
Fill in the account settings:
![](/img/manage-id-acct-settings.png)
See the new account for the password auth method:
![](/img/manage-id-acct-defined.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602260998-boundary-clickthrough-manage-identities-create-account.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
@@ -201,16 +205,31 @@ User information:
<Tab heading="Admin Console">
Navigate to the generated org, then accounts and select `new` account:
![](/img/manage-id-user-undefined.png)
1. Navigate to an organization, then to users.
1. Choose the **New** button.
1. Fill the user details.
1. Choose **Save** and view the user edit form page.
Fill in the user settings:
![](/img/manage-id-user-settings.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261002-boundary-clickthrough-manage-identities-create-user.mp4"
/>
</video>
See the new user for the organization in the users panel:
![](/img/manage-id-user-defined.png)
Then associate the user with an account:
Associate the user with the account: this can only be done in the CLI or via Terraform currently.
1. From the user edit form, navigate to the **Accounts** tab.
1. Choose **Add Accounts** from the **Manage** dropdown.
1. Select one or more accounts to associate with the user.
1. Choose the **Add Accounts** button and view the user accounts list.
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602260997-boundary-clickthrough-manage-identities-assign-account-to-user.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
@@ -247,10 +266,17 @@ $ boundary authenticate password -login-name myuser -password supersecure -auth-
<Tab heading="Admin Console">
Navigate to the login page and select the generated org from the organizations dropdown, then enter in your
username and password for your account that you created above:
1. Navigate to the authenticate page.
1. Choose an organization scope with which to authenticate.
1. Fill the credentials.
1. Choose **Authenticate** and view the projects overview for the organization.
![](/img/manage-id-login.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261004-boundary-clickthrough-manage-identities-login.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
website/content/docs/common-workflows/manage-scopes.mdx
+25 -18
View File
@@ -30,11 +30,11 @@ An organization lives in the global scope. In this example, we're going to creat
```bash
$ boundary scopes create -scope-id global -name my_org -description 'My frist org'
$ boundary scopes create -scope-id global -name my_org -description 'My first org'
Scope information:
Created Time: Tue, 29 Sep 2020 05:48:22 PDT
Description: My frist org
Description: My first org
ID: o_y0fEd8iY2J
Name: my_org
Updated Time: Tue, 29 Sep 2020 05:48:22 PDT
@@ -50,14 +50,17 @@ Scope information:
<Tab heading="Admin Console">
Navigate to the main boundary landing page and choose `new` organization:
![](/img/manage-scopes-org-undefined.png)
1. Navigate to the Boundary landing page.
1. Choose the **New** button.
1. Fill organization details.
1. Choose **Save** and view the organization on the Boundary landing page.
Fill in the orgnaization details:
![](/img/manage-scopes-org-settings.png)
Click save and view the org in the main Boundary landing page:
![](/img/manage-scopes-org-defined.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602266941-boundary-clickthrough-manage-scopes-create-org.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
@@ -85,11 +88,11 @@ Next, we're going to add a project scope to our organization. Again, we're going
```bash
$ boundary scopes create -scope-id o_0MkQUfE9jA -name my_project -description 'My frist project'
$ boundary scopes create -scope-id o_0MkQUfE9jA -name my_project -description 'My first project'
Scope information:
Created Time: Tue, 29 Sep 2020 05:57:45 PDT
Description: My frist project
Description: My first project
ID: p_jqCwqjSTQ4
Name: my_project
Updated Time: Tue, 29 Sep 2020 05:57:45 PDT
@@ -106,14 +109,18 @@ Scope information:
<Tab heading="Admin Console">
Navigate to your org in the UI and click `new` project:
![](/img/manage-scopes-project-undefined.png)
1. Navigate to an organization, which leads to an overview of projects within that organization.
1. Choose the **New** button.
1. Fill project details.
1. Choose **Save** and view the project edit form page.
1. _Note_: by default, edit forms are disabled to help prevent unintended edits. To edit your new project choose **Edit Form**.
Add the project settings:
![](/img/manage-scopes-project-settings.png)
View the newly created project:
![](/img/manage-scopes-project-defined.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602267080-boundary-clickthrough-manage-scopes-create-project.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
website/content/docs/common-workflows/manage-sessions.mdx
+13
View File
@@ -126,6 +126,19 @@ Session information:
Boundary then cancels the session and move it into a "Terminated" state.
### Canceling a Session via the Admin Console
1. Navigate to a project, then to sessions.
1. Choose a session and its **Cancel** button.
1. View the session status update from _canceling_ to _terminated_.
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261010-boundary-clickthrough-manage-sessions-cancel-session.mp4"
/>
</video>
## Advanced Session Establishment
Above we discussed connecting to a target using the `boundary connect` command. In addition to this we can create a session to a target and connect to that session in separate steps. This is accomplished using the `boundary targets authorize-session` command, which generates a authorization token that users can use to start a session via `boundary proxy` at their own convenience.
website/content/docs/common-workflows/manage-targets.mdx
+55 -24
View File
@@ -55,17 +55,17 @@ Host information:
<Tab heading="Admin Console">
Navigate to the default host catalog:
![](/img/manage-targets-host-undefined.png)
1. Navigate to a host catalog (Projects > Project > Host Catalogs > Host Catalog).
1. Choose **New Host** from the **Manage** dropdown.
1. Fill host details.
1. Choose **Save** and view the host edit form page.
Select new host from the `manage` dropdown:
![](/img/manage-targets-new-host.png)
Fill in the required information about our postgres host:
![](/img/manage-targets-new-host-2.png)
View the host in the catalog:
![](/img/manage-targets-new-host-defined.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602267180-boundary-clickthrough-manage-targets-create-host.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
@@ -119,14 +119,31 @@ Host Set information:
<Tab heading="Admin Console">
Navigate to the host catalog and the `host sets` tab, select `Create Host Set` from `manage` dropdown:
![](/img/manage-targets-new-host-set-undefined.png)
1. Navigate to a host catalog, then to the **Host Sets** tab.
1. Choose **Create Host Set** from the **Manage** dropdown.
1. Fill host set details.
1. Choose **Save** and view the host set edit form page.
Fill in the host-set definition:
![](/img/manage-targets-new-host-set-settings.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602267118-boundary-clickthrough-manage-targets-create-host-set.mp4"
/>
</video>
See the new host set in the host-catalog view:
![](/img/manage-targets-new-host-set-defined.png)
Then associate the host set with a host:
1. From the host set edit form, navigate to the **Hosts** tab.
1. Choose **Add Hosts** from the **Manage** dropdown.
1. Select one or more hosts to associate with the host set.
1. Choose the **Add Hosts** button and view the hosts list.
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261013-boundary-clickthrough-manage-targets-assign-host-to-host-set.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
@@ -183,17 +200,31 @@ Target information:
<Tab heading="Admin Console">
Navigate to your the default project:
![](/img/manage-targets-new-target-project.png)
1. Navigate to a project, then to targets.
1. Choose the **New** button.
1. Fill the target details.
1. Choose **Save** and view the host set edit form page.
Then the targets view and choose `new` target:
![](/img/manage-targets-new-target-undefined.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261018-boundary-clickthrough-manage-targets-create-target.mp4"
/>
</video>
Fill in the Target info:
![](/img/manage-targets-new-target-settings.png)
Then associate the host set with a host:
See the Target in the targets view:
![](/img/manage-targets-new-target-defined.png)
1. From the target edit form, navigate to the **Host Sets** tab.
1. Choose **Add Host Sets** from the **Manage** dropdown.
1. Select one or more host sets to associate with the target.
1. Choose the **Add Host Sets** button and view the host sets list.
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602261011-boundary-clickthrough-manage-targets-assign-host-set-to-target.mp4"
/>
</video>
</Tab>
<Tab heading="Terraform">
website/content/docs/getting-started/run-and-login.mdx
+6 -1
View File
@@ -33,7 +33,12 @@ To authenticate to the Admin UI, open
[http://127.0.0.1:9200](http://127.0.0.1:9200) in a browser and enter the login
name and password:
![](/img/login-dev-mode.png)
<video muted playsInline autoPlay loop class="boundary-clickthrough-video">
<source
type="video/mp4"
src="https://www.datocms-assets.com/2885/1602260993-boundary-clickthrough-getting-started-run-and-login.mp4"
/>
</video>
You can also use these overrides to configure the [Terraform provider for
Boundary](https://github.com/hashicorp/terraform-provider-boundary):
website/pages/style.css
+9
View File
@@ -182,3 +182,12 @@
}
}
}
.boundary-clickthrough-video {
display: block;
width: 100%;
max-width: 500px;
margin: 0 auto 3rem auto;
border-radius: 3px;
box-shadow: 0 14.3254px 14.3254px rgba(37, 41, 55, 0.16);
}