Skip to content

Getting Started

Pre-requisites:

  • docker
  • docker-compose
  • Instance of Red Hat Ansible Automation Platform or AWX

Deploy Squest

The current deployment is based on Docker Compose. To run the application, execute the docker-compose.yml file: 

docker-compose up

Then connect with your web browser to http://127.0.0.1:8080 The default admin account is admin // admin

The default export the port 8080. If you want to use the standard HTTP port 80, update the file docker-compose.override.yml. 

services:
  nginx:
    ports:
      - "80:8080"

Connect Squest to your controller

The first step consist into adding a backend controller (RHAAP/AWX). In the left sidebar of Squest, go into the Administration group, look for the RHAAP/AWX item and follow the steps described in the administration documentation to add your controller.

Once added, all Job templates present on the controller should appear in Squest.

Create your first service

Go into the Service catalog --> All Services and click on add a new service.

The only mandatory information here is the name.

Note

For more information about the other flags, refer to service documentation.

Once the service created, the next page invite you to create the first operation that will "create" an instance of this service.

In this form, mandatory field are a name and selecting the job template to execute in the controller.

Note

For more information about the other flags, refer to operation documentation.

Request your service

Once the operation configured, the service is available in the catalog. Click on the order button of the service to create a new request.

The first page ask to give an instance name which is a short name that will help you to identify and manage the lifecycle of the instance later. For example my_test_instance.

In the second page, Squest will ask to fill all the variable that are present in the job template survey if one was attached.

The request then appears in the Request tab. Click on the ID of the request to review it.

The request detail page gives information about the current state of the request. From here you can accept, reject, cancel or update the filled fields.

Once the request accepted, it can be processed, which means that the request is sent to the controller to execute the Job template.

What next

You know the basics of Squest. You can now dig into the service catalog documentation to learn the concept of services and operations.

By default, Squest is deployed with a minimum configuration, this one can be customized by following the settings documentation.