Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Respect AZURE_CLIENT_ID, ANSIBLE_AZURE_AUTH_SOURCE on inventory plugin #713

Merged
merged 11 commits into from
Mar 22, 2024
Merged

Respect AZURE_CLIENT_ID, ANSIBLE_AZURE_AUTH_SOURCE on inventory plugin #713

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0e74e24
Attemp to pull environment variables if not set.
kingsleyadam Dec 20, 2021
aae2fa6
Set ansible azure auth source further upstream
kingsleyadam Dec 20, 2021
79a5add
Updates to documentation
kingsleyadam Dec 20, 2021
0ebfde0
Update plugins/doc_fragments/azure.py
kingsleyadam Mar 9, 2022
90b1793
doc_fragments/azure.py Documentation update
kingsleyadam Mar 9, 2022
48d4b70
Update plugins/doc_fragments/azure.py
kingsleyadam Mar 14, 2022
e68ff07
Merge branch 'dev' of github.com:kingsleyadam/azure into dev
kingsleyadam Nov 7, 2022
3bad211
Move all logic within azure_rm_common.py
kingsleyadam Nov 7, 2022
ae85a89
Removed unused import
kingsleyadam Nov 7, 2022
f2ff451
Move back to setting auth source in inventory
kingsleyadam Nov 7, 2022
b4132e2
Merge remote-tracking branch 'upstream/dev' into dev
kingsleyadam Dec 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion plugins/doc_fragments/azure.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ class ModuleDocFragment(object):
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).
kingsleyadam marked this conversation as resolved.
Show resolved Hide resolved
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
secret:
description:
Expand Down
4 changes: 3 additions & 1 deletion plugins/inventory/azure_rm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,6 +118,7 @@
except ImportError:
from Queue import Queue, Empty

from os import environ
from collections import namedtuple
from ansible import release
from ansible.plugins.inventory import BaseInventoryPlugin, Constructable
Expand Down Expand Up @@ -222,8 +223,9 @@ def parse(self, inventory, loader, path, cache=True):
raise

def _credential_setup(self):
auth_source = environ.get('ANSIBLE_AZURE_AUTH_SOURCE', None) or self.get_option('auth_source')
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kingsleyadam I think this order should be adjusted, because the auth_source of the configuration is fetched first, and if the fetch is auto, the environment variable is fetched, thanks!

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kingsleyadam I think this order should be adjusted, because the auth_source of the configuration is fetched first, and if the fetch is auto, the environment variable is fetched, thanks!

That's the issue I was running into. If I run self.get_option('auth_source') first, it has a default value of auto. Which won't fetch the environment variable ANSIBLE_AZURE_AUTH_SOURCE value. To avoid this my logic here is to first check the environment variable for the auth source, if it's not set then fetch it from the config.

auth_options = dict(
auth_source=self.get_option('auth_source'),
auth_source=auth_source,
profile=self.get_option('profile'),
subscription_id=self.get_option('subscription_id'),
client_id=self.get_option('client_id'),
Expand Down
1 change: 1 addition & 0 deletions plugins/module_utils/azure_rm_common.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1559,6 +1559,7 @@ def _get_profile(self, profile="default"):
return None

def _get_msi_credentials(self, subscription_id=None, client_id=None, **kwargs):
client_id = client_id or self._get_env('client_id')
credentials = MSIAuthentication(client_id=client_id)
subscription_id = subscription_id or self._get_env('subscription_id')
if not subscription_id:
Expand Down