Before adding a new use case, make yourself familiar with the post installation process.
For new use cases create a new project following the naming convention use-case-XYZ. Make sure to update the configuration-controller to create a job template for the new use case.
The use case project should contain the configuration in the format and structure recognized and supported by the infra.controller_configuration collection. Update the README.md with all necessary instructions to allow others to demonstrate the use case and any prerequisites it may have.
Typically you can add or update your use case content in automation controller, by relaunching the respective job template. or using the following commands:
# set environment variables
. /path/to/config
ansible-navigator run infra.controller_configuration.configure_controller -i /path/to/inventory -e @/path/to/variables -e controller_configs_dir=`pwd`/aap_configuration
As a minimum, the environment variables have to set the values to connect automation controller:
export CONTROLLER_HOST=http://you-controller.example.com:8443
export CONTROLLER_USERNAME=admin
export CONTROLLER_PASSWORD=yourpassword
export CONTROLLER_VERIFY_SSL=true # disable by using "false" instead
If you create a new use case, you should als provide necessary documentation on how the use case is supposed to be executed. If there is a file named HOWTO.md it will automatically be rendered on this web site.
Make sure to follow this markdown formatting to render the page correctly.
# Use Case Example
Make this a level one heading.
This is an example of how use cases should be documented. Make a copy of this file, rename it to `50-my-use-case.md` and update its content.
Every use case should start with a short description. This should also include information about why this is relevant to customers, or which problem we're addressing.
## Prerequisites
Make this a level two heading.
In this chapter we document the technical requirements to demo this use case. This typically includes `extra_vars` which have to be configured, but can also include other requirements like a specific public cloud provider.
## Caveats
Make this a level two heading.
Add any potential challenges or issues in this chapter. For example certain tasks take a long time to complete, known issues or limitations.
## How to use
Make this a level two heading.
This should be a detailed list of what has to be done to demo this use case. Try to find a balance of not going to detailed, but still providing all relevant information to successfully complete the demo. This could include things like which buttons have to be clicked in the automation controller UI, or emphasis certain important points of the demo.
Keep in mind the target audience to demo the use case is SA/SSA level with at least intermediate Ansible and AAP knowledge.
*NOTE:* Any other heading should be level 2 or 3 - only this first heading should be level 1 and is used as a title.