From 3d6a629c978d88483f98d97b962fadb5be6d7528 Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Thu, 14 Nov 2024 13:48:59 -0500 Subject: [PATCH] docs: Update meta content - Install (#5218) --- .../docs/install-boundary/architecture/fault-tolerance.mdx | 4 ++-- .../docs/install-boundary/architecture/high-availability.mdx | 5 +++-- .../architecture/recommended-architecture.mdx | 4 ++-- .../install-boundary/architecture/system-requirements.mdx | 4 ++-- .../content/docs/install-boundary/configure-controllers.mdx | 4 ++-- website/content/docs/install-boundary/configure-workers.mdx | 4 ++-- website/content/docs/install-boundary/index.mdx | 4 ++-- website/content/docs/install-boundary/initialize.mdx | 4 ++-- website/content/docs/install-boundary/install.mdx | 4 ++-- .../docs/install-boundary/terraform-patterns/index.mdx | 4 ++-- .../terraform-credentials-and-credential-stores.mdx | 2 +- .../terraform-patterns/terraform-groups-and-rbac.mdx | 2 +- .../terraform-hosts-and-host-management.mdx | 2 +- .../install-boundary/terraform-patterns/terraform-scopes.mdx | 2 +- .../terraform-patterns/terraform-session-recording.mdx | 4 ++-- .../terraform-patterns/terraform-targets.mdx | 2 +- .../terraform-patterns/terraform-users-and-auth-methods.mdx | 2 +- 17 files changed, 29 insertions(+), 28 deletions(-) diff --git a/website/content/docs/install-boundary/architecture/fault-tolerance.mdx b/website/content/docs/install-boundary/architecture/fault-tolerance.mdx index b7aef8a77..e5f1d7127 100644 --- a/website/content/docs/install-boundary/architecture/fault-tolerance.mdx +++ b/website/content/docs/install-boundary/architecture/fault-tolerance.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Fault tolerance recommendations -description: |- - Boundary fault tolerance characteristics +description: >- + Understand Boundary fault tolerance recommendations to increase availability, reduce risk. Minimize the impact of node, availability zone, and regional failures. --- # Fault tolerance recommendations diff --git a/website/content/docs/install-boundary/architecture/high-availability.mdx b/website/content/docs/install-boundary/architecture/high-availability.mdx index 8d50d94fe..0f54c1d7b 100644 --- a/website/content/docs/install-boundary/architecture/high-availability.mdx +++ b/website/content/docs/install-boundary/architecture/high-availability.mdx @@ -1,8 +1,9 @@ --- layout: docs page_title: High availability installation -description: |- - How to install Boundary as a high availability service +description: >- + Learn about network requirements and architecture to set up Boundary for high availability, including database, load balancer, and configuration best practices. + --- # High availability installation diff --git a/website/content/docs/install-boundary/architecture/recommended-architecture.mdx b/website/content/docs/install-boundary/architecture/recommended-architecture.mdx index 96e1e2af5..30784d7a5 100644 --- a/website/content/docs/install-boundary/architecture/recommended-architecture.mdx +++ b/website/content/docs/install-boundary/architecture/recommended-architecture.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Recommended architecture -description: |- - Boundary architecture recommendations +description: >- + Learn about the recommended architectures for two main Boundary user workflows: an administrator configuring Boundary and an end user connecting to a target. --- # Recommended architecture diff --git a/website/content/docs/install-boundary/architecture/system-requirements.mdx b/website/content/docs/install-boundary/architecture/system-requirements.mdx index e479bba4d..e404a52f6 100644 --- a/website/content/docs/install-boundary/architecture/system-requirements.mdx +++ b/website/content/docs/install-boundary/architecture/system-requirements.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: System requirements -description: |- - Boundary system requirements +description: >- + Learn about Boundary system requirements including recommendations for hardware sizing, network connectivity, traffic encryption, databases, and load balancers. --- # System requirements diff --git a/website/content/docs/install-boundary/configure-controllers.mdx b/website/content/docs/install-boundary/configure-controllers.mdx index a6aef8785..4b6bbf0c4 100644 --- a/website/content/docs/install-boundary/configure-controllers.mdx +++ b/website/content/docs/install-boundary/configure-controllers.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Configure controllers -description: |- - Configure Boundary controllers +description: >- + Configure Boundary controllers for a self-managed deployment, including TLS, KMS, and database parameters. Start the service, authenticate, and manage resources. --- # Configure controllers diff --git a/website/content/docs/install-boundary/configure-workers.mdx b/website/content/docs/install-boundary/configure-workers.mdx index 2e856857b..ff44e04dc 100644 --- a/website/content/docs/install-boundary/configure-workers.mdx +++ b/website/content/docs/install-boundary/configure-workers.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Configure workers -description: |- - Configure Boundary workers +description: >- + Configure Boundary workers for a self-managed deployment, including environment files and KMS keys. Set up ingress, intermediary, and egress roles for multi-hop. --- # Configure workers diff --git a/website/content/docs/install-boundary/index.mdx b/website/content/docs/install-boundary/index.mdx index 6cd5b0525..a94a63dc5 100644 --- a/website/content/docs/install-boundary/index.mdx +++ b/website/content/docs/install-boundary/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Overview -description: |- - Deploying a self-managed version of Boundary +description: >- + Discover resources for deploying a self-managed version of Boundary Enterprise or Boundary Community Edition. --- # Overview diff --git a/website/content/docs/install-boundary/initialize.mdx b/website/content/docs/install-boundary/initialize.mdx index db0adce39..8f4105c1e 100644 --- a/website/content/docs/install-boundary/initialize.mdx +++ b/website/content/docs/install-boundary/initialize.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Initialize Boundary -description: |- - Creating your first login account +description: >- + Initialize new Boundary self-managed installations. Log in with the recovery KMS to create initial scope, auth method, login account, user, and role resources. --- # Initialize Boundary diff --git a/website/content/docs/install-boundary/install.mdx b/website/content/docs/install-boundary/install.mdx index 2d1aa8642..f5337729d 100644 --- a/website/content/docs/install-boundary/install.mdx +++ b/website/content/docs/install-boundary/install.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Install Boundary -description: |- - Install a self-managed version of Boundary +description: >- + Install a self-managed version of Boundary Enterprise or Community Edition on Ubuntu/Debian, CentOS/RHEL, or Amazon Linux using the binary file. --- # Install Boundary diff --git a/website/content/docs/install-boundary/terraform-patterns/index.mdx b/website/content/docs/install-boundary/terraform-patterns/index.mdx index 32fa38e99..700331926 100644 --- a/website/content/docs/install-boundary/terraform-patterns/index.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/index.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Terraform patterns for Boundary -description: |- - Learn how to configure the Terraform Boundary provider so that you can use Terraform patterns to install and manage Boundary. +description: >- + Configure the Terraform Boundary provider so that you can use Terraform patterns to install and manage Boundary resources. --- # Terraform patterns for Boundary diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-credentials-and-credential-stores.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-credentials-and-credential-stores.mdx index fbf3a1d28..40e8030e2 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-credentials-and-credential-stores.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-credentials-and-credential-stores.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Terraform patterns for Boundary credentials and credential stores -description: |- +description: >- Use Terraform patterns to create and manage Boundary credentials and credential stores. Learn how to create static or Vault credential stores, add credentials. --- diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-groups-and-rbac.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-groups-and-rbac.mdx index 92ac2c322..7c9a7ada0 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-groups-and-rbac.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-groups-and-rbac.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Terraform patterns for Boundary groups and RBAC -description: |- +description: >- Use Terraform patterns to create and manage Boundary groups and role-based access control (RBAC). Learn how to add users to managed groups and assign roles. --- diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-hosts-and-host-management.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-hosts-and-host-management.mdx index 5975526d9..bf41a985e 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-hosts-and-host-management.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-hosts-and-host-management.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Terraform patterns for Boundary hosts and host management -description: |- +description: >- Use Terraform patterns to create and manage Boundary hosts and host catalogs. Learn how to add static or plugin-based hosts to static or dynamic host catalogs. --- diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-scopes.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-scopes.mdx index a5b905d63..e13f83178 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-scopes.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-scopes.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Terraform patterns for Boundary scopes -description: |- +description: >- Use Terraform patterns to create and manage Boundary scopes. Learn how to configure global, org-level, and project-level scopes using the Boundary provider. --- diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-session-recording.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-session-recording.mdx index 2ea39b48e..a4cb08891 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-session-recording.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-session-recording.mdx @@ -1,8 +1,8 @@ --- layout: docs page_title: Terraform patterns for Boundary session recording -description: |- - Use Terraform patterns to enable session recording for auditing user sessions in Boundary. Learn how to configure prerequisite storage policies and buckets. +description: >- + Use Terraform patterns to enable session recording for auditing user sessions in Boundary. Learn how to configure storage policies and storage buckets. --- # Terraform patterns for Boundary session recording diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-targets.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-targets.mdx index 46ce1c9a8..a3472896c 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-targets.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-targets.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Terraform patterns for Boundary targets -description: |- +description: >- Use Terraform patterns to create and manage Boundary targets. Learn how to configure SSH and TCP targets, inject passwords, and enable session recording. --- diff --git a/website/content/docs/install-boundary/terraform-patterns/terraform-users-and-auth-methods.mdx b/website/content/docs/install-boundary/terraform-patterns/terraform-users-and-auth-methods.mdx index 0fdae6638..c72cae70e 100644 --- a/website/content/docs/install-boundary/terraform-patterns/terraform-users-and-auth-methods.mdx +++ b/website/content/docs/install-boundary/terraform-patterns/terraform-users-and-auth-methods.mdx @@ -1,7 +1,7 @@ --- layout: docs page_title: Terraform patterns for Boundary users and auth methods -description: |- +description: >- Use Terraform patterns to create and manage Boundary users and auth methods. Learn how to configure password and LDAP auth methods, add accounts, create users. ---