Save 10-15% Register for HashiConf and save big when you buy 2+ tickets Get your passes
HashiCorp Cloud Platform
HashiCorp Cloud Platform Home

Create and manage actions

This page describes how to create HCP Waypoint actions and attach them to HCP Waypoint templates and applications. Platform engineers often perform these tasks. Refer to Actions for additional information.

Prerequisites

  • An HCP account with HCP Waypoint enabled. Refer to HCP Account for information about creating an account.

Create an action

To create an action, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Actions in the sidebar, then click Create an action.
  3. Enter an Action name and Description for the action.
  4. Add values to the Variables field to create any required local variables for the action.
  5. Optionally, enable the Enable this value to be defined when the action is triggered option for each variable you want to choose a value for when you run the action. Refer to HCP Waypoint variables reference for more information.
  6. Choose an Action type and enter the associated configuration parameters.
  7. Click Create action.

You can choose from the following action types:

  1. Custom: This action type configures HCP Waypoint to send an HTTP request to the specified source URL. The source URL cannot include a custom port.
  2. Agent: This action type runs on an HCP Waypoint agent that you manage. Refer to the create and manage agents documentation for more information.

For information on using variables in an action, refer to the action variables reference documentation.

Run an action

To run an action, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Actions in the sidebar, then click on the name of the action you want to run.
  3. Click Run.

Delete an action

To delete an action, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Actions in the sidebar, then open the ellipses menu under the Manage heading for the action you want to delete.
  3. Click Delete action.
  4. Enter DELETE in the form and click Delete.

Assign an action to a template

To assign or unassign an action to a template, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Templates in the sidebar, then click on the name of a template.
  3. In the sidebar, click Settings then click Action assignments.
  4. Enable the actions you want to assign to the template and deselect any actions you want unassign.
  5. Click Confirm.

Run an action assigned to an application

Applications inherit any actions assigned to the template they are created from. To run an action assigned to an application, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Applications in the sidebar, then click on the name of an application.
  3. Click Actions, then click on the name of the action you want to run.
  4. Click Run.

View action run history

To view an action's run history, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Actions in the sidebar, then click on the name of an action.

View action run history for an application

To view an action's run history for an application, complete the following steps:

  1. Sign into the HCP portal and click Waypoint in the Services menu.
  2. Click Applications in the sidebar, then click on the name of an application.
  3. Click Action runs in the sidebar.

Next steps

To learn more about what you can do with HCP Waypoint after you created an action, refer to the following topics: