awx icon indicating copy to clipboard operation
awx copied to clipboard

AWX documentation on creating Custom credential types is off

Open markocelan opened this issue 5 months ago • 0 comments

Please confirm the following

  • [X] I agree to follow this project's code of conduct.
  • [X] I have checked the current issues for duplicates.
  • [X] I understand that AWX is open source software provided for free and that I might not receive a timely response.
  • [X] I am NOT reporting a (potential) security vulnerability. (These should be emailed to [email protected] instead.)

Bug Summary

While reading documentation https://ansible.readthedocs.io/projects/awx/en/latest/userguide/credential_types.html#create-a-new-credential-type one would be mislead to use awx for prefix in Injector templating, but the working prefix is tower as described in Ansible Automation platform (aka Tower) documentation. image

Weird thing is that in the code ( https://github.com/ansible/awx/blob/devel/docs/credentials/custom_credential_types.md ) there's also tower described as the prefix , so I suspect it must come from some kind of find&replace during documentation generation.

AWX version

24.6.1

Select the relevant components

  • [ ] UI
  • [ ] UI (tech preview)
  • [ ] API
  • [X] Docs
  • [ ] Collection
  • [ ] CLI
  • [ ] Other

Installation method

kubernetes

Modifications

no

Ansible version

2.17.1

Operating system

Linux

Web browser

Firefox

Steps to reproduce

Try to create Custom Credential Type with injector configuration template using example from https://ansible.readthedocs.io/projects/awx/en/latest/userguide/credential_types.html#create-a-new-credential-type

Expected results

New Custom Credential Type is created as showed in documentation

Actual results

UI returns an error: MY_CERT_INI_FILE uses an undefined field ('awx' is undefined)

Additional information

Either documentation needs fixing or AWX should honor awx prefix as described in current documentation

markocelan avatar Sep 16 '24 08:09 markocelan