vidyanambiar / ansible-hub-ui

Ansible Automation Hub UI

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, community, or insights mode. Insights mode compiles the app to be run on the Red Hat cloud services platform (insights). Standalone mode only requires a running instance of the galaxy API for the UI to connect to. Community mode is similar to standalone, with github login and Roles.

For every mode, you first need to:

1. Clone the galaxy_ng repo and follow the setup instructions
2. Install node. Node v16+ is known to work. Older versions may work as well.
3. npm install in the UI

Develop in Standalone Mode (default)

1. Start the API with COMPOSE_PROFILE=standalone (compose) or COMPOSE_PROFILE=galaxy_ng/base (oci-env)
2. npm run start-standalone

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

Develop in Community Mode

1. Start the API with COMPOSE_PROFILE=standalone-community (compose)
2. npm run start-community

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

Develop in Insights Mode

NOTE: This option is only relevant to Red Hat employees. Community contributors should follow setup for standalone mode

1. Start the API with COMPOSE_PROFILE=insights (compose) or COMPOSE_PROFILE=galaxy_ng/base:galaxy_ng/insights (oci-env)
2. npm run start-insights

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

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 qa-beta branch

• any push to the master branch will ALSO deploy to ansible-hub-ui-build qa-stable branch when .cloud-stage-cron.enabled exists

• 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 qa-beta

• qa-beta builds end up on console.stage.redhat.com/preview (and /beta)

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

• prod-beta builds end up on console.redhat.com/preview (and /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
• cloud-stage-disable: Disable deploy-cloud from master to stage-stable (stage-beta always on); manual
• cloud-stage-enable: Enable deploy-cloud from master to stage-stable (stage-beta always on); manual
• 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
• i18n: Extract and merge l10n strings for 4.4+; cron
• pr-checks: Check for linter errors, obsolete package-lock.json and merge commits; on PRs only
• 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, i18n, pr-checks, stable-release, update-manifest
• prod-beta: deploy-cloud
• prod-stable: deploy-cloud
• stable-4.2: backported-labels, pr-checks, stable-release
• stable-4.4: backported-labels, cypress, pr-checks, stable-release (and i18n via cron from master)
• stable-4.5: backported-labels, cypress, pr-checks, stable-release (and i18n via cron from master)
• stable-4.6: backported-labels, cypress, pr-checks, stable-release (and i18n via cron from master)
• stable-4.7: backported-labels, cypress, pr-checks, stable-release (and i18n via cron from master)

Version mapping

Our branches, backport labels, releases and tags use AAH versions, but Jira uses AAP versions. To map between the two:

AAP version	AAH version
1.2	4.2
2.0	4.3 (obsolete)
2.1	4.4
2.2	4.5
2.3	4.6
2.4	4.7

Patternfly

• This project imports Patternfly components:
  • Patternfly React

Insights Components

Insights Platform will deliver components and static assets through npm. insights-chrome takes care of the header, sidebar, and footer.

UI Testing

For more information about UI testing go to test README.