4.9.1 JP1/AJS3

The linkage templates allow Ops I to be linked with JP1/AJS3 job management functions and execute JP1/AJS3 jobs from Ops I workflows.
For linkage with JP1/AJS3, Ops I provides the following. (These are hereinafter collectively referred to as “linkage templates”.)

• YAML files for the Workflow etc. that define what to execute for JP1/AJS3 jobs
• Provided Ops I components used for defining the Workflow
• Playbooks that implement linkage with JP1/AJS3

For information on the provided YAML files, see “Obtaining and registering linkage templates”. For information on playbooks, see Step 5 in “Registering authentication information and job templates with AWX”. The following is a list of the provided Ops I components.

(Table) Provided Ops I components (for JP1/AJS3 linkage)

There are two types of parameters of the provided Ops I components: one that is defined in the workflow YAML file and one that is entered via the GUI when the workflow is executed. Follow the following instructions.

(Figure) Flow of JP1/AJS3 linkage template execution

The flow of JP1/AJS3 linkage template execution is as follows.
For Steps ①, ②, and ③, the JP1/AJS3 linkage templates are used. The playbook for Steps ① and ③ can be customized according to what to execute.

(1) Prerequisites

Users who execute the linkage templates must be granted necessary roles.
For details on the Ops I roles, see “OPS I Roles”.

JP1/AJS3 must meet the following prerequisites. These prerequisites are the same as the linkage with JP1/IM “Monitoring deterrence”.

(Table) Prerequisites for JP1/AJS3 (on-premise)

(2) Settings for executing JP1/AJS3 linkage templates

The settings for JP1/AJS3 linkage template execution are as follows.
The following settings need to be made.

[a. Setting a relay server]

Configure the connection settings between the AWX instance group and the relay server. (See “Setting a relay server”.)
After the connection settings are configured, confirm that the status of the node for the relay server shows “Ready” on the node list window.

[b. Creating AWX “organizations”]

Create AWX “organizations” necessary to use AWX. (See “Organization management”.)

[c. Saving JP1/AJS3 connection/authentication information in Secret Management]

First, obtain authentication information for accessing the Secret from Automation (AWX). See “Obtaining authentication information for accessing the Secret from Automation” for how to create it.
Next, register secret information required to run the provided Ops I components for the organizations created at “Creating AWX “organizations””. The following shows the secret information settings required for each application.
For information on creating secrets engines and secrets, see the following.

• Secrets engine: “Creating a secrets engine”.
• Secret: “Creating a secret”
  

[d. Registering authentication information and job templates with AWX]

Configure the following AWX settings required to execute the JP1/AJS3 linkage templates. (See “Automation”.)

Item	Description
Name	Enter an arbitrary name. The default values defined for the provided Ops I components are as follows. When changing the job template name, ensure that it matches the job template name defined in the Workflow YAML file for each component. Provided Ops I component Job template name ajs.cancel_exec_schedule AJS Cancel Exec Schedule ajs.change_hold AJS Change Hold ajs.change_start_time AJS Change Start Time ajs.interrupt AJS Interrupt ajs.kill AJS Kill ajs.register_fixed_exec AJS Register Fixed Exec ajs.register_immediate_exec AJS Register Immediate Exec ajs.register_planned_exec AJS Register Planned Exec ajs.rerun AJS Rerun ajs.show AJS Show The following job template is provided for checking Jobnet execution results, etc. and is defined in the Workflow YAML file of each component by default. Job template name: AJS Show
Job type	Select "execution".
Inventory	Click the icon and select the inventory registered at Step 3 above.
Project	Click the icon and select the project registered at Step 2 above.
Execution environment, instance group, and authentication information	Make settings referring to "Using a relay server".
Playbook	Set the playbook for the JP1/AJS3 job template for the provided components that you wish to execute, which is registered in the "system" repository for the "system" group. Make settings referring to the playbook name in "(Table) List of actions (provided Ops I components for JP1/AJS3 coordination)". When customizing the playbook, download it from the "system" repository for the "system" group, customize it, push it to any repository in Ops I (for which YAML file management is enabled), and then set the customized playbook as the job template.
Startup prompt	Select the [Authentication Information] and [Variables] checkboxes.

(3) Obtaining and registering linkage templates

To execute the JP1/AJS3 linkage templates, obtain the templates and register them in the repository. For the JP1/AJS3 linkage templates, a zip file containing the YAML files for the Workflow, Catalog, UI, and Datamodel are stored in GitLab. Each of the YAML files defines what to execute for JP1/AJS3 jobs. Users can customize jobs to execute, secret information, etc. as needed.

[Obtaining the JP1/AJS3 linkage templates]

Obtain the JP1/AJS3 linkage templates from the following location in GitLab. The “system” repository appears in the [Explore] tab of the Git application.

(Table) Location and file name of the JP1/AJS3 linkage templates

[Definitions in the Workflow YAML file]

To execute the provided Ops I components from the workflow, define the provided Ops I components for “action” and parameters for “input” in the Workflow YAML file as follows. For each parameter, define the secret information created in “Creating a secret”. Always use the latest version of the secret.
For details on the provided Ops I components and parameters, see “(Table) List of actions (provided Ops I components for JP1/AJS3 coordination)”.

(Table) Definitions of “action” and “input” for the Workflow

[Registering the YAML files in the repository]

Register the Workflow YAML file that defines the provided Ops I components to execute and the obtained Catalog, UI, and Datamodel YAML files in any repository. YAML file management must be enabled for the repository. For information on YAML file management in repositories, see “Repository management”. The directories in the destination repository must be the same as the folder structure of the obtained JP1/AJS3 linkage templates. The directory structure of the repository is as follows.

(Figure) Directory structure of the repository for linkage with JP1/AJS3

(4) Executing linkage templates and checking results

Execute the JP1/AJS3 linkage templates from the service catalog registered in “Obtaining and registering linkage templates”.
The details of each execution step are shown below, using the case of “Registering Jobnet immediate execution” as an example. For details on the information to input and information displayed, see “Input fields on workflow details window”.

(Table) Details of each execution step

(5) Input fields on workflow details window

The input items on the workflow details window are as follows. In these input fields, the parameters for the provided Ops I components are displayed.
Depending on the provided Ops I component or step to be executed, the displayed items vary and the fields become editable or uneditable.

Details of the items that the requester enters are as follows.

(Table) Input fields for requester

Details of other items are as follows.

(Table) Other items