Randall MoreyandSusmitha Girumala
b1eead187c
* 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>
143 lines
4.1 KiB
Plaintext
143 lines
4.1 KiB
Plaintext
---
|
|
layout: docs
|
|
page_title: Manage Scopes
|
|
sidebar_title: Manage Scopes
|
|
description: How to manage Boundary scopes
|
|
---
|
|
|
|
# Manage Scopes
|
|
|
|
Scopes are a foundational part of Boundary. They allow users to segregate resources and assign ownership of resources to principals. There are three hierarchies of scopes within Boundary:
|
|
|
|
1. Global
|
|
2. Organization
|
|
3. Project
|
|
|
|
Some resources can only be associated with a specific level of scope. Targets for example can only be project scope. Other resources can be of multiple scopes. For example, users can be both global and organization level scoped. See the [domain model](/docs/concepts/domain-model) for detailed resource specific information.
|
|
|
|
In this example, we're going to create two scopes, a project and an organization.
|
|
|
|
~> 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 an Organization
|
|
|
|
An organization lives in the global scope. In this example, we're going to create an organization. In doing so, we're going to opt for automated role creation during scope generation in order to simplify management of the scope by the user.
|
|
|
|
<Tabs>
|
|
<Tab heading="CLI">
|
|
|
|
|
|
```bash
|
|
$ 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 first org
|
|
ID: o_y0fEd8iY2J
|
|
Name: my_org
|
|
Updated Time: Tue, 29 Sep 2020 05:48:22 PDT
|
|
Version: 1
|
|
|
|
Scope (parent):
|
|
ID: global
|
|
Name: global
|
|
Type: global
|
|
```
|
|
|
|
</Tab>
|
|
<Tab heading="Admin Console">
|
|
|
|
|
|
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.
|
|
|
|
<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">
|
|
|
|
|
|
```hcl
|
|
resource "boundary_scope" "org" {
|
|
scope_id = "global"
|
|
name = "my_org"
|
|
description = "My first org"
|
|
auto_create_role = true
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|
|
|
|
## 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.
|
|
|
|
<Tabs>
|
|
<Tab heading="CLI">
|
|
|
|
|
|
```bash
|
|
$ 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 first project
|
|
ID: p_jqCwqjSTQ4
|
|
Name: my_project
|
|
Updated Time: Tue, 29 Sep 2020 05:57:45 PDT
|
|
Version: 1
|
|
|
|
Scope (parent):
|
|
ID: o_0MkQUfE9jA
|
|
Name: my_org
|
|
Parent Scope ID: global
|
|
Type: org
|
|
```
|
|
|
|
</Tab>
|
|
<Tab heading="Admin Console">
|
|
|
|
|
|
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**.
|
|
|
|
<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">
|
|
|
|
|
|
```hcl
|
|
resource "boundary_scope" "project" {
|
|
name = "my_project"
|
|
description = "My first project"
|
|
|
|
# scope_id is taken from the org resource defined above
|
|
scope_id = boundary_scope.org.id
|
|
auto_create_role = true
|
|
}
|
|
```
|
|
|
|
</Tab>
|
|
</Tabs>
|
|
|