Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update meta content - Concepts #5224

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
4 changes: 2 additions & 2 deletions website/content/docs/concepts/aliases.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Aliases
description: |-
Aliases let you associate a string with a Boundary resource. Learn how to use an alias instead of a target ID when you connect.
description: >-
Aliases let you associate a string with a resource. Learn how to use an alias instead of an ID when you connect to a target.
---

# Aliases
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/concepts/auditing.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Auditing
description: |-
An overview of using Boundary to audit for compliance and threat management
description: >-
Learn how Boundary can help improve compliance and threat management by using session recording to audit user access and actions. Understand the BSR format.
---

# Auditing
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: docs
page_title: Connect helpers
description: Learn how connect helpers enable Boundary to automatically accept host key prompts to facilitate connections for HTTP, Kubernetes, PostgreSQL, RDP, and SSH.
description: >-
Learn how to use connect helpers to automatically accept host key prompts and facilitate connections for HTTP, Kubernetes, PostgreSQL, RDP, and SSH.
---

# Connect helpers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: -exec flag
description: |-
Learn how the `-exec` flag enables you to execute Boundary TCP sessions using your preferred client, even when there is no built-in support for it.
description: >-
Learn how to use the `-exec` flag to execute TCP sessions or pass flags using your preferred client.
---

# Exec flag
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Connection workflows
description: |-
Workflows that you can use to connect to targets. Learn how connect helpers, the `-exec` flag, and SSH ProxyCommand can help facilitate connections to targets.
description: >-
Learn how transparent sessions, connect helpers, the `-exec` flag, SSH ProxyCommand, and multi-hop sessions can help facilitate connections to targets.
---

# Connection workflows
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Multi-hop sessions
description: |-
Learn how multi-hop sessions enable you to chain together two or more Boundary workers across multiple networks.
description: >-
Learn how multi-hop sessions let you chain together two or more workers across multiple networks to reach a target without exposing private networks.
---

# Multi-hop sessions
Expand Down Expand Up @@ -78,9 +78,9 @@ intermediary workers have the following requirements.
### Ingress worker requirements

To proxy target connections, ingress workers require outbound access to the
Boundary control plane and inbound access from clients.
Boundary control plane and inbound access from clients.

HCP Boundary clusters automatically deploy HCP-managed workers which can be used as ingress workers. Using HCP-managed workers as ingress workers is helpful when organizations have strict networks security policies that prohibit any inbound access. In this scenario, intermediary or egress workers within the private network can establish a reverse proxy connection to the HCP-managed ingress worker.
HCP Boundary clusters automatically deploy HCP-managed workers which can be used as ingress workers. Using HCP-managed workers as ingress workers is helpful when organizations have strict networks security policies that prohibit any inbound access. In this scenario, intermediary or egress workers within the private network can establish a reverse proxy connection to the HCP-managed ingress worker.

### Intermediary worker requirements

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
layout: docs
page_title: SSH ProxyCommand
description: Learn how SSH ProxyCommand enables you to proxy an SSH connection in Boundary using a configuration file. Configure connections using the target's ID or domain.
description: >-
Learn how to use SSH ProxyCommand to proxy an SSH connection using a configuration file. Configure hosts using the target's ID or domain.
---

# SSH ProxyCommand
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/concepts/credential-management.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Credential management
description: |-
An overview of credential management in Boundary
description: >-
Learn about using credential brokering or credential injection to authenticate users. Understand the benefits and security considerations of each method.
---

# Credential management
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/accounts.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - accounts
description: |-
The anatomy of a Boundary account
page_title: Account resource
description: >-
Learn about using the accounts resource to establish the identities of users. Understand how to configure general, password, and LDAP account attributes.
---

# Accounts
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/aliases.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - aliases
description: |-
The anatomy of a Boundary alias
page_title: Alias resource
description: >-
Learn about using the alias resource to transparently connect to targets without having to provide the target ID or target name and scope ID.
---

# Aliases
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/auth-methods.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - auth methods
description: |-
Use auth methods to authenticate users to Boundary. Learn which attributes you can configure for password, OIDC, and LDAP auth methods in Boundary.
page_title: Auth method resource
description: >-
Learn about using the auth method resource to authenticate users. Understand which attributes you can configure for password, OIDC, and LDAP auth methods.
---

# Auth methods
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - credential libraries
description: |-
The anatomy of a Boundary credential library
page_title: Credential library resource
description: >-
Learn about using the credential library resource to provide credentials from a credential store. Understand the credential library attributes you can configure.
---

# Credential libraries
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - credential stores
description: |-
The anatomy of a Boundary credential store
page_title: Credential store resource
description: >-
Learn about using the credential store resource to store and retrieve credentials. Understand the Vault and static credential store attributes you can configure.
---

# Credential stores
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/credentials.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - credentials
description: |-
The anatomy of a Boundary credential
page_title: Credential resource
description: >-
Learn about using the credential resource to define secrets for a host. Understand username password, SSH private key, SSH certificate, and JSON credential types.
---

# Credentials
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/groups.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - groups
description: |-
The anatomy of a Boundary group
page_title: Group resource
description: >-
Learn about using the group resource to create collections of users with the same access control. Any role assigned to a group is assigned to the group's users.
---

# Groups
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - host catalogs
description: |-
The anatomy of a Boundary host catalog
page_title: Host catalog resource
description: >-
Learn about using the host catalog resource to organize and manage hosts and host sets within a project based on their function, environment, or other criteria.
---

# Host catalogs
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/host-sets.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - host sets
description: |-
The anatomy of a Boundary host set
page_title: Host set resource
description: >-
Learn about using the host set resource to organize and manage hosts that have the same level of access control and belong to the same host catalog.
---

# Host sets
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/hosts.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - hosts
description: |-
The anatomy of a Boundary host
page_title: Host resource
description: >-
Learn about using host resources to represent computing elements that are reachable from Boundary. You can organize hosts in host sets and host catalogs.
---

# Hosts
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model index
description: |-
Reference documentation for Boundary's domain model.
page_title: Domain model overview
description: >-
Learn about using the domain model to organize identity and access management and target resources for secure access. Understand how resources work together.
---

# Overview
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - managed groups
description: |-
The anatomy of a Boundary managed group
page_title: Managed group resource
description: >-
Learn about using the managed group resource to organize identity provider accounts and assign them grants. Understand how to configure OIDC and LDAP attributes.
---

# Managed groups
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/roles.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - roles
description: |-
The anatomy of a Boundary role
page_title: Role resource
description: >-
Learn about using the role resource to group permissions which are then granted to any principal assigned to the role. Understand role attributes.
---

# Roles
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/scopes.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - scopes
description: |-
Use scopes to group and manage resources in Boundary. Learn how to configure global scopes, org scopes, and projects to logically group resources.
page_title: Scope resource
description: >-
Learn about using the scope resource to organize and manage resources. Understand how to configure global, org, and project scopes to logically group resources.
---

# Scopes
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - session connections
description: |-
The anatomy of a Boundary session connection
page_title: Session connection resource
description: >-
Learn how the session connection resource represents the proxy Boundary creates between user and host. Understand how connections are established and terminated.
---

# Session connections
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - session recordings
description: |-
Use session recordings to audit user sessions in Boundary. Learn how to configure session recordings to monitor usage.
page_title: Session recording resource
description: >-
Learn about using the session recording resource to audit user sessions. Understand how storage policy retention periods help you meet your compliance needs.
---

# Session recordings
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/sessions.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - sessions
description: |-
The anatomy of a Boundary session
page_title: Session resource
description: >-
Learn how the session resource is a set of connections between users and hosts that may include credentials. Understand how sessions are created and terminated.
---

# Sessions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - storage bucket
description: |-
The anatomy of a Boundary storage bucket
page_title: Storage bucket resource
description: >-
Learn how to use the storage bucket resource to retain session recordings for compliance. Understand storage bucket attributes and how scopes affect storage.
---

# Storage buckets
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - storage policies
description: |-
Use storage policies to manage session recording retention in Boundary. Learn how to configure policies for global and org scopes, and specify retention periods.
page_title: Storae policy resource
description: >-
Learn about using the storage policy resource to manage session recording retention. Understand how to configure policies for scopes and specify retention.
---

# Storage policies
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/targets.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - targets
description: |-
The anatomy of a Boundary target
page_title: Target resource
description: >-
Learn about using the target resource to configure a networked service a user can connect to. Understand the TCP and SSH target type requirements and attributes.
---

# Targets
Expand Down
6 changes: 3 additions & 3 deletions website/content/docs/concepts/domain-model/users.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Domain model - users
description: |-
The anatomy of a Boundary user
page_title: User resource
description: >-
Learn how the user resource identifies a person or entity for access control purposes. Understand how to assign groups and roles so users inherit permissions.
---

# Users
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/concepts/filtering/events.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Filtering - events
description: |-
How to filter events emitted by Boundary.
description: >-
Learn how to filter audit, observation, system, and telemetry events to find information written to any event sinks you configured.
---

# Filter events
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/concepts/filtering/index.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Filtering
description: |-
An introduction to the filtering syntax used in Boundary.
description: >-
Learn how to use filters to match and find data. Understand how to create filter expressions using matching operators composed with selectors and values.
---

# Filter expressions
Expand Down
4 changes: 2 additions & 2 deletions website/content/docs/concepts/filtering/managed-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Filtering - managed groups
description: |-
How to configure filters for managed groups within the OIDC or LDAP auth methods.
description: >-
Learn how to configure filters for managed groups. View search filter attributes and examples of filters for OIDC and LDAP managed groups.
---

[filter syntax]: /boundary/docs/concepts/filtering
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
layout: docs
page_title: Filtering - resource listing
description: |-
How to use filter list responses coming back from Boundary.
description: >-
Learn how to use filters to reduce the set of resources returned when you perform a list operation. Filtering list results helps you find information.
---

# Filter resource listings
Expand Down
Loading