diff --git a/website/content/docs/concepts/domain-model/accounts.mdx b/website/content/docs/concepts/domain-model/accounts.mdx index f9d50aa4e..fa1c35411 100644 --- a/website/content/docs/concepts/domain-model/accounts.mdx +++ b/website/content/docs/concepts/domain-model/accounts.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Domain Model - Action -sidebar_title: Actions +page_title: Domain Model - Accounts +sidebar_title: Accounts description: |- - The annatomy of a Boundary account + The anatomy of a Boundary account --- -# Action +# Accounts A Boundary account is a resource that contains the login name and password for the password authentication method. diff --git a/website/content/docs/concepts/domain-model/actions.mdx b/website/content/docs/concepts/domain-model/actions.mdx index bf4ddf0c3..d9fa63ceb 100644 --- a/website/content/docs/concepts/domain-model/actions.mdx +++ b/website/content/docs/concepts/domain-model/actions.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Actions sidebar_title: Actions description: |- - The annatomy of a Boundary action + The anatomy of a Boundary action --- -# Action +# Actions An action is a defined capability within the Boundary system. Each Resource Type defines its own set of Actions. diff --git a/website/content/docs/concepts/domain-model/auth-methods.mdx b/website/content/docs/concepts/domain-model/auth-methods.mdx index 4f94f0c3b..fb9385d99 100644 --- a/website/content/docs/concepts/domain-model/auth-methods.mdx +++ b/website/content/docs/concepts/domain-model/auth-methods.mdx @@ -1,9 +1,9 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Authentication Methods sidebar_title: Authentication Methods description: |- - How to configure Boundary authentication methods + The anatomy of a Boundary authentication method --- # Authentication Methods diff --git a/website/content/docs/concepts/domain-model/grants.mdx b/website/content/docs/concepts/domain-model/grants.mdx index d8865f067..64d5d8950 100644 --- a/website/content/docs/concepts/domain-model/grants.mdx +++ b/website/content/docs/concepts/domain-model/grants.mdx @@ -1,14 +1,14 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Grants sidebar_title: Grants description: |- - How to configure Boundary grants + The anatomy of a Boundary grant --- # Grants -A grant represents a set of capabilities granted to a roley. +A grant represents a set of capabilities granted to a role. It couples a set of Actions to either a set of Resource Types or an individual Resource. diff --git a/website/content/docs/concepts/domain-model/groups.mdx b/website/content/docs/concepts/domain-model/groups.mdx index d05103dc2..ba435e847 100644 --- a/website/content/docs/concepts/domain-model/groups.mdx +++ b/website/content/docs/concepts/domain-model/groups.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Groups sidebar_title: Groups description: |- - How to configure a Boundary group + The anatomy of a Boundary group --- -# Group +# Groups Groups are collections of Users used only for access control purposes. A Group is owned by one and only one Scope. diff --git a/website/content/docs/concepts/domain-model/host-catalogs.mdx b/website/content/docs/concepts/domain-model/host-catalogs.mdx index 07cca6074..bbdd3ee7a 100644 --- a/website/content/docs/concepts/domain-model/host-catalogs.mdx +++ b/website/content/docs/concepts/domain-model/host-catalogs.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Host Catalogs sidebar_title: Host Catalogs description: |- - The annatomy of a Boundary host catalog + The anatomy of a Boundary host catalog --- -# Host Catalog +# Host Catalogs A host catalog is a permission boundary modeled as a container. A Host Catalog can contain Scopes forming a tree. diff --git a/website/content/docs/concepts/domain-model/host-sets.mdx b/website/content/docs/concepts/domain-model/host-sets.mdx index bccbd9639..d233f802d 100644 --- a/website/content/docs/concepts/domain-model/host-sets.mdx +++ b/website/content/docs/concepts/domain-model/host-sets.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Host Sets sidebar_title: Host Sets description: |- - The annatomy of a Boundary host set + The anatomy of a Boundary host set --- -# Host Set +# Host Sets A host set is a resource which provides a subset of Hosts diff --git a/website/content/docs/concepts/domain-model/hosts.mdx b/website/content/docs/concepts/domain-model/hosts.mdx index 01ef499f3..5ef8891ab 100644 --- a/website/content/docs/concepts/domain-model/hosts.mdx +++ b/website/content/docs/concepts/domain-model/hosts.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Hosts sidebar_title: Hosts description: |- - The annatomy of a Boundary host + The anatomy of a Boundary host --- -# Host +# Hosts A host is a computing element with a network address reachable from Boundary. A Host belongs to one and only one Host Catalog. diff --git a/website/content/docs/concepts/domain-model/index.mdx b/website/content/docs/concepts/domain-model/index.mdx index db717609d..ef4de1cd5 100644 --- a/website/content/docs/concepts/domain-model/index.mdx +++ b/website/content/docs/concepts/domain-model/index.mdx @@ -8,6 +8,8 @@ description: |- # Overview +![](/img/boundary-domain-model-overview.jpg) + Boundary has a rich domain model consisting of resources that represent IAM principals, diff --git a/website/content/docs/concepts/domain-model/organizations.mdx b/website/content/docs/concepts/domain-model/organizations.mdx index 437441759..d83bbbbba 100644 --- a/website/content/docs/concepts/domain-model/organizations.mdx +++ b/website/content/docs/concepts/domain-model/organizations.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Organizations sidebar_title: Organizations description: |- - The annatomy of a Boundary organization + The anatomy of a Boundary organization --- -# Organization +# Organizations An Organization is a top-level container, and owns zero to many Projects diff --git a/website/content/docs/concepts/domain-model/principals.mdx b/website/content/docs/concepts/domain-model/principals.mdx index 8260f4a99..de2c8e7d4 100644 --- a/website/content/docs/concepts/domain-model/principals.mdx +++ b/website/content/docs/concepts/domain-model/principals.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Principals sidebar_title: Principals description: |- - The annatomy of a Boundary principal + The anatomy of a Boundary principal --- -# Principal +# Principals A principal is any entity which can be assigned capabilities. Principal is abstract. diff --git a/website/content/docs/concepts/domain-model/projects.mdx b/website/content/docs/concepts/domain-model/projects.mdx index e7a01a536..5f5a72446 100644 --- a/website/content/docs/concepts/domain-model/projects.mdx +++ b/website/content/docs/concepts/domain-model/projects.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Projects sidebar_title: Projects description: |- - How to configure Boundary projects + The anatomy of a Boundary project --- -# Project +# Projects A project is a child scope of an organization and is owned by an Organization. diff --git a/website/content/docs/concepts/domain-model/resources.mdx b/website/content/docs/concepts/domain-model/resources.mdx index 76f5c74c9..f905df600 100644 --- a/website/content/docs/concepts/domain-model/resources.mdx +++ b/website/content/docs/concepts/domain-model/resources.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Resources sidebar_title: Resources description: |- - The annatomy of a Boundary resource + The anatomy of a Boundary resource --- -# Resource +# Resources A resource is an instance of one of the Resource Types. Resource is abstract. diff --git a/website/content/docs/concepts/domain-model/roles.mdx b/website/content/docs/concepts/domain-model/roles.mdx index 3a3a541e7..a4f908a61 100644 --- a/website/content/docs/concepts/domain-model/roles.mdx +++ b/website/content/docs/concepts/domain-model/roles.mdx @@ -1,9 +1,9 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Roles sidebar_title: Roles description: |- - How to configure Boundary roles + The anatomy of a Boundary role --- # Roles @@ -39,7 +39,7 @@ A role can have zero or more users associated with it. ### Groups -A role can have zero or more groups assocaited with it. +A role can have zero or more groups associated with it. ### Grants diff --git a/website/content/docs/concepts/domain-model/scopes.mdx b/website/content/docs/concepts/domain-model/scopes.mdx index 192a1bbc2..16d46d214 100644 --- a/website/content/docs/concepts/domain-model/scopes.mdx +++ b/website/content/docs/concepts/domain-model/scopes.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Scopes sidebar_title: Scopes description: |- - The annatomy of a Boundary scope + The anatomy of a Boundary scope --- -# Scope +# Scopes A scope is a permission boundary modeled as a container. A Scope can contain Scopes forming a tree. diff --git a/website/content/docs/concepts/domain-model/sessions.mdx b/website/content/docs/concepts/domain-model/sessions.mdx new file mode 100644 index 000000000..306eec52b --- /dev/null +++ b/website/content/docs/concepts/domain-model/sessions.mdx @@ -0,0 +1,9 @@ +--- +layout: docs +page_title: Domain Model - Sessions +sidebar_title: Sessions +description: |- + The anatomy of a Boundary session +--- + +# Sessions diff --git a/website/content/docs/concepts/domain-model/targets.mdx b/website/content/docs/concepts/domain-model/targets.mdx index 757c7198c..49dd72c05 100644 --- a/website/content/docs/concepts/domain-model/targets.mdx +++ b/website/content/docs/concepts/domain-model/targets.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Targets sidebar_title: Targets description: |- - The annatomy of a Boundary target + The anatomy of a Boundary target --- -# Target +# Targets A target is a networked service a User can connect to diff --git a/website/content/docs/concepts/domain-model/users.mdx b/website/content/docs/concepts/domain-model/users.mdx index d115d3ea1..1964625fd 100644 --- a/website/content/docs/concepts/domain-model/users.mdx +++ b/website/content/docs/concepts/domain-model/users.mdx @@ -1,12 +1,12 @@ --- layout: docs -page_title: Configuration +page_title: Domain Model - Users sidebar_title: Users description: |- - How to configure a Boundary user + The anatomy of a Boundary user --- -# User +# Users A user is any entity authorized to access Boundary using authentication credentials specific to one of the configured Authentication Methods. diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index c426f8764..a4fd1571d 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -35,10 +35,7 @@ export default [ }, { category: 'security', - content: [ - 'permissions-model', - 'tls', - ] + content: ['permissions-model', 'tls'], }, { category: 'domain-model', @@ -56,6 +53,7 @@ export default [ 'projects', 'resources', 'scopes', + 'sessions', 'targets', 'roles', 'users', diff --git a/website/public/img/boundary-domain-model-overview.jpg b/website/public/img/boundary-domain-model-overview.jpg new file mode 100644 index 000000000..ce41a22e5 Binary files /dev/null and b/website/public/img/boundary-domain-model-overview.jpg differ