Skip to content

mdklatt/idea-ansible-plugin

Repository files navigation

Ansible Plugin for IDEA

IDEA version Latest release Test status

Introduction

This plugin provides tools for working with Ansible inside a JetBrains IDE. An existing Ansible installation is required.

Ansible logos © RedHat, Inc.

Run/Debug Configurations

Run/debug configurations are provided for executing Ansible commands. A new configuration can be created from the Run > Edit Configurations menu or by right clicking on a file and using the Ansible context menu.

Galaxy

Use this configuration to install collections and roles using ansible-galaxy. Use a YAML requirements file to create a new Galaxy configuration from the context menu.

Playbook

Use this configuration to execute plays using ansible-playbook. Use a YAML playbook to create a new Playbook configuration from the context menu.

Plugin Setup

Per-project settings are found under Settings > Tools > Ansible. These are used to specify where the Ansible executables are installed. This can be a regular system install or a Python virtualenv. Optionally, a Docker image can be used for either installation types (requires Docker Engine on the host machine). An ansible.cfg file can also be specified in these settings.

For Docker execution, the working directory specified in the run configuration settings becomes the working directory of the Ansible container. Any input files that are not part of the image (playbooks, requirements files, ansible.cfg, etc.) should within this directory. Paths on the host must be relative to the working directory. Use absolute paths to specify files that are part of the image.

Installation

The latest version is available via a custom plugin repository. Releases include a binary distribution named idea-ansible-plugin-<version>.zip that can be installed from disk.