Skip to content

Commit

Permalink
Merge pull request #13387 from hashicorp/post-migration-info
Browse files Browse the repository at this point in the history
Add post migration information
  • Loading branch information
chrisroberts committed May 3, 2024
2 parents 87c6f50 + eb078bd commit faf9014
Show file tree
Hide file tree
Showing 2 changed files with 76 additions and 0 deletions.
72 changes: 72 additions & 0 deletions website/content/vagrant-cloud/hcp-vagrant/post-migration-guide.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
layout: vagrant-cloud
page_title: Usage and Behavior Post Migration to HCP
description: "Learn about how Vagrant and Vagrant Cloud will behave after migrating to HashiCorp Cloud Platform (HCP)."
---

# Migrating to HCP Vagrant Registry

This document describes the behavior of Vagrant Cloud after an organization is migrated to HCP Vagrant Registry. For information on migrating to HCP Vagrant Registry please see the [migration guide](/vagrant/vagrant-cloud/hcp-vagrant/migration-guide).

# Vagrant Cloud Redirects

After an organization has been migrated to HCP Vagrant Registry any requests Vagrant Cloud receives for that organization, or any boxes within that organization, will be automatically redirected to the proper location on HCP Vagrant Registry.

# API

API requests to Vagrant Cloud for organizations that have been migrated to HCP Vagrant Registry will be automatically proxied to HCP.

## Authenticated Requests

Authenticated API requests for migrated organizations will be proxied to HCP Vagrant Registry. This will require an HCP access token to be available to Vagrant Cloud to complete the request. Vagrant Cloud supports a composite access token comprised of the Vagrant Cloud access token and the HCP access token allowing seamless interactions with organizations that still remain on Vagrant Cloud as well as organizations that have been migrated to HCP Vagrant Registry.

The format of the composite access token is:

```
<VAGRANT_CLOUD_TOKEN>;<HCP_TOKEN>
```

If all organizations have been migrated to HCP Vagrant Registry the Vagrant Cloud access token will not be needed. The format of the access token is:

```
;<HCP_TOKEN>
```

### HCP Access Token

The following prerequisites are required for generating an HCP access token:

* [HCP Service Principal](/hcp/docs/hcp/admin/iam/service-principals)
* [HCP CLI](/hcp/docs/cli)

Using the `CLIENT_ID` and `CLIENT_SECRET` from the HCP service principal login to HCP using the `hcp` command:

```
hcp auth login --client-id=CLIENT_ID --client-secret=CLIENT_SECRET
```

Once authenticated the access token can be printed using the following command:

```
hcp auth print-access-token
```

### Vagrant Cloud Composite Token

The Vagrant CLI supports using the `VAGRANT_CLOUD_TOKEN` environment variable to hold the access token used for authentication. This environment variable can be set with both access tokens to allow request for migrated organization and unmigrated organizations to both work as expected. As noted above, the format of the composite token will consist of: the Vagrant Cloud access token, a semi-colon, and the HCP access token. An example of setting the environment variable would be:

```
export VAGRANT_CLOUD_TOKEN="<VAGRANT_CLOUD_TOKEN>;<HCP_TOKEN>"
```

The `hcp` command can also be used to provide the HCP access token to reduce the need for copying and pasting the access token:

```
export VAGRANT_CLOUD_TOKEN="<VAGRANT_CLOUD_TOKEN>;$(hcp auth print-access-token)"
```

If all organizations have been migrated to HCP Vagrant Registry, only the HCP access token will be needed:

```
export VAGRANT_CLOUD_TOKEN=";$(hcp auth print-access-token)"
```
4 changes: 4 additions & 0 deletions website/data/vagrant-cloud-nav-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@
{
"title": "Migration Troubleshooting",
"path": "hcp-vagrant/troubleshooting"
},
{
"title": "Post Migration",
"path": "hcp-vagrant/post-migration-guide"
}
]
},
Expand Down

0 comments on commit faf9014

Please sign in to comment.