Skip to content

Service

A service in Squest is an item of the catalog. It contains at least one operation to create (or instantiate) the service and multiple day 2 operations to update or delete an already created instance of this service.

Configuration

Name Description
Name Short name of the service
Description Small description of the operation
Image Image used into the catalog
Enabled If set to True the service is visible in the catalog
External support URL Define an external support tool URL
Extra vars Set of extra vars as JSON
Description documentation Markdown documentation linked to the service

External support URL

Squest has an integrated support management. End user can open a support ticket on available instances. An external url can be defined as support tool in each service configuration. This allows to configure for example a redirection to services like GitHub issues or Jira.

The external support URL support jinja templating to insert the current instance metadata as query parameters.

E.g:

http://my_external_tool.domain.local/?instance_name={{ instance.name }}?instance_id={{ instance.id }}?vm_os={{ instance.spec.vm_os }}

Example with Github issue query parameters:

https://github.com/HewlettPackard/squest/issues/new?title=Templated+Github+issue&body=Instance%3A+{{ instance.name }}

Note

Special characters need to be converted into a format that can be transmitted over the Internet. URLs can only be sent over the Internet using the ASCII character-set.

Extra vars

Some extra variables can be declared on some Squest level like tower_server, service or operation.

These extra variables are added automatically when processing a request and so executing a job template.

If an extra variable is set with the same name in different places, the variable will be overridden following a certain order. Squest will apply the following variable precedence:

flowchart LR survey(Request survey) --> RHAAP/AWX(RHAAP/AWX) --> Service(Service) --> Operation(Operation)