Skip to content

Latest commit

 

History

History
127 lines (83 loc) · 5.96 KB

README.md

File metadata and controls

127 lines (83 loc) · 5.96 KB
Raw

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

  1. Clone the galaxy_ng repo and follow the instructions for starting up the API.
  2. Install node. Node v13+ are known to work. Older versions may work as well.
  3. npm install
  4. 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 console.redhat.com. This is done by accessing the app via the insights-proxy project.

Set up Insights Proxy

  • Install docker
  • Clone this repo [email protected]: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

  1. npm install
  2. npm run start

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

Deploying

We're using Github Actions for deployment.

How it works

The Github Action invokes the RedHatInsights/insights-frontend-builder-common//bootstrap.sh script, which builds the local branch and pushes the results to RedHatInsights/ansible-hub-ui-build. There, a separate Jenkins process awaits.

  • any push to the master branch will deploy to ansible-hub-ui-build branches ci-beta and qa-beta

  • any push to the master-stable branch will deploy to ansible-hub-ui-build branches ci-stable and qa-stable

  • any push to the prod-beta branch will deploy to a ansible-hub-ui-build prod-beta branch

  • any push to the prod-stable branch will deploy to a ansible-hub-ui-build prod-stable branch

  • the ansible-hub-ui-build master branch is not used, as PRs against master end up in ci-beta and qa-beta

  • ci-beta builds end up on ci.console.redhat.com/beta

  • ci-stable builds end up on ci.console.redhat.com

  • qa-beta builds end up on qa.console.redhat.com/beta

  • qa-stable builds end up on qa.console.redhat.com

  • prod-beta builds end up on console.redhat.com/beta

  • prod-stable builds end up on console.redhat.com

Workflows

List of all workflows:

  • backported-labels: Add a backported-* label when a PR is backported to stable-*; on patchback merges
  • cypress: Run Cypress integration tests; on PRs, pushes and cron
  • deploy-cloud: Deploy to c.r.c; when the relevant branch is updated
  • dev-release: Build and upload to github releases, update dev tag; when master is updated
  • stable-release: Build and upload to github releases; when a stable release is created
  • update-manifest: Update https://github.com/RedHatInsights/manifests ; when master is updated

List by branches:

  • master: backported-labels, cypress, deploy-cloud, dev-release, stable-release, update-manifest
  • master-stable: deploy-cloud
  • prod-beta: deploy-cloud
  • prod-stable: deploy-cloud
  • stable-4.2: backported-labels, stable-release
  • stable-4.3: backported-labels, cypress, stable-release

Patternfly

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.