Docs: add domain model diagram and update meta data in domain model pages (#611)

* Docs: add domain model diagram * Docs: fix meta data in domain model pages * Docs: add Sessions to domain model
2020-10-10 16:40:06 -04:00
1 parent 4da9c7081d
commit 1ac3660dca
@@ -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.
@@ -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.
@@ -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
@@ -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.
@@ -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.
@@ -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.
@@ -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
@@ -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.
@@ -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,
@@ -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
@@ -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.
@@ -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.
@@ -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.
@@ -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

@@ -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.
@@ -0,0 +1,9 @@
+---
+layout: docs
+page_title: Domain Model - Sessions
+sidebar_title: Sessions
+description: |-
+  The anatomy of a Boundary session
+---
+
+# Sessions
@@ -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
@@ -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.
@@ -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',