The name. The name. The name!
This commit is contained in:
1 parent
1c836c430b
commit
6661117d4c
321 files changed
+1295
-1300
No files matched your search
+2
-2
@@ -1,8 +1,8 @@
|
||||
# Watchtower Documentation Website
|
||||
# Boundary Documentation Website
|
||||
|
||||
[](https://app.netlify.com/sites/<NETLIFY-SLUG>/deploys)
|
||||
|
||||
This subdirectory contains the entire source for the [Watchtower Website](https://example.com/). This is a [NextJS](https://nextjs.org/) project, which builds a static site from these source files.
|
||||
This subdirectory contains the entire source for the [Boundary Website](https://example.com/). This is a [NextJS](https://nextjs.org/) project, which builds a static site from these source files.
|
||||
|
||||
<!--
|
||||
This readme file contains several blocks of generated text, to make it easier to share common information
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
export const productName = 'Watchtower'
|
||||
export const productSlug = 'watchtower'
|
||||
export const productName = 'Boundary'
|
||||
export const productSlug = 'boundary'
|
||||
@@ -6,7 +6,7 @@ import { createMdxProvider } from '@hashicorp/nextjs-scripts/lib/providers/docs'
|
||||
import Head from 'next/head'
|
||||
import Link from 'next/link'
|
||||
|
||||
const MDXProvider = createMdxProvider({ product: 'watchtower' })
|
||||
const MDXProvider = createMdxProvider({ product: 'boundary' })
|
||||
|
||||
function DocsLayoutWrapper(pageMeta) {
|
||||
function DocsLayout(props) {
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Admin Console Index
|
||||
sidebar_title: Admin Console
|
||||
description: |-
|
||||
Reference documentation for the administrative console for Watchtower
|
||||
Reference documentation for the administrative console for Boundary
|
||||
---
|
||||
|
||||
# Administrative Console Overview
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Admin Console
|
||||
sidebar_title: Login/Logout
|
||||
description: |-
|
||||
Watchtower admin console login and logout
|
||||
Boundary admin console login and logout
|
||||
---
|
||||
|
||||
# How to Login and Logout
|
||||
@@ -3,12 +3,12 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Action
|
||||
description: |-
|
||||
The annatomy of a Watchtower action
|
||||
The annatomy of a Boundary action
|
||||
---
|
||||
|
||||
# Action
|
||||
|
||||
An action is a defined capability within the Watchtower 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.
|
||||
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
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Authentication Methods
|
||||
description: |-
|
||||
How to configure Watchtower authentication methods
|
||||
How to configure Boundary authentication methods
|
||||
---
|
||||
|
||||
# Authentication Methods
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Grants
|
||||
description: |-
|
||||
How to configure Watchtower grants
|
||||
How to configure Boundary grants
|
||||
---
|
||||
|
||||
# Grants
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Group
|
||||
description: |-
|
||||
How to configure a Watchtower group
|
||||
How to configure a Boundary group
|
||||
---
|
||||
|
||||
# Group
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Host Catalog
|
||||
description: |-
|
||||
The annatomy of a Watchtower host catalog
|
||||
The annatomy of a Boundary host catalog
|
||||
---
|
||||
|
||||
# Host Catalog
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Host Set
|
||||
description: |-
|
||||
The annatomy of a Watchtower host set
|
||||
The annatomy of a Boundary host set
|
||||
---
|
||||
|
||||
# Host Set
|
||||
|
||||
@@ -3,11 +3,11 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Host
|
||||
description: |-
|
||||
The annatomy of a Watchtower host
|
||||
The annatomy of a Boundary host
|
||||
---
|
||||
|
||||
# Host
|
||||
|
||||
A host is a computing element with a network address reachable from Watchtower. A Host belongs to one and only one Host Catalog. A Host can be contained by zero or more Host Sets. Host is abstract. A Host is deleted when the Host Catalog it belongs to is deleted. The lifecycle of a Host is not tied to the lifecycle of any Host Sets.
|
||||
A host is a computing element with a network address reachable from Boundary. A Host belongs to one and only one Host Catalog. A Host can be contained by zero or more Host Sets. Host is abstract. A Host is deleted when the Host Catalog it belongs to is deleted. The lifecycle of a Host is not tied to the lifecycle of any Host Sets.
|
||||
|
||||
## Attributes
|
||||
@@ -3,9 +3,9 @@ layout: docs
|
||||
page_title: Domain Model Index
|
||||
sidebar_title: Domain Model
|
||||
description: |-
|
||||
Reference documentation for configuring Watchtower
|
||||
Reference documentation for configuring Boundary
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
Users can configure Watchtower via command line, admin console, terraform, or the SDK. This section covers what configuration resources are avaialble, and how they're releated. For details on using a specific method, please see that method's specific documentation.
|
||||
Users can configure Boundary via command line, admin console, terraform, or the SDK. This section covers what configuration resources are avaialble, and how they're releated. For details on using a specific method, please see that method's specific documentation.
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Organization
|
||||
description: |-
|
||||
The annatomy of a Watchtower organization
|
||||
The annatomy of a Boundary organization
|
||||
---
|
||||
|
||||
# Organization
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Principal
|
||||
description: |-
|
||||
The annatomy of a Watchtower principal
|
||||
The annatomy of a Boundary principal
|
||||
---
|
||||
|
||||
# Principal
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Project
|
||||
description: |-
|
||||
How to configure Watchtower projects
|
||||
How to configure Boundary projects
|
||||
---
|
||||
|
||||
# Project
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Resource
|
||||
description: |-
|
||||
The annatomy of a Watchtower resource
|
||||
The annatomy of a Boundary resource
|
||||
---
|
||||
|
||||
# Resource
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Roles
|
||||
description: |-
|
||||
How to configure Watchtower roles
|
||||
How to configure Boundary roles
|
||||
---
|
||||
|
||||
# Roles
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Scope
|
||||
description: |-
|
||||
The annatomy of a Watchtower scope
|
||||
The annatomy of a Boundary scope
|
||||
---
|
||||
|
||||
# Scope
|
||||
|
||||
@@ -3,11 +3,11 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: Target
|
||||
description: |-
|
||||
The annatomy of a Watchtower target
|
||||
The annatomy of a Boundary target
|
||||
---
|
||||
|
||||
# Target
|
||||
|
||||
A target is a networked service a User can connect to and interact with through Watchtower. A Target does not directly contain any secrets. A Target contains a collection of Hosts. A Target belongs to one and only one Scope. A Target can contain zero or more Host Sets. Target is abstract. A Target is deleted when the Scope it belongs to is deleted. The lifecycle of a Target is not tied to the lifecycle of any Host Set.
|
||||
A target is a networked service a User can connect to and interact with through Boundary. A Target does not directly contain any secrets. A Target contains a collection of Hosts. A Target belongs to one and only one Scope. A Target can contain zero or more Host Sets. Target is abstract. A Target is deleted when the Scope it belongs to is deleted. The lifecycle of a Target is not tied to the lifecycle of any Host Set.
|
||||
|
||||
## Attributes
|
||||
@@ -3,12 +3,12 @@ layout: docs
|
||||
page_title: Configuration
|
||||
sidebar_title: User
|
||||
description: |-
|
||||
How to configure a Watchtower user
|
||||
How to configure a Boundary user
|
||||
---
|
||||
|
||||
# User
|
||||
|
||||
A user is any entity authorized to access Watchtower using authentication credentials specific to one of the configured Authentication Methods. A User is owned by one and only one Organization. A User is associated with zero or one Authentication Methods. A User not associated with an Authentication Method can not log in to the system. A User can belong to zero or more Groups. A User inherits from Principal ("is-a" Principal) allowing it to be associated with zero or more Roles. A User is deleted when the Organization it belongs to is deleted. The lifecycle of a User is not tied to the lifecycle of any Authentication Method, Group or Role, but rather to its Organization only
|
||||
A user is any entity authorized to access Boundary using authentication credentials specific to one of the configured Authentication Methods. A User is owned by one and only one Organization. A User is associated with zero or one Authentication Methods. A User not associated with an Authentication Method can not log in to the system. A User can belong to zero or more Groups. A User inherits from Principal ("is-a" Principal) allowing it to be associated with zero or more Roles. A User is deleted when the Organization it belongs to is deleted. The lifecycle of a User is not tied to the lifecycle of any Authentication Method, Group or Role, but rather to its Organization only
|
||||
|
||||
```shell-session
|
||||
+-------------------------------------+
|
||||
|
||||
@@ -3,9 +3,9 @@ layout: docs
|
||||
page_title: Architecture
|
||||
sidebar_title: Reference Architecture
|
||||
description: |-
|
||||
Watchtower reference architecture and considerations
|
||||
Boundary reference architecture and considerations
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
When deploying Watchtower in an on premise environment some considerations should be taken. The aim of this document is to provide minimum requirements for deploying Watchtower and a reference architecture model to follow in doing so.
|
||||
When deploying Boundary in an on premise environment some considerations should be taken. The aim of this document is to provide minimum requirements for deploying Boundary and a reference architecture model to follow in doing so.
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Architecture
|
||||
sidebar_title: Security Model
|
||||
description: |-
|
||||
Watchtower security model
|
||||
Boundary security model
|
||||
---
|
||||
|
||||
# Overview
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Architecture
|
||||
sidebar_title: Terminology
|
||||
description: |-
|
||||
Watchtower terminology
|
||||
Boundary terminology
|
||||
---
|
||||
|
||||
# Terminology
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Command Line Index
|
||||
sidebar_title: Command Line
|
||||
description: |-
|
||||
Reference documentation for the Watchtower command line
|
||||
Reference documentation for the Boundary command line
|
||||
---
|
||||
|
||||
# Command Line Overview
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: Command Line
|
||||
sidebar_title: Login/Logout
|
||||
description: |-
|
||||
Watchtower command line login and logout
|
||||
Boundary command line login and logout
|
||||
---
|
||||
|
||||
# How to Login and Logout
|
||||
@@ -2,12 +2,12 @@
|
||||
layout: docs
|
||||
page_title: Documentation
|
||||
sidebar_title: Overview
|
||||
description: Watchtower reference documentation
|
||||
description: Boundary reference documentation
|
||||
---
|
||||
|
||||
# Watchtower Reference Documentation
|
||||
# Boundary Reference Documentation
|
||||
|
||||
Watchtower reference documentation covers Watchtower architecture and supported clients.
|
||||
Boundary reference documentation covers Boundary architecture and supported clients.
|
||||
This is typically a generic introduction page to the documentation. Below is a showcase of some of the custom components that are available within documentation pages.
|
||||
|
||||
### Clients
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: SDK Index
|
||||
sidebar_title: SDK
|
||||
description: |-
|
||||
Reference documentation for the Watchtower SDK
|
||||
Reference documentation for the Boundary SDK
|
||||
---
|
||||
|
||||
# Overview
|
||||
|
||||
@@ -3,7 +3,7 @@ layout: docs
|
||||
page_title: SDK
|
||||
sidebar_title: Login/Logout
|
||||
description: |-
|
||||
Watchtower SDK login and logout
|
||||
Boundary SDK login and logout
|
||||
---
|
||||
|
||||
# How to Login and Logout
|
||||
Reference in new issue
Block a user