docs: Migrate link formats (#2777)

* Adding docs-content-check-legacy-links-format workflow

* Adding test-link-rewrites workflow

* Migrating links to new format
This commit is contained in:
Ashlee M Boyer authored and GitHub committed 2023-01-20 15:17:34 -08:00
1 parent 87b09d5e27
commit e6be6431b2
87 files changed
+485 -452

No files matched your search

@@ -6,6 +6,6 @@ description: Common workflows for Boundary
# Common Workflows
This section covers common workflows for managing targets, identities, and sessions within Boundary. This section assumes you've already covered the [Getting Started](/docs/getting-started) section and are familiar with basic Boundary knowledge. This section extends Getting Started by showing how to accomplish common workflows in the admin console, the command line, and with our [Terraform provider](https://github.com/hashicorp/terraform-provider-boundary).
This section covers common workflows for managing targets, identities, and sessions within Boundary. This section assumes you've already covered the [Getting Started](/boundary/docs/getting-started) section and are familiar with basic Boundary knowledge. This section extends Getting Started by showing how to accomplish common workflows in the admin console, the command line, and with our [Terraform provider](https://github.com/hashicorp/terraform-provider-boundary).
For more detailed guides on using Boundary please consult our [Learn site](https://learn.hashicorp.com/boundary).
For more detailed guides on using Boundary please consult our [Learn site](/boundary/tutorials).
@@ -6,7 +6,7 @@ description: How to manage Roles and Permissions
# Manage Roles and Permissions
[Roles](/docs/concepts/domain-model/roles) in Boundary manage the permissions given to principals ([Users](/docs/concepts/domain-model/users)/[Groups](/docs/concepts/domain-model/groups)). Roles can be defined at the global, org, or project scopes.
[Roles](/boundary/docs/concepts/domain-model/roles) in Boundary manage the permissions given to principals ([Users](/boundary/docs/concepts/domain-model/users)/[Groups](/boundary/docs/concepts/domain-model/groups)). Roles can be defined at the global, org, or project scopes.
In this example, we're going to show you how to create a role in Boundary, assign that roles grants, and assign principals to the role.
@@ -132,7 +132,7 @@ resource "boundary_scope" "role" {
# Assign Grants to a Role
Grants describe the actions that the principals should be allowed to perform. For more information on how to format grants see [Permission Grant Formats](https://boundaryproject.io/docs/concepts/security/permissions#permission-grant-formats).
Grants describe the actions that the principals should be allowed to perform. For more information on how to format grants see [Permission Grant Formats](/boundary/docs/concepts/security/permissions#permission-grant-formats).
In this example we give a role read and list permissions to all resources.
<Tabs>
@@ -6,7 +6,7 @@ description: How to manage Boundary scopes
# Manage Scopes
[Scopes](/docs/concepts/domain-model/scopes) are a foundational part of Boundary. They allow users to partition resources and assign ownership of resources to principals. There are three types of scopes within Boundary:
[Scopes](/boundary/docs/concepts/domain-model/scopes) are a foundational part of Boundary. They allow users to partition resources and assign ownership of resources to principals. There are three types of scopes within Boundary:
1. Global (`global`)
2. Org
@@ -18,7 +18,7 @@ These are in a hierarchy:
- Under the `global` scope there can be many org scopes. These are used to hold IAM-related resources and project scopes.
- Under each org scope can be many project scopes. These are used to hold infrastructure-related resources.
Some resources can only be associated with a specific level of scope. As an example, [Targets](/docs/concepts/domain-model/targets) can only be contained within a project scope. Other resources can be contained by multiple scopes. For example, users can be created within the `global` scope or an org-level scope. See the [domain model](/docs/concepts/domain-model) for detailed resource specific information.
Some resources can only be associated with a specific level of scope. As an example, [Targets](/boundary/docs/concepts/domain-model/targets) can only be contained within a project scope. Other resources can be contained by multiple scopes. For example, users can be created within the `global` scope or an org-level scope. See the [domain model](/boundary/docs/concepts/domain-model) for detailed resource specific information.
In this example, we're going to create two scopes, an org and a project.
@@ -6,7 +6,7 @@ description: How to manage Boundary sessions
# Manage Sessions
[Sessions](/docs/concepts/domain-model/sessions) are Boundary resources created when connecting to a [Target](/docs/concepts/domain-model/targets). A target allows Boundary users to define an endpoint with a protocol and default port to establish a session. Unless specified with a `-host-id` flag when establishing a session, Boundary will choose one [Host](/docs/concepts/domain-model/hosts) from the target's [Host Sets](/docs/concepts/domain-model/host-sets) to connect to at random.
[Sessions](/boundary/docs/concepts/domain-model/sessions) are Boundary resources created when connecting to a [Target](/boundary/docs/concepts/domain-model/targets). A target allows Boundary users to define an endpoint with a protocol and default port to establish a session. Unless specified with a `-host-id` flag when establishing a session, Boundary will choose one [Host](/boundary/docs/concepts/domain-model/hosts) from the target's [Host Sets](/boundary/docs/concepts/domain-model/host-sets) to connect to at random.
In this section, we'll show you the basics of how to start a session, view the session details, and cancel a session in Boundary using the CLI.
@@ -28,7 +28,7 @@ Proxy listening information:
Session ID: s_h7vBIhH5SZ
```
For more information regarding different ways to connect to a target behind Boundary see [Connect to Target](/docs/getting-started/connect-to-target) under Getting Started and [Advanced Session Establishment](#advanced-session-establishment) below.
For more information regarding different ways to connect to a target behind Boundary see [Connect to Target](/boundary/docs/getting-started/connect-to-target) under Getting Started and [Advanced Session Establishment](#advanced-session-establishment) below.
## View Sessions
@@ -6,7 +6,7 @@ description: How to manage Boundary targets
# Manage Targets
[Targets](/docs/concepts/domain-model/targets) are Boundary resources which contain one or more [Host Sets](/docs/concepts/domain-model/host-sets). A target allows Boundary users to define an endpoint with a default port and a protocol to establish a session. Unless specified with a `-host-id` flag, Boundary will choose one [Host](/docs/concepts/domain-model/hosts) in the host set to connect to at random.
[Targets](/boundary/docs/concepts/domain-model/targets) are Boundary resources which contain one or more [Host Sets](/boundary/docs/concepts/domain-model/host-sets). A target allows Boundary users to define an endpoint with a default port and a protocol to establish a session. Unless specified with a `-host-id` flag, Boundary will choose one [Host](/boundary/docs/concepts/domain-model/hosts) in the host set to connect to at random.
In this section, we'll show you the basics of how to define a host, host set, and a target in Boundary on the CLI, the admin console, and using our [Terraform provider](https://github.com/hashicorp/terraform-provider-boundary).
@@ -7,8 +7,8 @@ description: How to manage Boundary users and groups
# Managing Principals (Users and Groups)
Users and Groups in Boundary are collectively known as principals. Assigning
[grants](/docs/concepts/security/permissions) on
[Roles](/docs/concepts/domain-model/roles) is performed through principal IDs;
[grants](/boundary/docs/concepts/security/permissions) on
[Roles](/boundary/docs/concepts/domain-model/roles) is performed through principal IDs;
that is, the unique IDs of either users, groups, or both.
This page will walk you through managing users within Boundary. (Groups will be
@@ -18,8 +18,8 @@ added at a later time.)
Users in Boundary represent an _internal_ notion of a particular entity (human,
machine, etc.). Users can be correlated with one or more
[Account](/docs/concepts/domain-model/accounts) resources via [Auth
Methods](/docs/concepts/domain-model/auth-methods). Accounts represent
[Account](/boundary/docs/concepts/domain-model/accounts) resources via [Auth
Methods](/boundary/docs/concepts/domain-model/auth-methods). Accounts represent
_external_ notions of a particular entity. Among other use-cases, this mechanism
allows for an easy way to switch users to new IdPs within the organization
deploying Boundary.
@@ -41,7 +41,7 @@ $ boundary authenticate password -login-name=admin -auth-method-id=ampw_12345678
## SSH to Target
Running Boundary in [dev mode](/docs/oss/installing/dev-mode) creates other
Running Boundary in [dev mode](/boundary/docs/oss/installing/dev-mode) creates other
default resources such as a target and auth method. The default target (ttcp_1234567890) is already setup with a host
at `localhost` and a default port of `22`.
@@ -122,7 +122,7 @@ $ boundary authenticate password -login-name=admin -auth-method-id=ampw_12345678
## Authorize the Session
Running Boundary in [dev mode](/docs/oss/installing/dev-mode) creates other
Running Boundary in [dev mode](/boundary/docs/oss/installing/dev-mode) creates other
default resources such as a target and auth method. The default target (ttcp_1234567890) is already setup with a host
at `localhost` and a default port of `22`.