VMware: Using Automation Config's cloud API

VMware is a leading provider of multi-cloud services for all apps, enabling digital innovation with enterprise control. VMware was acquired by Broadcom in 2023.

Length of project

November 2022 - April 2023

Product overview

Automation Config is an automated configuration management platform that provisions, configures, deploys, manages, and monitors nodes to ensure that the nodes in your system are always operating in a consistent, desired state. Automation Config runs on Salt, an open-source automation and configuration management engine.

Customers can use the on-premises version or the SaaS version of Automation Config. The target audience for the product is IT system administrators or DevOps team members.

Project description

Customers can programatically complete common infrastructure tasks using Automation Config’s cloud API. For example, customers can assign permissions to a role or user, create or update a job, or view job returns.

I led the effort to create documentation that explains how to connect to the cloud API. The goal was to walk customers through installing any prerequisites, generating API tokens, and making an API call.

Tools I used

  • Authoring: Oxygen XML Author, DITA (Darwin Information Typing Architecture), SDL Tridion for Content Management
  • Testing: Python, cURL, Linux (Ubuntu)

Work sample

How do I connect to the cloud API (PDF): A topic that explains how to connect your nodes to the Automation Config cloud API