diff --git a/.github/workflows/README.md b/.github/workflows/README.md index bca5a3c..ab7adbc 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -1,6 +1,6 @@ # GitHub Actions ## Background -We want to make attempts to run our integration tests in the same manner wether using GitHub actions or on a developers's machine locally. For this reason, the tests are curated to run using conatiner images. As of this writing, two images exist which we would like to test against: +We want to make attempts to run our integration tests in the same manner wether using GitHub actions or on a developers's machine locally. For this reason, the tests are curated to run using container images. As of this writing, two images exist which we would like to test against: - quay.io/ansible-product-demos/apd-ee-24:latest - quay.io/ansible-product-demos/apd-ee-25:latest diff --git a/.gitignore b/.gitignore index 7157c0d..9881cc9 100644 --- a/.gitignore +++ b/.gitignore @@ -13,3 +13,4 @@ roles/* .cache/ .ansible/ **/tmp/ +execution_environments/context/ diff --git a/README.md b/README.md index bd50a9b..cfd5866 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ -[![Lab](https://img.shields.io/badge/Try%20Me-EE0000?style=for-the-badge&logo=redhat&logoColor=white)](https://red.ht/aap-product-demos) -[![Dev Spaces](https://img.shields.io/badge/Customize%20Here-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)](https://workspaces.openshift.com/f?url=https://github.com/ansible/product-demos) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit) +[![Dev Spaces](https://img.shields.io/badge/Customize%20Here-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)](https://workspaces.openshift.com/f?url=https://github.com/ansible/product-demos) -# Official Ansible Product Demos +# APD - Ansible Product Demos -This is a centralized location for Ansible Product Demos. This project is a collection of use cases implemented with Ansible for use with the [Ansible Automation Platform](https://www.redhat.com/en/technologies/management/ansible). +The Ansible Product Demos (APD) project is a set of Ansible demos that are deployed using [Red Hat Ansible Automation Platform](https://www.redhat.com/en/technologies/management/ansible). It uses configuraton-as-code to create AAP resources such as projects, templates, and credentials that form the basis for demonstrating automation use cases in several technology domains: | Demo Name | Description | |-----------|-------------| @@ -15,54 +14,21 @@ This is a centralized location for Ansible Product Demos. This project is a coll | [OpenShift](openshift/README.md) | OpenShift automation demos | | [Satellite](satellite/README.md) | Demos of automation with Red Hat Satellite Server | -## Contributions - -If you would like to contribute to this project please refer to [contribution guide](CONTRIBUTING.md) for best practices. - ## Using this project -This project is tested for compatibility with the [demo.redhat.com Ansible Product Demos](https://demo.redhat.com/catalog?search=product+demos&item=babylon-catalog-prod%2Fopenshift-cnv.aap-product-demos-cnv.prod) lab environment. To use with other Ansible Automation Platform installations, review the [prerequisite documentation](https://github.com/ansible/product-demos-bootstrap). +Use the [APD bootstrap](https://github.com/ansible/product-demos-bootstrap) repo to add APD to an existing Ansible Automation Platform deployment. The bootstrap repo provides the initial manual prerequisite steps as well as a playbook for adding APD to the existing deployment. -> NOTE: demo.redhat.com is available to Red Hat Associates and Partners with a valid account. - -1. First you must create a credential for [Automation Hub](https://console.redhat.com/ansible/automation-hub/) to successfully sync 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. Don't forget to click **Save**!! - - > You can also use an execution environment for disconnected environments. To do this, you must disable collection downloads in the Controller. This can be done in `Settings` > `Job Settings`. This setting prevents the controller from downloading collections listed in the [collections/requirements.yml](collections/requirements.yml) file. - -2. If it is not already created for you, add an Execution Environment called `product-demos` - - - Name: product-demos - - Image: quay.io/acme_corp/product-demos-ee:latest - - Pull: Only pull the image if not present before running - -3. If it is not already created for you, create a Project called `Ansible Product Demos` with this repo as a source. NOTE: if you are using a fork, be sure that you have the correct URL. Update the project. - -4. Finally, Create a Job Template called `Setup` with the following configuration: - - - Name: Setup - - Inventory: Demo Inventory - - Exec Env: product-demos - - Playbook: setup_demo.yml - - Credentials: - - Type: Red Hat Ansible Automation Platform - - Name: Controller Credential - - Extra vars: - - demo: +For Red Hat associates and partners, there is an Ansible Product Demos catalog item [available on demo.redhat.com](https://red.ht/apd-sandbox) (account required). ## Bring Your Own Demo Can't find what you're looking for? Customize this repo to make it your own. 1. Create a fork of this repo. -2. Update the URL of the `Ansible Project Demos` in the Controller. -3. Make changes as needed and run the **Product Demos | Single demo setup** job +2. Update the URL of the `Ansible Project Demos` project your Ansible Automation Platform controller. +3. Make changes to your fork as needed and run the **Product Demos | Single demo setup** job -See the [contribution guide](CONTRIBUTING.md) for more details on how to customize the project. +See the [contributing guide](CONTRIBUTING.md) for more details on how to customize the project. ---