Ansible Automation Hub UI

Frontend for Ansible Automation Hub. The backend for this project can be found here.

Setting up Your Dev Environment

Develop using Docker Compose (Recommended)

This project can now be run as a container alongside the API. Just follow the instructions on the ansibe/galaxy_ng wiki.

Develop without containers

This app can be developed in standalone mode or insights mode. Insights mode compiles the app to be run on the Red Hat cloud services platform (insights) and requires access to the Red Hat VPN as well as the insights proxy. Standalone mode only requires a running instance of the galaxy API for the UI to connect to.

Develop in Standalone Mode

Clone the galaxy_ng repo and follow the instructions for starting up the API.
Install node. Node v13+ are known to work. Older versions may work as well.
npm install
npm run start-standalone

The app will run on http://localhost:8002 and proxy requests for api/automation-hub to the api on http://localhost:5001.

Develop in Insights Mode

NOTE: This option is only available to Red Hat employees who have access to the Red Hat VPN. Community contributors should follow setup for standalone mode

To enable insights mode set DEPLOYMENT_MODE: 'insights' in custom.dev.config.js.

This app is part of the Red Hat cloud platform. Because of that the app needs to be loaded within the context of cloud.redhat.com. This is done by accessing the app via the insights-proxy project.

Set up Insights Proxy

Install docker
Clone this repo git@github.com:RedHatInsights/insights-proxy.git to your machine
Inside the insights-proxy/ directory on your computer, run the following scripts
- npm install
- bash scripts/update.sh This updates the insights proxy container to the latest version.
- sudo bash scripts/patch-etc-hosts.sh This adds the following entries to your /etc/hosts file

127.0.0.1 prod.foo.redhat.com
127.0.0.1 stage.foo.redhat.com
127.0.0.1 qa.foo.redhat.com
127.0.0.1 ci.foo.redhat.com

Once all this is done, you can launch insights-proxy with this command:

SPANDX_CONFIG=/path/to/ansible-hub-ui/profiles/local-frontend-and-api.js bash /path/to/insights-proxy/scripts/run.sh

This should launch insights-proxy, which will redirect the routes defined in profiles/local-frontend-and-api.js to the automation hub UI running locally on your machine.

NOTE

If you are on a Mac, you might have to make a small change to the insights-proxy/scripts/run.sh script. Update this line

REALPATH=`python2 -c 'import os,sys;print os.path.realpath(sys.argv[1])' $SPANDX_CONFIG`

to use python instead of python2.

Run Automation Hub

Once the insights proxy is running, open a new terminal, navigate to your local copy of ansible-hub-ui and execute

npm install
npm run start

To access the app, visit: https://ci.foo.redhat.com:1337/insights/automation-hub

Deploying

The Platform team is using Travis to deploy the application
- The Platform team will help you set up the Travis instance if this is the route you are wanting to take

How it works

any push to the {REPO} master branch will deploy to a {REPO}-build ci-beta branch
any push to the {REPO} master-stable branch will deploy to a {REPO}-build ci-stable branch
any push to the {REPO} qa-beta branch will deploy to a {REPO}-build qa-beta branch
any push to the {REPO} qa-stable branch will deploy to a {REPO}-build qa-stable branch
- qa-{beta|stable} also deploy to cloud.stage.redhat.com
any push to the {REPO} prod-beta branch will deploy to a {REPO}-build prod-beta branch
any push to the {REPO} prod-stable branch will deploy to a {REPO}-build prod-stable branch
Pull requests (based on master) will not be pushed to {REPO}-build master branch
- If the PR is accepted and merged, master will be rebuilt and will deploy to {REPO}-build ci-beta branch

Patternfly

This project imports Patternfly components:
- Patternfly React

Insights Components

Insights Platform will deliver components and static assets through npm. ESI tags are used to import the chroming which takes care of the header, sidebar, and footer.

UI Testing

For more information about UI testing go to test README.

ekmixon/ansible-hub-ui