Usage

This topic describes how to set the HCP Waypoint CLI context and how to perform basic operations.

Introduction

Most functionality available in HCP Waypoint is identical to the usage described in the self-managed version of Waypoint. Refer to the core Waypoint documentation for usage details.

Some functionality described in the OSS Waypoint documentation is not available in HCP Waypoint. Refer to Constraints and Limitations for information about feature parity between HCP Waypoint and self-managed Waypoint.

Get started: Complete the Build, Deploy, and Release Applications with HCP Waypoint tutorial to get started using HCP Waypoint.

Requirements

Waypoint 0.10.0 or later installed locally. Refer to Download Waypoint
An HCP account. Refer to HCP Account for information about creating an account.
A target platform for builds and deployments. The following platforms are supported:
- Docker
- Kubernetes
- AWS ECS
- Nomad

Configure projects

A project is the core artifact in Waypoint. A project contains one or more deployable applications.

Define project configurations in a waypoint.hcl file. The file defines how Waypoint builds, deploys, and releases projects. We recommend creating separate local directories for each Waypoint project. Refer to the OSS Waypoint documentation for information on how to configure waypoint.hcl files.

Create contexts

The Waypoint context is how your local Waypoint CLI communicates with HCP Waypoint. You must also configure connected platforms, such as DockerHub, that you want to add to your Waypoint lifecycle in the context.

Sign in to your HCP account and click Waypoint.
Click Manage and copy waypoint context create command.
Run the command in your local terminal.

Initialize projects

Navigate to the directory containing your waypoint.hcl file.

Issue the waypoint init command to initialize the project:

$ waypoint init
✓ Configuration file appears valid
✓ Connection to Waypoint server was successful
✓ Project "learn-hcp-runners" and all apps are registered with the server.
✓ Project "learn-hcp-runners" pipelines are registered with the server.

Project initialized!

Issue the waypoint up command to build, deploy, and release your application. You can add the -local=true flat to instruct Waypoint to execute the task on a local runner instead of a remote runner. Refer to waypoint up in the OSS Waypoint CLI documentation for information about all options:
```
$ waypoint up -local=true
» Building dev...
✓ Running build v1
✓ Initializing Docker client...
✓ Building image...
. . .
```

Update projects

You can issue the waypoint project apply command to update project configurations. In the following example, the project is updated to use data from a Git repository:

$ waypoint project apply -data-source=git -git-url=$MY_REPO_URL -git-ref=main learn-hcp-runners
✓ Project "learn-hcp-runners" updated

Issue the waypoint project inspect command to verify the changes:

$ waypoint project inspect
» Project Info:
              Project Name: learn-hcp-runners
              Applications: dev, ecs
                Workspaces: default
            Remote Enabled: true
               Data Source: Git
                   Git URL: https://github.com/<YOUR_FORKED_REPOSITORY>.git
                   Git Ref: main
  Data Source Poll Enabled: false
   App Status Poll Enabled: false
        File Change Signal: SIGINT