ansible/awx

Documentation for IAM EC2 inventory

Open

#924 opened on Jan 5, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (13,071 stars) (3,333 forks)batch import
Hacktoberfestcomponent:docsgood first issuehelp wantedtype:enhancement

Description

ISSUE TYPE
  • Documentation
COMPONENT NAME
  • UI
SUMMARY

IAM permissions for EC2 inventory plugin

ENVIRONMENT

N/A

STEPS TO REPRODUCE

When using EC2 to lookup hosts available, there is no reference to what permissions the IAM role should have, giving the role extensive permissions is not ideal.

The error message also does not give us any detailed information.

Can we update the documentation to identify which actions the role needs to have (obviously depending on the flags set in ec2.ini).

For a basic setup, with ec2.ini left as default the following two actions are required:

ec2:DescribeInstances ec2:DescribeTags

Contributor guide

Tech stack
pythonaws
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
AWS IAM knowledgeAWX EC2 inventory plugin familiarity
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
Examine the AWX EC2 inventory plugin code (likely in plugins/inventory/ec2.py) and the ec2.ini configuration file to list all AWS API actions used. Document the minimal IAM permissions needed for basic and advanced configurations. The issue already mentions ec2:DescribeInstances and ec2:DescribeTags as basic; verify and expand for all features.
Documentation for IAM EC2 inventory · ansible/awx#924 | Good First Issue