Use tasks to make API calls in the console in Puppet Enterprise 2017.3 and later

If you don’t have root command line access in Puppet Enterprise and/or you don’t have direct access to PE API integrations, you can make API calls from the console. You can use a task in the support_tasks module to create the Continuous Integration for Puppet Enterprise role, list PE authentication tokens, trigger a code deploy for all environments, and get the status of all PE services.

Version and installation information

PE version: 2017.3 and later
OS: Any primary server (formerly called master) OS

Note: If you’re using a version of the puppetlabs-support_tasks module older than 1.1.1 (2020 17 January), please update the module to use these steps. We renumbered all the tasks in the module at that time.

Solution

Use a task in the support_tasks module to run the following API calls in the console:

• create_role_cd4pe - Create the Continuous Delivery for PE role. The user created works with CD4PE installations up to version 3.4.0.
• list_tokens - List all PE authentication tokens.
• manual_gitlab_webhook_hit - Trigger a code deployment to all environments using a simulated GitLab webhook. To use this command, you must have a valid authentication token in the default location (~/.puppetlabs/token).
• get_all_services_status - Output the status of all PE services.

1. To use this task you must have an authentication token. If you don’t already have one, you can generate one using a task in the support_tasks module.

2. Download and install the support_tasks module which includes the task for this solution.

3. In the console, in the Run section, click Task.

4. In the Task field, select task st0373. Target your primary server. From the list of target types, select Node list. Expand the Inventory nodes target. Enter your primary server’s name and click Search. From the list of results, select your primary server.

5. Under Task parameters, select the parameter that matches the API call you’d like to make from the dropdown list.

6. Click Run job. After the task is completed, the API call’s output will appear on the Job page.