Docs: getting started edits (#2521)

* getting started content updates

* updates screenshot
pull/2523/head
Robin Beck 4 years ago committed by GitHub
parent da885a89c3
commit 5a7cb5c181
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -15,22 +15,21 @@ is the fastest way to onboard a target to HCP Boundary.
A `tcp` target with a default port of `22` (the default SSH port using TCP) is
recommended for an initial target. If using the Quick setup, a sample host set
called **QA Databases** will contain the **CRM Database** host, with the Address
provided during setup. When `boundary connect` is executed against the **CRM
Database target**, the single available host will be selected and a local
called **Prod-EC2** will contain the **Instance-1** host, with the Address
provided during setup. When `boundary connect` is executed against the **EC2 Instances** target, the single available host will be selected and a local
authenticated proxy to the host is established on the target's default port.
![Setup Wizard](/img/quick-start-targets.png)
To connect to the initial CRM Database target:
To connect to the initial EC2 Instances target:
1. Copy the **CRM Database target ID** (such as `ttcp_eTcZMueUYv`).
1. Copy the **EC2 Instances** target ID (such as `ttcp_ZnHEU9h8qX`).
1. Open a terminal session. Export the Boundary **Origin URL** as an environment
1. Open a terminal session. Export the Boundary **Cluster URL** as an environment
variable.
```shell-session
$ export BOUNDARY_ADDR=<boundary-origin-url>
$ export BOUNDARY_ADDR=<boundary-cluster-url>
```
1. Connect to the target.

@ -5,6 +5,30 @@ description: |-
How to deploy HCP Boundary services and login for the first time.
---
HCP Boundary provides secure access to remote hosts and infrastructure
endpoints. Boundary enables secure connectivity to cloud service catalogs,
on-premise infrastructure, and Kubernetes clusters without needing to manage any
of the underlying systems or operations.
## Requirements
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)
of the 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).
# Deploy an HCP Boundary Instance
HCP Boundary is a fully-managed cloud-based workflow. It enables secure access
@ -171,7 +195,8 @@ provider "boundary" {
To find your environments `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 environments Boundary **Origin URL**.
1. Click the **copy icon** in the **Copy this into Boundary Desktop** section.
This copies your environments Boundary **Origin URL**.
To find your environments default `auth_method_id`:
@ -186,8 +211,13 @@ To find your environments default `auth_method_id`:
## 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.
- 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,19 +6,30 @@ 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.
This section walks through how to get started with Boundary. Youll learn how
Boundary provides access to private endpoints securely.
![Boundary Architecture](/img/architecture-overview.png)
There are two options to get started with Boundary:
## Requirements
- **HCP Boundary** is a managed offering of the Boundary product, and is the
easiest way to get started. It streamlines deployment and operations, and is
available as a freemium service. HCP Boundary allows users to run their own
worker proxies, preventing exposure of your network to HashiCorp or clients.
Some enterprise features are only available with HCP Boundary. Review the [Get
started with HCP Boundary](/docs/getting-started/deploy-and-login) page to
learn more.
- **Boundary OSS** is an open source distribution of Boundary that users can run
in their own environments. The [Getting Started with Boundary
OSS](/docs/getting-started/connect-to-target) page discusses running Boundary
in Dev mode on your local machine, allowing you to get started with the OSS distribution quickly.
The Getting Started section uses HCP Boundary, a HashiCorp hosted and fully-managed version of the Boundary product.
We recommend you use the Boundary model that best meets your intended use case.
If youre not sure whats best for you, we recommend reviewing the [Getting
started with HCP Boundary](/docs/getting-started/deploy-and-login) page.
To get started with HCP Boundary, users need:
# Key Concepts
- 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)
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.
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).

Binary file not shown.

Before

Width:  |  Height:  |  Size: 141 KiB

After

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 75 KiB

Loading…
Cancel
Save