Boundary documentation: content cleanup in prep for devdot migration (#2249)
* cleaning up docs * Update website/content/docs/concepts/domain-model/groups.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/concepts/domain-model/managed-groups.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/concepts/domain-model/roles.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/concepts/domain-model/scopes.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/concepts/domain-model/sessions.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/configuration/worker/pki-worker.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> * Update website/content/docs/getting-started/deploy-and-login.mdx Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com> Co-authored-by: Robin Beck <stellarsquall@users.noreply.github.com>
This commit is contained in:
Loann LeandRobin Beck authored and 
GitHub committed
1 parent
194b3af678
commit
d5633952db
25 files changed
+103
-62
No files matched your search
@@ -57,7 +57,7 @@ within the authorized session. When you are finished making connections, simply
|
||||
### Using Connect Helpers
|
||||
|
||||
Boundary includes connect helpers that automatically accept host SSH key prompts
|
||||
for you. These are written as `boundary connect <subcommand>`.
|
||||
for you. These are written as `boundary connect <subcommand>`.
|
||||
|
||||
In the following example, the helper will automatically execute `ssh` for you,
|
||||
filling in the local address and port. An expected host ID is set to avoid
|
||||
@@ -221,8 +221,12 @@ proxy details.
|
||||
/>
|
||||
</video>
|
||||
|
||||
## Tutorial
|
||||
|
||||
Refer to the [Connect to your First Target](https://learn.hashicorp.com/tutorials/boundary/hcp-getting-started-connect?in=boundary/hcp-getting-started) tutorial for steps on how to create a host catalog, host set, and a target in Boundary.
|
||||
|
||||
## Next Steps
|
||||
|
||||
See our [basic administration
|
||||
workflows](https://learn.hashicorp.com/collections/boundary/hcp-administration)
|
||||
for in depth discussion on managing scopes, targets, identities, and sessions.
|
||||
Refer to our [basic administration
|
||||
workflows](https://learn.hashicorp.com/collections/boundary/hcp-administration) tutorial series
|
||||
for in depth discussions on managing scopes, targets, identities, and sessions.
|
||||
@@ -15,10 +15,10 @@ underlying systems or operations.
|
||||
To deploy an HCP Boundary instance:
|
||||
|
||||
1. Navigate to [HashiCorp Cloud Platform](https://portal.cloud.hashicorp.com/)
|
||||
and login using your credentials.
|
||||
and login using your credentials.
|
||||
|
||||
1. Click the **Boundary (Beta)** tab, and then and click **Deploy Boundary** on
|
||||
the right-hand pane.
|
||||
the right-hand pane.
|
||||
|
||||
1. Fill out the following form details:
|
||||
|
||||
@@ -39,30 +39,30 @@ To deploy an HCP Boundary instance:
|
||||
|
||||
Once the deployment is complete, the HCP Boundary instance can be accessed
|
||||
directly from the HCP Boundary portal using the credentials created during
|
||||
setup.
|
||||
setup.
|
||||
|
||||
1. From the HCP Boundary portal page, click the **Open Admin UI** button.
|
||||
1. From the HCP Boundary portal page, click the **Open Admin UI** button.
|
||||
|
||||
1. Enter the admin username and password you created when you deployed the new
|
||||
instance, and click **Authenticate**.
|
||||
|
||||
1. The **Welcome to Boundary** setup wizard will launch automatically.
|
||||
1. The **Welcome to Boundary** setup wizard will launch automatically.
|
||||
|
||||
There are two options for Boundary’s initial setup:
|
||||
|
||||
|
||||
- Quick setup
|
||||
- Manual
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
The **Quick setup** is recommended for new users, and generates a set of initial
|
||||
resources to assist in connecting to your first target.
|
||||
|
||||
resources to assist in connecting to your first target.
|
||||
|
||||
|
||||
|
||||
|
||||
The **Manual** setup drops the user directly into Boundary, without any
|
||||
provisioned resources.
|
||||
|
||||
|
||||
Upon completion of the setup wizard, you will be logged into your HCP Boundary
|
||||
instance's Global scope via the web UI. This is the default scope for all new
|
||||
Boundary clusters.
|
||||
@@ -169,12 +169,12 @@ provider "boundary" {
|
||||
}
|
||||
```
|
||||
|
||||
To find your environment’s `base_url`:
|
||||
To find your environment’s `base_url`:
|
||||
|
||||
1. In the HCP portal, open the **Boundary Overview** page.
|
||||
1. Click the **copy icon** in the **Copy this into Boundary Desktop** section. This copies your environment’s Boundary **Origin URL**.
|
||||
|
||||
To find your environment’s default `auth_method_id`:
|
||||
To find your environment’s default `auth_method_id`:
|
||||
|
||||
1. In your HCP Boundary portal, click the Admin UI button.
|
||||
1. Log in to the Admin Console by entering the admin username and password you
|
||||
@@ -185,6 +185,11 @@ To find your environment’s default `auth_method_id`:
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
## Tutorial
|
||||
|
||||
- Refer to the [Create a Boundary Instance on HCP](https://learn.hashicorp.com/tutorials/boundary/hcp-getting-started-create) tutorial to learn how to deploy a Boundary instance.
|
||||
- Refer to the [Install Boundary Desktop](https://learn.hashicorp.com/tutorials/boundary/hcp-getting-started-desktop-app) tutorial to learn how to use the Boundary desktop to connect to a running HCP Boundary instance.
|
||||
|
||||
|
||||
## Next Steps
|
||||
|
||||
|
||||
@@ -6,16 +6,17 @@ description: Getting started with Boundary
|
||||
|
||||
# Getting Started
|
||||
|
||||
Before getting started with Boundary, it's important to understand a few key concepts. Please consult our [Boundary concepts](/docs/concepts) page to familiarize yourself with Boundary's architecture, and terminology.
|
||||
Before getting started with Boundary, it's important to understand a few key concepts. Please consult our [Boundary concepts](/docs/concepts) page to familiarize yourself with Boundary's architecture and terminology.
|
||||
|
||||
## Requirements
|
||||
|
||||
The Getting Started section uses HCP Boundary, a HashiCorp hosted and fully-managed version of the Boundary product.
|
||||
The Getting Started section uses HCP Boundary, a HashiCorp hosted and fully-managed version of the Boundary product.
|
||||
|
||||
To get started with HCP Boundary, users need:
|
||||
|
||||
- A [HashiCorp Cloud Platform](https://portal.cloud.hashicorp.com/sign-up) account
|
||||
- [Installation](https://learn.hashicorp.com/tutorials/boundary/hcp-getting-started-install?in=boundary/hcp-getting-started) of Boundary CLI
|
||||
- A [Boundary binary](https://www.boundaryproject.io/downloads) in your `$PATH`
|
||||
- Optionally, an [installation of Boundary Desktop](https://learn.hashicorp.com/tutorials/boundary/hcp-getting-started-desktop-app)
|
||||
|
||||
If you prefer to Get Started on your local machine, refer to [Run and Login in Dev Mode](/docs/oss/installing/run-and-login). For more information on Boundary OSS and self-managed installations, refer to [Boundary OSS](/docs/oss/index).
|
||||
If you prefer to get started on your local machine, refer to [Run and Login in Dev Mode](/docs/oss/installing/run-and-login). For more information on Boundary OSS and self-managed installations, refer to [Boundary OSS](/docs/oss).
|
||||
Reference in new issue
Block a user