Ansible UI

Ansible UI code is housed in this repo and is members listed in the CODEOWNERS. On the devel branch, you can find the most up-to-date stable code for the UI.

UI projects for Ansible.

• Getting Started
• Deployment Types
• Environment Variables
• NPM Scripts
• Documentation
• AI-assisted contributions
• Code of Conduct

Getting Started

1. Prerequisites

   • Node 18.x and up (recommended)
   • NPM 8.x and up (recommended)

   Note: The project should with older versions of node and npm but may require regenerating the package-lock.json.

2. Clone Repository

   git clone git@github.com:ansible/ansible-ui.git

3. Install Package Dependencies

   npm ci

4. cd to Platform directory

   cd platform

5. Set PLATFORM_SERVER variable and then run npm run start to stand up the UI

Environment Variables

Environment Variable	Description
AWX_API_PREFIX	The AWX server API prefix.
EDA_API_PREFIX	The EDA server API prefix.
HUB_API_PREFIX	The HUB or Galaxy server API prefix.
PLATFORM_USERNAME	Username to log in with (ie: 'e2e' or 'dev').
PLATFORM_PASSWORD	The password of your user.
PLATFORM_SERVER	If using a Jenkins build, same as baseUrl above.

export AWX_API_PREFIX='/api/controller/v2'
export EDA_API_PREFIX='/api/eda/v1'
export PLATFORM_SERVER='url of build goes here with no trailing slash'
export PLATFORM_USERNAME='dev'
export PLATFORM_PASSWORD='nomeetingsfriday'

NPM Scripts

From the root of AAP-UI

NPM Script	Description
npm run tsc	Run Typescript compiler checks

From the platform directory of AAP-UI

NPM Script	Description
npm run start	Start Platform. Must run local build.
npm run prettier	Run prettier format checks
npm run prettier:fix	Fix prettier format of files
npm run eslint	Run eslint checks
npm run eslint:fix	Fix linting errors

Documentation

• Development
• Framework - A framework for building applications using PatternFly.
• Handling Errors in Forms - A component for handling forms and errors.

AI-assisted contributions

This project may use AI-assisted development. Contributors may use AI tools and remain responsible for their work. See AI_POLICY.md and the Ansible community AI policy.

Code of Conduct

We follow the Ansible Code of Conduct in all our interactions within this project.

If you encounter abusive behavior, please refer to the policy violations section of the Code for information on how to raise a complaint.

Communication

• Join the Ansible forum:
  • Posts tagged with 'ui': subscribe to participate in UI related conversations.
  • Social Spaces: gather and interact with fellow enthusiasts.
  • News & Announcements: track project-wide announcements including social events. The Bullhorn newsletter, which is used to announce releases and important changes, can also be found here.

For more information about communication, see the Ansible communication guide.

Running Standalone Platform Components (Not Recommended)

NPM Scripts for Standalone Builds

NPM Script	Description
npm --prefix frontend/awx start	Run AWX on http://localhost:4101
npm --prefix frontend/hub start	Run HUB on http://localhost:4102
npm --prefix frontend/eda start	Run EDA on http://localhost:4103

End-to-end tests run with Playwright. See playwright/Playwright.md.

Environment Variables for Standalone Builds

Environment Variable	Description
AWX_SERVER	The AWX server (protocol://host:port).
EDA_SERVER	The EDA server (protocol://host:port).
HUB_SERVER	The HUB server (protocol://host:port).
HUB_API_PREFIX	The HUB server API prefix. (/api/galaxy)
HUB_GALAXYKIT_COMMAND	The galaxykit command. (galaxykit --ignore-certs)

export AWX_SERVER=https://localhost:8043
export EDA_SERVER=http://localhost:8000
export HUB_SERVER=http://localhost:5001