OO Shell for Authoring (OOSHA) User Guide

Transcription

1 Operatins Orchestratin Sftware Versin: Windws and Linux Operating Systems OO Shell fr Authring (OOSHA) User Guide Dcument Release Date: Nvember 2016 Sftware Release Date: Nvember 2016

2 Legal Ntices Warranty The nly warranties fr Hewlett Packard Enterprise prducts and services are set frth in the express warranty statements accmpanying such prducts and services. Nthing herein shuld be cnstrued as cnstituting an additinal warranty. Hewlett Packard Enterprise shall nt be liable fr technical r editrial errrs r missins cntained herein. The infrmatin cntained herein is subject t change withut ntice. Restricted Rights Legend Cnfidential cmputer sftware. Valid license frm Hewlett Packard Enterprise required fr pssessin, use r cpying. Cnsistent with FAR and , Cmmercial Cmputer Sftware, Cmputer Sftware Dcumentatin, and Technical Data fr Cmmercial Items are licensed t the U.S. Gvernment under vendr's standard cmmercial license. Cpyright Ntice Hewlett Packard Enterprise Develpment LP Trademark Ntices Adbe is a trademark f Adbe Systems Incrprated. Micrsft and Windws are U.S. registered trademarks f Micrsft Crpratin. UNIX is a registered trademark f The Open Grup. This prduct includes an interface f the 'zlib' general purpse cmpressin library, which is Cpyright Jean-lup Gailly and Mark Adler. Dcumentatin Updates T check fr recent updates r t verify that yu are using the mst recent editin f a dcument, g t: This site requires that yu register fr an HP Passprt and t sign in. T register fr an HP Passprt ID, click Register n the HPE Sftware Supprt site r click Create an Accunt n the HP Passprt lgin page. Yu will als receive updated r new editins if yu subscribe t the apprpriate prduct supprt service. Cntact yur HPE sales representative fr details. HPE Operatins Orchestratin (10.70) Page 2 f 18

3 OO Shell fr Authring (OOSHA) User Guide Cntents Intrductin 4 Installing OOSHA 4 Running HPE OO Authring Cmmands frm the Cmmand Line 5 Creating Cntent Packs via OOSHA 9 HPE Operatins Orchestratin (10.70) Page 3 f 18

4 OO Shell fr Authring (OOSHA) User Guide Intrductin Intrductin The Operatins Orchestratin Shell Authring (OOSHA) utility lets yu run HPE OO cmmands frm the cmmand line, instead f frm the Studi 10.x interface. This enables yu t autmate sme f yur HPE OO authring prcesses. Imprtant: In rder t create and write t the sha lg file (<sha_installatin_ flder>/lgs/sha.lg) in the installatin flder, yu must run OOSHA with write permissins. Installing OOSHA There are tw ways t install OOSHA: As a standalne package Within an HPE OO installatin (as f versin 10.60) Install a Standalne OOSHA 1. Dwnlad the sha.zip file. 2. Unzip the sha.zip file t the desired lcatin. 3. T start OOSHA, navigate t the bin flder, and run the sha.bat executable file fr the Windws perating system r the sha.sh executable file fr the Linux perating system. Install OOSHA within HPE OO 1. OOSHA is installed and uninstalled with HPE OO Studi. 2. T start OOSHA, navigate t <_installatin_flder>/studi/tls, and run the sha.bat executable file fr the Windws perating system r the sha.sh executable file fr the Linux perating system. HPE Operatins Orchestratin (10.70) Page 4 f 18

5 OO Shell fr Authring (OOSHA) User Guide Running HPE OO Authring Cmmands frm the Cmmand Line Running HPE OO Authring Cmmands frm the Cmmand Line Run authring cmmands Yu can run cmmands within the OOSHA utility r frm a nrmal prmpt/shell. 1. Start the OOSHA shell: Navigate t <_installatin_flder>/studi/tls, and run the sha.bat executable file fr the Windws perating system r the sha.sh executable file fr the Linux perating system. Nte: : In a standalne OOSHA installatin, <sha_instalatin_flder> is the lcatin where the sha.zip file was unzipped. In an installatin f HPE OO, <sha_instalatin_ flder> is <_installatin_flder>/studi/tls. After yu have run the executable file, the OOSHA shell appears. 2. Type the cmmand in the fllwing frmat: <cmmandname> --<parametername1> <parametervalue1> --<parametername2> <parametervalue2> Sme f the available cmmands are: createcp - enables yu t package a cntent pack. Fr details, see "Creating Cntent Packs via OOSHA" n page 9 help - displays a list and descriptin f all available cmmands HPE Operatins Orchestratin (10.70) Page 5 f 18

6 OO Shell fr Authring (OOSHA) User Guide Running HPE OO Authring Cmmands frm the Cmmand Line exit, quit - exits OOSHA cls, clear - clears the cnsle system prperties - displays the OOSHA system prperties date - displays the current date versin - displays the current versin f OOSHA 3. Yu can run cmmands frm a nrmal prmpt/shell using the OOSHA utility by passing arguments t the sha.bat r sha.sh files respectively. Examples: sha.bat createcp --prjectflder C:\Users\User1\.\Wrkspace\prject1 -- versin 7./sha.sh createcp --prjectflder '/hme/user1/./wrkspace/my prject' - -destinatinflder /tmp/cps --descriptin 'test cntent pack' --publisher 'the publisher' --versin 1.9 Display Help in OOSHA T display a list and descriptin f all available cmmands in the OOSH utility, type: help T display help abut a particular cmmand, type: help <cmmand> Fr example: help createcp HPE Operatins Orchestratin (10.70) Page 6 f 18

7 OO Shell fr Authring (OOSHA) User Guide Running HPE OO Authring Cmmands frm the Cmmand Line T display a list f arguments fr a valid cmmand that has at least ne argument, type: <cmmand> Fr example: createcp Navigate the cmmand histry Use the Up arrw key r Dwn arrw key n yur keybard t navigate inside the cmmand histry fr OOSHA. The Up arrw key histry navigates ne item back in the histry f cmmands. The Dwn arrw key navigates ne item frward in the histry f cmmands. Trublesht OOSHA The OOSHA applicatin lgs are stred inside the <sha_instalatin_flder>/lgs flder. By default, under the lgs flder, there are tw lg files: sha.lg and maven.lg. Change the OOSHA lg lcatin (sha.lg) 1. Lcate the lg4j.prperties file at <sha_instalatin_flder>/cnf/lg4j.prperties. 2. Lcate the fllwing line inside the lg4j.prperties file: lg4j.appender.file=rg.apache.lg4j.rllingfileappender HPE Operatins Orchestratin (10.70) Page 7 f 18

8 OO Shell fr Authring (OOSHA) User Guide Running HPE OO Authring Cmmands frm the Cmmand Line 3. Belw that line, add the fllwing line: lg4j.appender.file.file=<abslute path f the sha.lg file> Fr example: lg4j.appender.file.file=c:/lgs/sha.lg 4. Save the lg4.prperties file and start the OOSHA shell. Change the Maven lg lcatin (maven.lg) 1. Lcate the sha.prperties file at <sha_instalatin_flder>/cnf/sha.prperties. 2. Edit the sha.prperties file by setting the sha.lgs.lcatin.maven prperty with the value f the abslute path f the maven.lg file Fr example: sha.lgs.lcatin.maven=c:/lgs/maven.lg 3. Save the sha.prperties file and start the OOSHA shell. Cnfigure the OOSHA encryptin Nte: A cntent pack may cntain either CludSlang cntent r cntent that was develped frm a Studi prject. This sectin nly applies t cntent that develped frm a Studi prject. By default, OOSHA uses the same encryptin ptins as a default Studi installatin. T cnfigure OOSHA t use the encryptin f anther Studi installatin, set the value f the sha.encryptr.dir prperty inside the sha.prperties file t pint t the desired encryptin flder. 1. Lcate the sha.prperties file <sha_instalatin_flder>/cnf/sha.prperties. 2. Edit the sha.prperties file by setting the sha.encryptr.dir prperty with the value f the abslute path f the Studi installatin security flder. Fr example: sha.encryptr.dir=<_installatin_flder>/studi/var/security 3. Save the sha.prperties file and start the OOSHA shell. HPE Operatins Orchestratin (10.70) Page 8 f 18

9 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA Creating Cntent Packs via OOSHA Using the createcp cmmand, yu can create a cntent pack frm a prject develped in Studi r in CludSlang. While a cntent pack is being created via OOSHA, the prject underges a series f structural and cnsistency validatin checks. Nte: Fr infrmatin n hw t create a new prject, see Create a new prject in Studi and Create a new prject frm a template. Create a cntent pack The createcp cmmand packages a prject int a cntent pack. The cntent pack will cntain all the bjects in the prject. Nte: The invalid flws will als be included. Fr a cmplete list f all the ptins yu can use with the createcp cmmand, see the Reference sectin r type help createcp in the cmmand line. 1. Run the sha.bat executable file fr the Windws perating system r the sha.sh executable file fr the Linux perating system. 2. In the cmmand line, type the fllwing cmmand, replacing the highlighted values with yur wn values: createcp --prjectflder <prjectflder> --destinatinflder <CPDestinatinFlder> --versin <CPversin> --publisher <publisher> -- descriptin <descriptin> --includesystemaccuntpasswrds <shuldincludesapasswrds> --verridedestinatin <shuldoverridedestinatin> -- type <cntenttype> 3. Press the Enter key. The cntent pack is created in the lcatin that was defined in the --destinatinflder argument. The name f the cntent pack is taken frm the pm.xml file. If nt defined there, it is taken frm the cntentpack.prperties file. If nt defined there, it is taken frm the prject flder. Validate a cntent pack When yu run the createcp cmmand frm OOSHA, the structure f the prject is validated in the HPE Operatins Orchestratin (10.70) Page 9 f 18

10 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA same way as in Studi. The createcp cmmand will fail if the prject includes crrupt XML r CludSlang files, r files that d nt respect the HPE OO validatin schema. Fr example: OOSHA validates that the prject cntains either XML r CludSlang (.sl) files, but nt bth. If it cntains bth, yu must specify the type f the cntent using the --type ptin. Pssible values: afl the prject was develped in Studi and cntains XML cntent cs the prject cntains CludSlang cntent If this ptin is specified, nly items f the specified type (XML r CludSlang) will be included in the resulting cntent pack. Nte: In this versin, OOSHA des nt validate the fllwing: Start steps Cnnected transitins Lanes Operatin respnses Flder and file structure N missing references t ther flws, peratins r cnfiguratin items inside this prject, as well as ther prjects and cntent packs HPE Operatins Orchestratin (10.70) Page 10 f 18

11 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA OOSHA des nt exclude invalid items (flws, peratins, cnfiguratin items) frm the resulting cntent pack. Include hard cpies Inside the cntent pack Nte: A cntent pack may cntain either CludSlang cntent r cntent that was develped frm a Studi prject. This sectin nly applies t cntent that was develped frm a Studi prject. In rder fr OOSHA t pack peratin dependencies (peratins plugins and their dependencies) fr hard cpy peratins, yu must cnfigure the sha.maven.hme prperty inside the sha.prperties file by fllwing the steps belw. 1. Lcate the sha.prperties file <sha_instalatin_flder>/cnf/sha.prperties. 2. Edit the sha.prperties file by setting the sha.maven.hme prperty with the value f the abslute path f the repsitry cntaining the peratin dependencies. The value f this prperty is typically <user_hme>/./data/maven. This is the abslute path f the Studi maven repsitry flder that was used t create the prject, <studi_ wrkspace>/./data/maven. If this prperty is nt specified, the default maven hme is <user_hme>/.m2/repsitry. 3. Save the sha.prperties file and start the OOSHA shell. Include CludSlang peratins inside the cntent pack In rder fr OOSHA t crrectly pack CludSlang peratins, it might need t include their Java dependencies transitively. All Java dependencies are packaged as Maven artifacts. Fr cllecting all necessary artifacts inside the cntent pack, yu must cnfigure sme prperties inside the sha.prperties file by fllwing the steps belw. 1. Lcate the sha.prperties file <sha_instalatin_flder>/cnf/sha.prperties. 2. Edit the sha.prperties file by setting the the fllwing prperties: Set the sha.maven.hme prperty with the value f the abslute path f the lcal repsitry that OOSHA will use t get dependencies frm. If a dependency cannt be fund in this repsitry, OOSHA will try t dwnlad it frm a remte ne. If this prperty is nt specified, the default maven hme is <user_hme>/.m2/repsitry Set the sha.maven.remte.repsitry prperty with the value f the URL f the remte repsitry that OOSHA will use fr dependency dwnlad. If this prperty is nt specified, the default remte repsitry is Maven Central. HPE Operatins Orchestratin (10.70) Page 11 f 18

12 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA Set the sha.maven.settings prperty with the value f the abslute path f the Maven settings file t use fr cnfiguratin. If n Maven settings file is prvided, OOSHA will use the cnfiguratins prvided using the tw prperties abve. If a file is prvided, it will verride any cnfiguratin specified in the prperties abve. 3. Save the sha.prperties file and start the OOSHA shell. Nte: OOSHA relies n the Maven Dependency plugin and the Maven Install plugin fr cllecting dependencies. If these d nt exist in yur lcal repsitry, OOSHA will try t dwnlad them frm the remte ne. Cnfigure System Accunts Nte: A cntent pack may cntain either CludSlang cntent r cntent that was develped frm a Studi prject. This sectin nly applies t cntent that develped frm a Studi prject. In sme cases, yu may want t a package a cntent pack frm a prject that cntains system accunts withut including the system accunt passwrds. Fr example, when yu want t run the createcp cmmand using a false value fr the -- includesystemaccuntpasswrds argument r when the value fr the -- includesystemaccuntpasswrds argument is nt prvided. In such a case, yu must first cnfigure the sha.encryptr.dir prperty inside the sha.prperties file by fllwing the steps belw. 1. Lcate the sha.prperties file <sha_instalatin_flder>/cnf/sha.prperties. 2. Edit the sha.prperties file by setting the sha.encryptr.dir prperty with the value f the abslute path f the Studi installatin security flder <_installatin_ flder>/studi/var/security. 3. Save the sha.prperties file and start the OOSHA shell. Create a new prject in Studi The cmplete prcess f creating a new prject using Studi is dcumented in the HPE OO Studi Authring Guide. The prject generated by Studi will have the fllwing flder structure: HPE Operatins Orchestratin (10.70) Page 12 f 18

13 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA In the example abve, the name f the prject is test-prject. T place CludSlang r XML files inside this prject, yu have t create a new subflder under Library and place them inside. Then, yu can build the cntent pack using OOSHA. Nte: D nt place the files directly under the Library flder, as this will nt wrk. Create a new prject frm a predefined template T create a new prject withut Studi: 1. Dwnlad template-prject.zip. 2. Unzip template-prject.zip t the desired lcatin. 3. Find the directry template-prject with the fllwing structure: 4. Rename the template-prject directry t the name yu want t prvide fr the new prject. Fr a CludSlang prject, the prject naming cnventin is: cs-[<vendr>]- <prduct technlgy> Fr example: cs-vmware-vcenter HPE Operatins Orchestratin (10.70) Page 13 f 18

14 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA Fr a XML prject, the naming cnventin is: [<vendr>]-<prduct technlgy> Fr example: vmware-vcenter 5. Lcate the pm.xml file. Open it, and replace the value inside the artifcactid tag with the name f the prject. Fr example: <artifactid>cs-vmware-vcenter </artifactid>) 6. Lcate the cntentpack.prperties file. Open it, and prvide values fr the prperties: cntent.pack.name - It is recmmended t specify a value fr this prperty. The value shuld be the name f the prject. cntent.pack.uuid - This value is mandatry. Yu must prvide a valid uuid value befre running the createcp cmmand. cntent.pack.versin - It is recmmended t specify a value fr this prperty. The value must be the same as the value frm the versin tag inside the pm.xml file. If yu want t update the versin f the prject, yu must update it inside bth files. cntent.pack.publisher Reference Material Available Arguments fr the createcp Cmmand Argument Descriptin Default Value/Behavir Required --prjectflder The lcatin f the prject t be packaged. Yes This must be the abslute path f the flder that represents a prject in the Studi frmat. --destinatinflder The path t a lcal flder where the prject will be packaged int a cntent pack. The default lcatin is where the cntent pack was created the previus time. N The destinatin flder and all parent flders up t the destinatin flder will be created, if they d nt exist n the file system. The first time the cntent pack is created, the default path is: HPE Operatins Orchestratin (10.70) Page 14 f 18

15 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA Argument Descriptin Default Value/Behavir Required C:\Users\<user_ name>\.\cntent Packs --versin Lets yu specify the versin f the cntent pack If the versin is nt specified, the default versin number is taken frm the prject, with the -SNAPSHOT suffix remved. N Fr example, if the prject versin is SNAPSHOT, the cntent pack versin will be incrementversin The cntent pack versin is taken frm the prject versin with the - SNAPSHOT suffix remved, and the prject versin is increased by False The default is that the prject versin is nt incremented. N Fr example, assuming that yu have nt specified a versin number with --versin: If the prject versin is SNAPSHOT, the cntent pack versin will be and the prject versin will be mved up t SNAPSHOT. --publisher Lets yu specify the publisher f the cntent pack. (empty) N --descriptin Lets yu specify a descriptin f the cntent pack. If this is nt specified, the descriptin is taken frm the cntentpack.prperties file. N --includesystemaccunt Lets yu specify whether False N HPE Operatins Orchestratin (10.70) Page 15 f 18

16 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA Argument Descriptin Default Value/Behavir Required Passwrds the cntent pack shuld include system accunt passwrds. See "Exprting a Cntent Pack" in the HPE OO Studi Authring Guide. Fr security reasns, it is recmmended t cnfigure the system accunt passwrds in Central. -- verridedestinatin Lets yu specify whether t verride an existing file with the same name as the cntent pack in the destinatin flder. If the destinatin file that the cntent pack represents exists n the file system, and verridedestinatin is set t false, the cntent pack will nt be created. If the destinatin file that the cntent pack represents exists n the file system, and verridedestinatin is set t true, the cntent pack will verride the riginal destinatin file. False N --type Specify the type f cntent frm the prject. Pssible values: afl, cs The type f the cntent frm the prject will be aut-detected. N afl means that the prject cntains XML files with flws and peratins. cs means that the prject cntains CludSlang files. If the prject cntains bth XML and CludSlang files, OOSHA will nt manage t detect the type, and will fail t build the cntent pack. The slutin fr this HPE Operatins Orchestratin (10.70) Page 16 f 18

17 OO Shell fr Authring (OOSHA) User Guide Creating Cntent Packs via OOSHA Argument Descriptin Default Value/Behavir Required Only files f the specified type will be included in the resulted cntent pack. situatin is t specify the type f the cntent. If the prject is empty, the detected type will be afl. HPE Operatins Orchestratin (10.70) Page 17 f 18

18