From b340a0f9eeed0f8520d525c8d39e76a6be032dcd Mon Sep 17 00:00:00 2001 From: Michael Gaffney Date: Sat, 10 Oct 2020 17:00:45 -0400 Subject: [PATCH] Docs: remove pages from domain model section (#612) --- .../docs/concepts/domain-model/actions.mdx | 32 ----------- .../docs/concepts/domain-model/grants.mdx | 49 ----------------- .../concepts/domain-model/organizations.mdx | 33 ----------- .../docs/concepts/domain-model/principals.mdx | 17 ------ .../docs/concepts/domain-model/projects.mdx | 55 ------------------- .../docs/concepts/domain-model/resources.mdx | 24 -------- website/data/docs-navigation.js | 6 -- 7 files changed, 216 deletions(-) delete mode 100644 website/content/docs/concepts/domain-model/actions.mdx delete mode 100644 website/content/docs/concepts/domain-model/grants.mdx delete mode 100644 website/content/docs/concepts/domain-model/organizations.mdx delete mode 100644 website/content/docs/concepts/domain-model/principals.mdx delete mode 100644 website/content/docs/concepts/domain-model/projects.mdx delete mode 100644 website/content/docs/concepts/domain-model/resources.mdx diff --git a/website/content/docs/concepts/domain-model/actions.mdx b/website/content/docs/concepts/domain-model/actions.mdx deleted file mode 100644 index d9fa63ceb..000000000 --- a/website/content/docs/concepts/domain-model/actions.mdx +++ /dev/null @@ -1,32 +0,0 @@ ---- -layout: docs -page_title: Domain Model - Actions -sidebar_title: Actions -description: |- - The anatomy of a Boundary action ---- - -# Actions - -An action is a defined capability within the Boundary system. -Each Resource Type defines its own set of Actions. -Currently, the union of actions from all Resource Types is: -create, -read, -update, -delete, -list, -connect. -This is not a fixed list -and no design or implementation should assume it will ever be a fixed list. - -## Attributes - -For information on how actions are constructed into grant strings, -see the [grants]() section. - -## Referenced By - -- [Grant]() -- [Resource]() -- [Role]() diff --git a/website/content/docs/concepts/domain-model/grants.mdx b/website/content/docs/concepts/domain-model/grants.mdx deleted file mode 100644 index 64d5d8950..000000000 --- a/website/content/docs/concepts/domain-model/grants.mdx +++ /dev/null @@ -1,49 +0,0 @@ ---- -layout: docs -page_title: Domain Model - Grants -sidebar_title: Grants -description: |- - The anatomy of a Boundary grant ---- - -# Grants - -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. -A Direct Grant belongs exclusively to one and only one Role. -However, equivalent Direct Grants may exist across different Roles. -A Direct Grant references one or more Actions -and either one or more Resource types -or one specific Resource. -A Direct Grant is deleted when the Role it belongs to is deleted. -A Direct Grant is also deleted if it is associated with a specific Resource -and that Resource itself is deleted. -The lifecycle of a Direct Grant is not tied to the lifecycle of any Action or Resource Type. - -```shell-session -+----------------------------------------+ -| Organization | -+--------------------+-------------------+ -| Role 1 | Role 2 | -+----------+-----------------------------+ -| Grant 1 | Grant 2 | Grant 1 | -+----------+---------+-------------------+ -``` - -## Attributes - -Direct grants are represented by strings of actions on resources. - -Example: `id=p_0123456789; action=read` - -The above example grants `read` action on the `p_0123456789` project resource. - -The glob `*` pattern can be used on IDs and actions as well: -`id=*;action=*`, will allow all actions on all resources. - -## Referenced By - -- [Action]() -- [Role]() diff --git a/website/content/docs/concepts/domain-model/organizations.mdx b/website/content/docs/concepts/domain-model/organizations.mdx deleted file mode 100644 index d83bbbbba..000000000 --- a/website/content/docs/concepts/domain-model/organizations.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -layout: docs -page_title: Domain Model - Organizations -sidebar_title: Organizations -description: |- - The anatomy of a Boundary organization ---- - -# Organizations - -An Organization is a top-level container, -and owns zero to many Projects -and zero to many Authentication Methods. -An Organization inherits from Scope ("is-a" Scope) -allowing it to own zero to many -Groups, -Roles, -Policies, -Targets, -Host Catalogs -or Credential Stores. -When an Organization is deleted, -all resources owned by it are also deleted. -The lifecycle of an Organization is not tied to anything else. -A Role at the Organization level can grant permissions at the Project level. - -# Attributes - -### ID - -An organization ID is the character sequence `o_` followed by ten digits. - -Example: `o_0123456789` diff --git a/website/content/docs/concepts/domain-model/principals.mdx b/website/content/docs/concepts/domain-model/principals.mdx deleted file mode 100644 index de2c8e7d4..000000000 --- a/website/content/docs/concepts/domain-model/principals.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: docs -page_title: Domain Model - Principals -sidebar_title: Principals -description: |- - The anatomy of a Boundary principal ---- - -# Principals - -A principal is any entity which can be assigned capabilities. -Principal is abstract. -User, -Group, -and Project -are concrete Principals. -A Principal can be assigned to zero or more Roles. diff --git a/website/content/docs/concepts/domain-model/projects.mdx b/website/content/docs/concepts/domain-model/projects.mdx deleted file mode 100644 index 5f5a72446..000000000 --- a/website/content/docs/concepts/domain-model/projects.mdx +++ /dev/null @@ -1,55 +0,0 @@ ---- -layout: docs -page_title: Domain Model - Projects -sidebar_title: Projects -description: |- - The anatomy of a Boundary project ---- - -# Projects - -A project is a child scope of an organization -and is owned by an Organization. -A Project inherits from Scope ("is-a" Scope) -allowing it to own zero to many -Groups, -Roles, -Policies, -Targets, -Host Catalogs -or Credential Stores. -A Project also inherits from Principal ("is-a" Principal) -allowing it to be associated with zero or more Roles. -A Project has no additional relationships beyond those defined in Scope and Principal. -A Project is deleted when the Organization it belongs to is deleted. -When a Project is deleted, -all resources owned by it are also deleted. -The lifecycle of a Project is not tied to any resource it contains. - -```shell-session -+-----------------------------------+ -| Organization | -+-----------------------------------+ -| Project 1 | Project 2 | Project 3 | -+-----------------------------------+ -``` - -# Attributes - -### ID - -A project ID is the character `p_` followed by ten digits. - -Example: `p_0123456789` - -### Name - -A project name is the friendly name set by the user of a project. - -### Description - -A project description is the friendly description set by the user. - -# Referenced By - -- [Organization]() diff --git a/website/content/docs/concepts/domain-model/resources.mdx b/website/content/docs/concepts/domain-model/resources.mdx deleted file mode 100644 index f905df600..000000000 --- a/website/content/docs/concepts/domain-model/resources.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: docs -page_title: Domain Model - Resources -sidebar_title: Resources -description: |- - The anatomy of a Boundary resource ---- - -# Resources - -A resource is an instance of one of the Resource Types. -Resource is abstract. -A Resource can be associated with zero or more Direct Grants. -A resource can be any one of the following: -organization, -project, -authentication-method, -group, -role, -target, -host-catalog, -host-set, -credential-catalog, -credential-set. diff --git a/website/data/docs-navigation.js b/website/data/docs-navigation.js index a4fd1571d..3d3925097 100644 --- a/website/data/docs-navigation.js +++ b/website/data/docs-navigation.js @@ -41,17 +41,11 @@ export default [ category: 'domain-model', content: [ 'accounts', - 'actions', 'auth-methods', - 'grants', 'groups', 'hosts', 'host-catalogs', 'host-sets', - 'organizations', - 'principals', - 'projects', - 'resources', 'scopes', 'sessions', 'targets',