Skip to content

Commit

Permalink
Update aws-ec2 configuration help
Browse files Browse the repository at this point in the history
Updated to reflect enhanced functionality and clarify necessary
permissions.
  • Loading branch information
mfischer-zd committed Oct 5, 2016
1 parent d7615b0 commit c6120c2
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions builtin/credential/aws-ec2/path_config_client.go
Original file line number Diff line number Diff line change
Expand Up @@ -193,11 +193,15 @@ type clientConfig struct {
}

const pathConfigClientHelpSyn = `
Configure the client credentials that are used to query instance details from AWS EC2 API.
Configure AWS IAM credentials that are used to query instance and role details from the AWS API.
`

const pathConfigClientHelpDesc = `
aws-ec2 auth backend makes DescribeInstances API call to retrieve information regarding
the instance that performs login. The aws_secret_key and aws_access_key registered with
Vault should have the permissions to make the API call.
The aws-ec2 auth backend makes AWS API queries to retrieve information
regarding EC2 instances that perform login operations. The 'aws_secret_key' and
'aws_access_key' parameters configured here should map to an AWS IAM user that
has permission to make the following API queries:
* ec2:DescribeInstances
* iam:GetInstanceProfile (if IAM Role binding is used)
`

0 comments on commit c6120c2

Please sign in to comment.