Ansible-driver Version 1 - GitHub Pages

ITA User instruction manualAnsible-driver－ Version 1.6－

Copyright NEC Corporation 2019. All rights reserved.DisclaimerAll the contents of this document are protected by copyright owned by NEC Corporation.Unauthorized reproduction or copying of all or part of the contents of this document is prohibited.The contents of this document are subject to change without prior notice in the future.NEC Corporation is not responsible for any technical or editorial errors or omissions in this document.NEC Corporation do not guarantee accuracy, usability, certainty of the content in this document.Trademark Linux is registered trademark or trademark of Linus Torvalds, registered in the U.S. and othercountries. Red Hat is registered trademark or trademark of Red Hat, Inc., registered in the U.S. and othercountries. Apache、Apache Tomcat、Tomcat are registered trademarks or trademarks of Apache SoftwareFoundation. Ansible is a registered trademark or trademark of Red Hat, Inc. AnsibleTower is a registered trademark or trademark of Red Hat, Inc.The names of other systems, company name and products mentioned in this document are registeredtrademarks or trademarks of their respective companies.The mark and TM mark is not specified in this document.※「Exastro IT Automation」is written as「ITA」in this document.Exastro-ITA User instruction manual Ansible-driver1 / 116

Table of contentsTable of contents . 2Introduction . 41 Overview of Ansible driver . 51.1About Ansible . 51.2About AnsibleTower . 51.3About Ansible driver . 62 Variable handling in Ansible driver . 72.1Variable type . 72.2Extract variables and register specific values . 102.3Variable handling according to substitution value registration . 113 Ansible driver console menu configuration . 123.1Menu/screen list . 124 Ansible driver operation procedure . 144.1Workflow . 14Workflow of Ansible-Legacy . 14Workflow of Ansible-Legacy Role. 17Workflow of Ansible-Pioneer . 205 Ansible driver function・operation method explanation . 245.1Basic console . 24Device list . 24Input operation list . 285.2Ansible common console . 29Interface information. 29Ansible Tower host list . 34Global variable list . 36Template list. 38File list. 42Collection interface information . 44Collection item value list . 445.3Ansibel-Legacy／Legacy Role／Pioneer console . 45OS type master. 45Movement list . 47Playbook file list (Ansible-Legacy only) . 50Role package list (Ansible-Legacy Role only) . 52Dialog type list (Ansible-Pioneer only) . 54Dialog files (Ansible-Pioneer only) . 55Movement details . 57Nested variable maximum iteration count list (Ansible-Legacy Role only) . 59Substitution value auto-registration setting . 62Target host . 66Substitution value list. 67Check operation status. 73Execution list . 76Execution . 776 How to write construction code . 79Exastro-ITA User instruction manual Ansible-driver2 / 116

6.1Describe Playbook (Ansible-Legacy). 796.2Describe Dialog file (Ansible-Pioneer) . 806.3Describe role package (Ansible-Legacy Role) . 926.4Describe ITA readme (Ansible-Legacy Role only) . 966.5Describe substitution table(Ansible-Legacy Role only) . 986.6BackYard contents . 1016.7Ansible usage guideline ITA additional rules . 1047 Application operation. 1057.1Maintenance . 1057.2About the maintenance method . 1068 Appendix . 1078.1The linkage between the input data used during Ansible execution and ITA menu . 107Ansible-Legacy input data . 108Ansible-Pioneer input data . 110Ansible-LegacyRole input data . 1128.2Result data created during Ansible execution . 114Legacy/LegacyRole List of files saved in result data . 114List of files saved in Pioneer result data . 115Exastro-ITA User instruction manual Ansible-driver3 / 116

IntroductionThis document explains the function and the operation method of ITA.Exastro-ITA User instruction manual Ansible-driver4 / 116

1 Overview of Ansible driverThis chapter explains Ansible, AnsibleTower and Ansible driver.1.1 About AnsibleAnsible is a platform construction automation tool that makes deploying applications/systems to manyconstruction management targets easy.Ansible can implement various operations by describing YAML textfiles called Playbook which recordroutine operations and executing them.Tasks are linked to processing programs called modules, and can control various devices.For the detailed information of Ansible, please refer to the product manual of Ansible.The version of Ansible is 2.2.1.0. Please note that the notation according to the newest Ansible maynot be used.1.2 About AnsibleTowerAnsibleTower is a management platform that extends the function of Ansible, a platform constructionautomation tool such as "access control", "job scheduling", "task visualization", etc.Ansible can combine "project", "inventory", "credentials" to create "job template" and execute withAnsible.By combining multiple "Job Templates" to create a "Workflow Job Template", a more diverse workflowcan be expressed.For the detailed information of AnsibleTower, please refer to the product manual of AnsibleTower.For the ITA compatible AnsibleTower version, please refer to "System Configuration/EnvironmentConstruction Guide-Ansible-driver".Please note that the notation according to the newest version may not be used.Exastro-ITA User instruction manual Ansible-driver5 / 116

1.3 About Ansible driverAnsible driver operates as options of ITA system. Ansible driver selects using Ansible or AnsibleTowerand perfom actual operation configuration automatically according to each construction target server,storage, network device registered on ITA system.The following 3 modes are available in Ansible driver according to the usage.① Legacy modeConfigure settings to various hosts using the standard function of Ansible.Register the construction code in a single YAML file and construct the operation pattern with thatcombination.This mode is assumed to be used in works such as environment configuration of operation systemand network② Legacy Role modeSimilar with the Legacy mode, configure settings to various hosts using the standard function ofAnsible.Register construction code as package and construct work pattern with the combination of Role.It is assumed that this mode will be used when using the Role package provided by the productdepartment to install product or construct environment, etc.③ Pioneer modePossible to add individual module to Ansible and input setting in interactive mode.Supports all devices that can login using Telnet or SSH, regardless of server, storage ornetwork device.Since interacting with target device directly is required, appropriate IT skills are required.In addition, Ansible driver can configure the variables in Playbook from screen. For details pleaserefer to "Variable handling in Ansible driver" in this manual.Exastro-ITA User instruction manual Ansible-driver6 / 116

2 Variable handling in Ansible driver2.1 Variable typeAnsible driver can set the specific value of Playbook variable in the setting screen in ITA.※For the detail of setting method, please refer to "5.3.11Substitution value list" in this manualThe six types of Playbook variable that can be handled as ITA variable are as below.Table2.1 variable typeTypeNormal variableContentLegacyLegacyPioneer RoleA variable that can define one specific value to the {{ VAR xxx }}. :half-width space xxx: half-width alphanumeric characterand underscore ( )e.g.)VAR users:rootMultiple specificA variable that can define multiple specific value for avalue variablevariable name.Please describe the variable in Playbook as {{ VAR xxx }}. :half-width space xxx: half-width alphanumeric characterand underscore( )e.g.)VAR users:- root- mysqlNested variableHierarchical variables.Please describe the variable in Playbook as {{ VAR xxx }}. :half-width space xxx: half-width alphanumeric characterand underscore( )e.g.)VAR users:- user name: aliceauthorized: passwordThe member variable name canuse ascii characters (0x20 0x7e) except for the following 7characters.".[]' :For more information, please seeYaml syntax.Exastro-ITA User instruction manual Ansible-driver7 / 116

Global variableVariable registered from the "Global variable" menu.TypeContent LegacyPioneer LegacyRoleOriginal variable defined by ITA.The following items in the basic console device list can behandled as variables.Item namevariable namehost nameloginhostnameprotocolloginprotocollogin user IDloginuserlogin passwordloginpasswordThe 「 」 surrounding the variable name is a pair of 2 halfwidth underscore.For “device list”, please refer to "User instruct manual basicconsole"Operations when executing can be handled as the followingvariable.Item nameVariable nameOperationoperationSetting value : Scheduled date/time for execution「YYYY/MM/DD HH:MM」 operationID : operation nameITA originalvariableDirectory path when executing can be handled as thefollowing variable.Item nameVariable nameOperation directory pathworkflowdirBy creating a file under the operation directory path inPlaybook, users can download the result data file of "operationexecution" menu.The directory path shared by each Movement duringSymphony execution can be handled as following variable.Item nameSymphonyOperation directory pathVariable namesymphony workflowdirBy creating files under the Symphony operation directory pathin Playbook, files can be shared between each Movement.Also, when operation is executed from ansible driver,workflowdir will be set to same path.The directory path shared by each Movement duringConducror execution can be handled as following variable.Item nameVariable nameConductorconductor workflowdirExastro-ITA User instruction manual Ansible-driver8 / 116

Operation directory pathBy creating files under the Conductor operation directory pathin Playbook, files can be shared between each Movements.Also, when operation is executed from ansible driver,workflowdir will be set to same path.Each file path of the collect function can be handled as thefollowing variables.Item nameVariable nameOperationdirectory (in)「 parameters」parameters dir for epcpathOperationdirectory (in)「 parameters file」parameters file dir for epcpathOperation resultdirectory (out)「 parameters」parameter dirpathOperation resultdirectory (out)「 parameters file」parameters file dirpath「 parameters」 : Source file (parameter) for storagedestination.「 parameters」: Collected file for storage destination.※File placement when the target of the parameter is a fileupload collumn.For more information about the collect function, please refer tothe "ITA User Instruction Manual Collect function".Variable "LCA XXX" that used to handle variables in DefaultsSubstitutionvariablevariable definition file or ITA readme other than "VAR XXX"type in ITA. For details, please refer to "6.5 Describe substitution table(Ansible-Legacy Role only)".Exastro-ITA User instruction manual Ansible-driver9 / 116