From e88b24101503930ea97714bfcafd3d1830dca3eb Mon Sep 17 00:00:00 2001 From: willtome Date: Mon, 14 Feb 2022 11:07:00 -0500 Subject: [PATCH] add readme --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 033ebd6..d861e58 100644 --- a/README.md +++ b/README.md @@ -15,3 +15,28 @@ This is a centralized location for all Ansible Product Demos going forward. Please push contributions via a pull request following the naming convention of name-of-demo. [![GitHub Super-Linter](https://github.com/ansible/ansible-demos/workflows/Lint%20Code%20Base/badge.svg)](https://github.com/marketplace/actions/super-linter) + + +## Using this project + +1. First you must create a credential to access Automation Hub to load the collections used by this project. + + 1. In the Credentials section of the Controller UI, add a new Credential called `Automation Hub` with the type `Ansible Galaxy/Automation Hub API Token` + 2. You can obtain a token [here](https://console.redhat.com/ansible/automation-hub/token). This page will also provide the Server URL and Auth Server URL. + 3. Next, click on Organizations and edit the `Default` organization. Add your `Automation Hub` credential to the `Galaxy Credentials` section. + +2. If it has not been created for you, add a Project called `Ansible official demo project` with this repo as a source. NOTE: if you are using a fork, be sure that you have the correct URL. Update the project. +3. Finally, Create a Job Template called `Setup` with the following configuration: + + - Name: Setup + - Inventory: Workshop Inventory + - Exec Env: Control Plane EE + - Playbook: setup_demo.yml + - Credentials: + + - Type: Red Hat Ansible Automation Platform + - Name: Controller Credential + - Extra vars: + + demo: linux +