diff --git a/website/content/docs/common-workflows/manage-scopes.mdx b/website/content/docs/common-workflows/manage-scopes.mdx index 6b0b364840..0e299fa817 100644 --- a/website/content/docs/common-workflows/manage-scopes.mdx +++ b/website/content/docs/common-workflows/manage-scopes.mdx @@ -17,8 +17,8 @@ Some resources can only be associated with a specific level of scope. Targets fo In this example, we're going to create two scopes, a project and an organization. -~> Note that all resource ID's in this example are illustration only - ID's are uniquely generated for every resource upon creation with the exception being -generated resources in `dev mode`. Please make sure to use the resource ID's that are generated when running this example. For example, if you run +~> All resource ID's in this example are illustration only - ID's are uniquely generated for every resource upon creation with the exception being +generated resources in `dev` mode. Please make sure to use the resource ID's that are generated when running this example. For example, if you run `boundary users create`, use the resource ID of the user seen in stdout, not the ID in the example command. ## Create a Organization @@ -62,7 +62,6 @@ Click save and view the org in the main Boundary landing page: - ```hcl resource "boundary_scope" "org" { scope_id = "global" @@ -75,7 +74,6 @@ resource "boundary_scope" "org" { - ## Create a Project Next, we're going to add a project scope to our organization. Again, we're going to opt for automated role creation to simplify management of this scope. @@ -83,7 +81,6 @@ 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' @@ -105,7 +102,6 @@ Scope information: - Navigate to your org in the UI and click `new` project: ![](/img/manage-scopes-project-undefined.png) @@ -118,7 +114,6 @@ View the newly created project: - ```hcl resource "boundary_scope" "project" { name = "my_project" @@ -131,5 +126,4 @@ resource "boundary_scope" "project" { ``` - - + \ No newline at end of file diff --git a/website/content/docs/common-workflows/manage-sessions.mdx b/website/content/docs/common-workflows/manage-sessions.mdx index a6ff349387..d77ebcff68 100644 --- a/website/content/docs/common-workflows/manage-sessions.mdx +++ b/website/content/docs/common-workflows/manage-sessions.mdx @@ -17,49 +17,45 @@ We assume you're running Boundary in dev mode and have a default target of `ttcp For this example, we're going to authorize that you are able to connect to a target which results in an Authorization Token being returned which can be used to connect to the session through the proxy. - - + - ```bash - $ boundary targets authorize -id ttcp_1234567890 - - Target information: - Authorization Token: $LONG_STRING_OF_TEXT - Created Time: 2020-09-30T15:18:14-07:00 - Host ID: hst_1234567890 - Scope ID: p_1234567890 - Session ID: s_h7vBIhH5SZ - Target ID: ttcp_1234567890 - Type: tcp - User ID: u_1234567890 - ``` +```bash +$ boundary targets authorize -id ttcp_1234567890 + +Target information: + Authorization Token: $LONG_STRING_OF_TEXT + Created Time: 2020-09-30T15:18:14-07:00 + Host ID: hst_1234567890 + Scope ID: p_1234567890 + Session ID: s_h7vBIhH5SZ + Target ID: ttcp_1234567890 + Type: tcp + User ID: u_1234567890 +``` - - + -#> Note: You can also provide a -host-id flag in the request above which ensures connecting using the provided Authorization Token will connect you to this specific host. +~> You can also provide a -host-id flag in the request above to connect to a specific host. The chosen host must be contained in one of the host sets associated with the target. ## Connect to the session Once we have received an Authorization Token a Boundary session has been created and is waiting to proxy connection to the target. We'll now connect our local proxy to the Boundary deployment. - - + - ```bash - $ boundary proxy -authz $LONG_STRING_OF_TEXT - - Proxy listening information: - Address: 127.0.0.1 - Connection Limit: 1 - Expiration: Wed, 30 Sep 2020 23:18:14 MST - Port: 61991 - Protocol: tcp - Session ID: s_h7vBIhH5SZ - ``` +```bash +$ boundary proxy -authz $LONG_STRING_OF_TEXT + +Proxy listening information: + Address: 127.0.0.1 + Connection Limit: 1 + Expiration: Wed, 30 Sep 2020 23:18:14 MST + Port: 61991 + Protocol: tcp + Session ID: s_h7vBIhH5SZ +``` - - + With the above address and port information we can now connect to our local proxy and have our tcp traffic sent through the boundary system. @@ -74,112 +70,106 @@ For SSH connections we'll likely receive a notice that the authenticity of the h Beyond establishing sessions we can also view and cancel sessions. Here we'll view all sessions that have recently happened in the project scope that are default target is in. - - - - ```bash - $ boundary sessions list -scope-id p_1234567890 + - Session information: - ID: s_h7vBIhH5SZ - Status: active - Created Time: 2020-09-30T15:18:14-07:00 - Expiration Time: 2020-09-30T23:18:14-07:00 - Updated Time: 2020-09-30T15:18:35-07:00 - User ID: u_1234567890 - Target ID: ttcp_1234567890 - ``` +```bash +$ boundary sessions list -scope-id p_1234567890 + +Session information: + ID: s_h7vBIhH5SZ + Status: active + Created Time: 2020-09-30T15:18:14-07:00 + Expiration Time: 2020-09-30T23:18:14-07:00 + Updated Time: 2020-09-30T15:18:35-07:00 + User ID: u_1234567890 + Target ID: ttcp_1234567890 +``` - - + We can get a more detailed view of this specific session by reading it. - - - - ```bash - $ boundary sessions read -id s_h7vBIhH5SZ - - Session information: - Auth Token ID: at_51XQGx0bzk - Created Time: Wed, 30 Sep 2020 15:18:14 MST - Endpoint: tcp://localhost:22 - Expiration Time: 2020-09-30T23:18:14-07:00 - Host ID: hst_1234567890 - Host Set ID: hsst_1234567890 - ID: s_h7vBIhH5SZ - Status: active - Target ID: ttcp_1234567890 - Type: tcp - Updated Time: 2020-09-30T15:18:35-07:00 - User ID: u_1234567890 - Version: 2 - - Scope: - ID: p_1234567890 - Name: Generated project scope - Parent Scope ID: o_1234567890 - Type: project - - States: - Start Time: Wed, 30 Sep 2020 15:18:35 MST - Status: active - - End Time: Wed, 30 Sep 2020 15:18:35 MST - Start Time: Wed, 30 Sep 2020 15:18:14 MST - Status: pending - - ``` - - - + + +```bash +$ boundary sessions read -id s_h7vBIhH5SZ + +Session information: + Auth Token ID: at_51XQGx0bzk + Created Time: Wed, 30 Sep 2020 15:18:14 MST + Endpoint: tcp://localhost:22 + Expiration Time: 2020-09-30T23:18:14-07:00 + Host ID: hst_1234567890 + Host Set ID: hsst_1234567890 + ID: s_h7vBIhH5SZ + Status: active + Target ID: ttcp_1234567890 + Type: tcp + Updated Time: 2020-09-30T15:18:35-07:00 + User ID: u_1234567890 + Version: 2 + + Scope: + ID: p_1234567890 + Name: Generated project scope + Parent Scope ID: o_1234567890 + Type: project + + States: + Start Time: Wed, 30 Sep 2020 15:18:35 MST + Status: active + + End Time: Wed, 30 Sep 2020 15:18:35 MST + Start Time: Wed, 30 Sep 2020 15:18:14 MST + Status: pending + +``` + + ## Cancelling Sessions To shut down a session the person initiating the connection can disconnect all connections or a request can be sent to Boundary to cancel a specific session. - - - - ```bash - $ boundary sessions cancel -id s_h7vBIhH5SZ - - Session information: - Auth Token ID: at_51XQGx0bzk - Created Time: Wed, 30 Sep 2020 15:18:14 MST - Endpoint: tcp://localhost:22 - Expiration Time: 2020-09-30T23:18:14-07:00 - Host ID: hst_1234567890 - Host Set ID: hsst_1234567890 - ID: s_h7vBIhH5SZ - Status: canceling - Target ID: ttcp_1234567890 - Type: tcp - Updated Time: 2020-09-30T15:19:17-07:00 - User ID: u_1234567890 - Version: 3 - - Scope: - ID: p_1234567890 - Name: Generated project scope - Parent Scope ID: o_1234567890 - Type: project - - States: - Start Time: Wed, 30 Sep 2020 15:19:17 MST - Status: canceling - - End Time: Wed, 30 Sep 2020 15:19:17 MST - Start Time: Wed, 30 Sep 2020 15:18:35 MST - Status: active - - End Time: Wed, 30 Sep 2020 15:18:35 MST - Start Time: Wed, 30 Sep 2020 15:18:14 MST - Status: pending - ``` - - - + + +```bash +$ boundary sessions cancel -id s_h7vBIhH5SZ + +Session information: + Auth Token ID: at_51XQGx0bzk + Created Time: Wed, 30 Sep 2020 15:18:14 MST + Endpoint: tcp://localhost:22 + Expiration Time: 2020-09-30T23:18:14-07:00 + Host ID: hst_1234567890 + Host Set ID: hsst_1234567890 + ID: s_h7vBIhH5SZ + Status: canceling + Target ID: ttcp_1234567890 + Type: tcp + Updated Time: 2020-09-30T15:19:17-07:00 + User ID: u_1234567890 + Version: 3 + + Scope: + ID: p_1234567890 + Name: Generated project scope + Parent Scope ID: o_1234567890 + Type: project + + States: + Start Time: Wed, 30 Sep 2020 15:19:17 MST + Status: canceling + + End Time: Wed, 30 Sep 2020 15:19:17 MST + Start Time: Wed, 30 Sep 2020 15:18:35 MST + Status: active + + End Time: Wed, 30 Sep 2020 15:18:35 MST + Start Time: Wed, 30 Sep 2020 15:18:14 MST + Status: pending +``` + + Boundary will then cancel the session and move it into a "Terminated" state.