/example-credential-plugin

Primary LanguagePythonApache License 2.0Apache-2.0

AWX Credential Plugin Example

This is an example credential plugin for AWX. For more details, see the development documentation for credential plugins.

Installation

Installing credential plugins in this way is an advanced feature for admin users who wish to customize their installation. It is critically important that you create a backup of your system and verify that you can restore your system from that backup before proceding any further.

  1. Backup your system and be prepared to restore.
  2. Install the plugin to your awx virtualenv. The precise location of this virtualenv varies based on deployment, so consult the product or project documentation.
source /venv/awx/bin/activate
pip install git+https://github.com/jakemcdermott/example-credential-plugin.git
  1. Activate the plugin
awx-manage shell -c "from awx.main.models import CredentialType; CredentialType.setup_tower_managed_defaults()"

Usage

After installing the credential plugin, it will be loaded automatically by the web interface.

Preview of Credential Plugin

See product documentation for more information on usage.