External-Mirrors/awx
2
0
Fork 0
mirror of https://github.com/ansible/awx.git synced 2026-01-14 03:10:42 -03:30
Code Issues Packages Projects Releases Wiki Activity

Rename private to primary in galaxy settings

Browse Source 
use a setting for the public galaxy URL
This commit is contained in:
AlanCoding 2019-08-28 10:21:50 -04:00
parent 8bda048e6d
commit 922e779a86
No known key found for this signature in database
GPG Key ID: FD2C3C012A72926B
5 changed files with 47 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
awx/main/conf.py
View File

@ -440,52 +440,56 @@ register(
)
register(
'PRIVATE_GALAXY_URL',
'PRIMARY_GALAXY_URL',
field_class=fields.URLField,
required=False,
allow_blank=True,
label=_('Private Galaxy Server URL'),
help_text=_('For using a private galaxy server at higher precedence than the public Ansible Galaxy. '
'The URL of the galaxy instance to connect to, this is required if using a private galaxy server.'),
label=_('Primary Galaxy Server URL'),
help_text=_(
'For organizations that run their own Galaxy service, this gives the option to specify a '
'host as the primary galaxy server. Requirements will be downloaded from the primary if the '
'specific role or collection is available there. If the content is not avilable in the primary, '
'or if this field is left blank, it will default to galaxy.ansible.com.'
),
category=_('Jobs'),
category_slug='jobs'
)
register(
'PRIVATE_GALAXY_USERNAME',
'PRIMARY_GALAXY_USERNAME',
field_class=fields.CharField,
required=False,
allow_blank=True,
label=_('Private Galaxy Server Username'),
help_text=_('For using a private galaxy server at higher precedence than the public Ansible Galaxy. '
label=_('Primary Galaxy Server Username'),
help_text=_('For using a galaxy server at higher precedence than the public Ansible Galaxy. '
'The username to use for basic authentication against the Galaxy instance, '
'this is mutually exclusive with PRIVATE_GALAXY_TOKEN.'),
'this is mutually exclusive with PRIMARY_GALAXY_TOKEN.'),
category=_('Jobs'),
category_slug='jobs'
)
register(
'PRIVATE_GALAXY_PASSWORD',
'PRIMARY_GALAXY_PASSWORD',
field_class=fields.CharField,
encrypted=True,
required=False,
allow_blank=True,
label=_('Private Galaxy Server Password'),
help_text=_('For using a private galaxy server at higher precedence than the public Ansible Galaxy. '
label=_('Primary Galaxy Server Password'),
help_text=_('For using a galaxy server at higher precedence than the public Ansible Galaxy. '
'The password to use for basic authentication against the Galaxy instance, '
'this is mutually exclusive with PRIVATE_GALAXY_TOKEN.'),
'this is mutually exclusive with PRIMARY_GALAXY_TOKEN.'),
category=_('Jobs'),
category_slug='jobs'
)
register(
'PRIVATE_GALAXY_TOKEN',
'PRIMARY_GALAXY_TOKEN',
field_class=fields.CharField,
encrypted=True,
required=False,
allow_blank=True,
label=_('Private Galaxy Server Token'),
help_text=_('For using a private galaxy server at higher precedence than the public Ansible Galaxy. '
label=_('Primary Galaxy Server Token'),
help_text=_('For using a galaxy server at higher precedence than the public Ansible Galaxy. '
'The token to use for connecting with the Galaxy instance, '
'this is mutually exclusive with corresponding username and password settings.'),
category=_('Jobs'),
@ -767,8 +771,10 @@ def galaxy_validate(serializer, attrs):
are enforced here on serializer validation so that users will not be able
to save settings which obviously break all project updates.
"""
prefix = 'PRIMARY_GALAXY_'
galaxy_fields = ('url', 'username', 'password', 'token')
if not any('PRIVATE_GALAXY_{}'.format(subfield.upper()) in attrs for subfield in galaxy_fields):
if not any('{}{}'.format(prefix, subfield.upper()) in attrs for subfield in galaxy_fields):
return attrs
def _new_value(field_name):
@ -780,27 +786,25 @@ def galaxy_validate(serializer, attrs):
galaxy_data = {}
for subfield in galaxy_fields:
galaxy_data[subfield] = _new_value('PRIVATE_GALAXY_{}'.format(subfield.upper()))
galaxy_data[subfield] = _new_value('{}{}'.format(prefix, subfield.upper()))
errors = {}
print('galaxy data')
print(galaxy_data)
if not galaxy_data['url']:
for k, v in galaxy_data.items():
if v:
setting_name = 'PRIVATE_GALAXY_{}'.format(k.upper())
setting_name = '{}{}'.format(prefix, k.upper())
errors.setdefault(setting_name, [])
errors[setting_name].append(_(
'Cannot provide field if PRIVATE_GALAXY_URL is not set.'
'Cannot provide field if PRIMARY_GALAXY_URL is not set.'
))
if (galaxy_data['password'] or galaxy_data['username']) and galaxy_data['token']:
for k in ('password', 'username', 'token'):
setting_name = 'PRIVATE_GALAXY_{}'.format(k.upper())
setting_name = '{}{}'.format(prefix, k.upper())
if setting_name in attrs:
errors.setdefault(setting_name, [])
errors[setting_name].append(_(
'Setting PRIVATE_GALAXY_TOKEN is mutually exclusive with '
'PRIVATE_GALAXY_USERNAME and PRIVATE_GALAXY_PASSWORD.'
'Setting PRIMARY_GALAXY_TOKEN is mutually exclusive with '
'PRIMARY_GALAXY_USERNAME and PRIMARY_GALAXY_PASSWORD.'
))
if errors:

4
awx/main/redact.py
View File

@ -12,8 +12,8 @@ class UriCleaner(object):
@staticmethod
def remove_sensitive(cleartext):
if settings.PRIVATE_GALAXY_URL:
exclude_list = (settings.PUBLIC_GALAXY_URL, settings.PRIVATE_GALAXY_URL)
if settings.PRIMARY_GALAXY_URL:
exclude_list = (settings.PUBLIC_GALAXY_URL, settings.PRIMARY_GALAXY_URL)
else:
exclude_list = (settings.PUBLIC_GALAXY_URL,)
redactedtext = cleartext

11
awx/main/tasks.py
View File

@ -1884,18 +1884,17 @@ class RunProjectUpdate(BaseTask):
env['PROJECT_UPDATE_ID'] = str(project_update.pk)
env['ANSIBLE_CALLBACK_PLUGINS'] = self.get_path_to('..', 'plugins', 'callback')
# If private galaxy URL is non-blank, that means this feature is enabled
private_galaxy_url = settings.PRIVATE_GALAXY_URL
if private_galaxy_url:
if settings.PRIMARY_GALAXY_URL:
# set up the fallback server, which is the normal Ansible Galaxy
env['ANSIBLE_GALAXY_SERVER_GALAXY_URL'] = 'https://galaxy.ansible.com'
env['ANSIBLE_GALAXY_SERVER_GALAXY_URL'] = settings.PUBLIC_GALAXY_URL
for key in ('url', 'username', 'password', 'token'):
setting_name = 'PRIVATE_GALAXY_{}'.format(key.upper())
setting_name = 'PRIMARY_GALAXY_{}'.format(key.upper())
value = getattr(settings, setting_name)
if value:
env_key = 'ANSIBLE_GALAXY_SERVER_PRIVATE_GALAXY_{}'.format(key.upper())
env_key = 'ANSIBLE_GALAXY_SERVER_PRIMARY_GALAXY_{}'.format(key.upper())
env[env_key] = value
# now set the precedence
env['ANSIBLE_GALAXY_SERVER_LIST'] = 'private_galaxy,galaxy'
env['ANSIBLE_GALAXY_SERVER_LIST'] = 'primary_galaxy,galaxy'
return env
def _build_scm_url_extra_vars(self, project_update):

8
awx/settings/defaults.py
View File

@ -623,10 +623,10 @@ AWX_ROLES_ENABLED = True
AWX_COLLECTIONS_ENABLED = True
# Settings for private galaxy server, should be set in the UI
PRIVATE_GALAXY_URL = ''
PRIVATE_GALAXY_USERNAME = ''
PRIVATE_GALAXY_TOKEN = ''
PRIVATE_GALAXY_PASSWORD = ''
PRIMARY_GALAXY_URL = ''
PRIMARY_GALAXY_USERNAME = ''
PRIMARY_GALAXY_TOKEN = ''
PRIMARY_GALAXY_PASSWORD = ''
# Public Galaxy URL, not configurable outside of file-based settings
PUBLIC_GALAXY_URL = 'https://galaxy.ansible.com'

16
awx/ui/client/src/configuration/forms/jobs-form/configuration-jobs.form.js
View File

@ -67,23 +67,23 @@ export default ['i18n', function(i18n) {
AWX_COLLECTIONS_ENABLED: {
type: 'toggleSwitch',
},
PRIVATE_GALAXY_URL: {
PRIMARY_GALAXY_URL: {
type: 'text',
reset: 'PRIVATE_GALAXY_URL',
reset: 'PRIMARY_GALAXY_URL',
},
PRIVATE_GALAXY_USERNAME: {
PRIMARY_GALAXY_USERNAME: {
type: 'text',
reset: 'PRIVATE_GALAXY_USERNAME',
reset: 'PRIMARY_GALAXY_USERNAME',
},
PRIVATE_GALAXY_PASSWORD: {
PRIMARY_GALAXY_PASSWORD: {
type: 'sensitive',
hasShowInputButton: true,
reset: 'PRIVATE_GALAXY_PASSWORD',
reset: 'PRIMARY_GALAXY_PASSWORD',
},
PRIVATE_GALAXY_TOKEN: {
PRIMARY_GALAXY_TOKEN: {
type: 'sensitive',
hasShowInputButton: true,
reset: 'PRIVATE_GALAXY_TOKEN',
reset: 'PRIMARY_GALAXY_TOKEN',
},
AWX_TASK_ENV: {
type: 'textarea',