vRO Plug-in for FlowGrab
Transcription
vRO Plug-in for FlowGrab
vRO Plug-in for FlowGrab Version 2.0.1 flowgrab.com – the home of vRO workflows Contents Introduction............................................................................................................................................. 3 Installation ............................................................................................................................................... 3 Upgrading ................................................................................................................................................ 4 Uninstallation .......................................................................................................................................... 5 Configuration ........................................................................................................................................... 5 Usage ....................................................................................................................................................... 7 Search / Import Public Projects ........................................................................................................... 7 Search / Import Private Projects ....................................................................................................... 17 Commit .............................................................................................................................................. 26 Push ................................................................................................................................................... 33 Page 2/40 flowgrab.com – the home of vRO workflows Introduction FlowGrab provides vRO plug-in for direct integration. vRO plug-in allows accessing FlowGrab content directly from vRO without a need for a web browser. Plug-in comes with a built-in workflow providing a user interface directly from vRO Client. In version 2.0.1 support for Windows vRO has been added. Current plug-in version has the following functionalities: Search – for searching FlowGrab repository to find interesting projects or find your private projects. Import – for importing downloaded package automatically to vRO. Commit - for uploading your changes from vRO to FlowGrab. Push - for pushing your committed changes to project’s master branch in FlowGrab. vRO plug-in allows to integrate to multiple FlowGrab repositories such as the public FlowGrab.com service or a private FlowGrab appliance within company premises. Installation FlowGrab vRO plug-in installation follows the general plug-in installation process: 1. Download vRO plug-in binaries from the following URL: https://flowgrab.com/pages/plugin.xhtml NB! Microsoft IE may change file extension from .dar to .zip during download. In such case rename plug-in file back to .dar before uploading it to vRO. 2. Change the vRO listening IP address on vRO Configuration page. On Network tab select the configured vRO IP address from dropdown list. Select the IP address used for external access to vRO. Page 3/40 flowgrab.com – the home of vRO workflows 3. Upload and install plug-in package to vRO through Orchestrator Configuration page (Plug-ins view). 4. Restart vRO Server service through Orchestrator Configuration page (Startup Options view). 5. Verify that FlowGrab plug-in appears in vRO Client inventory (Administer view, Inventory tab). 6. (optional) Install FlowGrab repository certificate to vRO. On Orchestrator Configuration page select Network view, SSL Trust Manager tab. On URL from which to import a certificate: field enter the Flowgrab host address (for example Flowgrab.com) and select Import. Select Import again to confirm the certificate. Restart the vRO service. After plug-in installation is finished - follow the steps under Uninstallation FlowGrab vRO plug-in uninstallation follows the general plug-in installation process. This must be followed in the following VMware KB article: Uninstalling a plug-in from VMware vRealize Orchestrator (2064575) Configuration chapter to set it up. NB! Workflows included within the plug-in are also separately available from FlowGrab.com. Search for the project vCO-plugin-for-flowgrab provided by team flowgrab. Page 4/40 flowgrab.com – the home of vRO workflows Upgrading If doing upgrade from FlowGrab Plugin version 1.0.x to version 2.x.x the following steps must be followed: 1. Remove all Flowgrab hosts from inventory. Execute the Remove Host From Inventory workflow. 2. Uninstall the plugin from vRO (please follow VMware Knowledge Base article) 3. Delete the plugin package with content. On the Packages tab, select package named com.flowgrab.library. On right-click menu select Delete element with content… Uninstallation FlowGrab vRO plug-in uninstallation follows the general plug-in installation process. This must be followed in the following VMware KB article: Uninstalling a plug-in from VMware vRealize Orchestrator (2064575) Configuration FlowGrab vRO plug-in configuration is done by using special workflows provided by the plug-in. The following steps have to be performed from vRO Client interface: 1. Switch to Run view, navigate to Library/FlowGrab/Configuration folder under Workflows tab. Launch Add a FlowGrab host workflow to configure connection to a FlowGrab service: Page 5/40 flowgrab.com – the home of vRO workflows Figure 1 - Add FlowGrab host to vRO Client. Page 6/40 flowgrab.com – the home of vRO workflows Figure 2- Add FlowGrab host details. a. Friendly name – specify descriptive display name of the FlowGrab service you want to connect to. b. Host’s URL – specify URL of the FlowGrab service you want to connect to. For public FlowGrab service use https://www.flowgrab.com. c. Ignore certificate errors – select yes if you want to bypass SSL certificate verification (not recommended). Public FlowGrab.com service is using GoDaddy public SSL certificate, which may not be automatically trusted by Java Trusted Cert Store used within vRO. In such case you can import GoDaddy certificate to your vRO cert store. Follow the steps under Installation chapter. This is a known issue. d. Proxy required? – select if proxy is needed to connect to the FlowGrab service. e. Proxy address – specify proxy server address if proxy is used. f. Proxy port – specify proxy server TCP port if proxy is used. g. Connection timeout in seconds – the timeout when communicating with FlowGrab host. Default is 20 seconds, but may be increased when vRO client and FlowGrab host have slow connection between. h. Operation timeout in seconds – the timeout when performing operations with FlowGrab. Default is 60 seconds, but may be increased if for example importing very large packet. Page 7/40 flowgrab.com – the home of vRO workflows i. Click Submit. 2. Added FlowGrab service appears as a REST host under the FlowGrab plug-in in the Inventory tab of the Administer view. Figure 3 - FlowGrab hosts in vRO Client inventory 3. To remove FlowGrab service use Remove a FlowGrab host workflow and select previously registered FlowGrab service. You can register multiple FlowGrab services with the plug-in. For example, the public FlowGrab.com service and your company’s private enterprise FlowGrab appliance. The service that was registered first appears as the default service used by FlowGrab workflow (see Usage chapter). Usage Current version of vRO plug-in for FlowGrab provides the following functionalities: Search – for searching FlowGrab repository to find interesting projects or find your private projects. Import – for importing downloaded package automatically to vRO. Commit - for uploading your changes from vRO to FlowGrab. Push - for pushing your committed changes to project’s master branch in FlowGrab. All these functionalities are available by using the FlowGrab workflow. Search / Import Public Projects 1. Launch FlowGrab workflow under Library/FlowGrab folder. 2. Select desired FlowGrab service in FlowGrab host field. Default host (firstly registered) is already selected. Page 8/40 flowgrab.com – the home of vRO workflows Figure 4 - Select FlowGrab host. Page 9/40 flowgrab.com – the home of vRO workflows Figure 5 - Select FlowGrab host. 3. Select the Task Anonymous search. Page 10/40 flowgrab.com – the home of vRO workflows Figure 6 - Select FlowGrab host and Task 4. Type project search criteria to Search filter field. You must enter a search criteria to continue. The search criteria must contain at least 2 characters. Click Submit to continue. Page 11/40 flowgrab.com – the home of vRO workflows Figure 7 - Insert search filter. Page 12/40 flowgrab.com – the home of vRO workflows Figure 8- Insert search filter 5. A list of matching project names with team names are displayed on next screen. Page 13/40 flowgrab.com – the home of vRO workflows Figure 9 - Choose a project. 6. Select your project from the Choose project dropdown list. Page 14/40 flowgrab.com – the home of vRO workflows Figure 10- Choose a project 7. To continue with project import select desired project version from Choose project version dropdown list and select Import from Task dropdown and click Submit to continue. Page 15/40 flowgrab.com – the home of vRO workflows Figure 11 - Choose project version. Page 16/40 flowgrab.com – the home of vRO workflows Figure 12 - Choose task 8. Alternatively, you can select New Search, which will take you back to the first window or Quit, which will exit the workflow. 9. Project version will be downloaded and imported. Page 17/40 flowgrab.com – the home of vRO workflows Figure 13 - Final status of the task. Search / Import Private Projects 1. Launch FlowGrab workflow under Library/FlowGrab folder. 2. Select desired FlowGrab service in FlowGrab host field. Default host (firstly registered) is already selected. Page 18/40 flowgrab.com – the home of vRO workflows Figure 14 - Select FlowGrab host. Page 19/40 flowgrab.com – the home of vRO workflows Figure 15 - Select FlowGrab host. 3. Select the Task Show my Projects. Page 20/40 flowgrab.com – the home of vRO workflows Figure 16 - Select FlowGrab host and Task. 4. Enter your FlowGrab Username and Password and click Submit to continue. Page 21/40 flowgrab.com – the home of vRO workflows Figure 17 - Enter FlowGrab credentials. 5. A list of all your project names with team names are displayed on the next screen. Page 22/40 flowgrab.com – the home of vRO workflows Figure 18 - Choose a project. 6. Select your project from the Choose project dropdown list. Page 23/40 flowgrab.com – the home of vRO workflows Figure 19 - Choose project 7. To continue with project import select desired project version from Choose project version dropdown list and select Import from Task dropdown and click Submit to continue. Page 24/40 flowgrab.com – the home of vRO workflows Figure 20 - Choose project version. Page 25/40 flowgrab.com – the home of vRO workflows Figure 21 - Choose task. 8. Alternatively, you can select New Search, which will take you back to the first window or Quit, which will exit the workflow. 9. Project version will be downloaded and imported. Page 26/40 flowgrab.com – the home of vRO workflows Figure 22 - Final status of the task. Commit 1. Launch FlowGrab workflow under Library/FlowGrab folder. 2. Select desired FlowGrab service in FlowGrab host field. Default host (firstly registered) is already selected. Page 27/40 flowgrab.com – the home of vRO workflows Figure 23 - Select FlowGrab host. Page 28/40 flowgrab.com – the home of vRO workflows Figure 24 - Select FlowGrab host. 3. Select the Task Commit. Page 29/40 flowgrab.com – the home of vRO workflows Figure 25 - Select FlowGrab host and Task. 4. Enter your FlowGrab credentials and click Submit to continue. Page 30/40 flowgrab.com – the home of vRO workflows Figure 26 - Commit Task. 5. The list of all your projects with team names are displayed on Choose project dropdown list. Select one of your projects in FlowGrab, enter information in a Commit message dialog and click on the link Not set under the Choose package heading. Page 31/40 flowgrab.com – the home of vRO workflows Figure 27 - Commit info. 6. A list of all the packages in your vRO are displayed. Select the package containing your project from the FlowGrab and click Submit on the Commit info window. Page 32/40 flowgrab.com – the home of vRO workflows Figure 28 - Select package to Commit. 7. The status of the Commit task is displayed and possibility to continue with the following tasks: Push commits – the changes you have committed to FlowGrab will be pushed to master branch. Import – Imports the new version of the project from FlowGrab back to vRO. Quit – Quits the workflow. Page 33/40 flowgrab.com – the home of vRO workflows Figure 29 - Commit task status Push 1. Launch FlowGrab workflow under Library/FlowGrab folder. 2. Select desired FlowGrab service in FlowGrab host field. Default host (firstly registered) is already selected. Page 34/40 flowgrab.com – the home of vRO workflows Figure 30 - Select FlowGrab host. Page 35/40 flowgrab.com – the home of vRO workflows Figure 31 - Select FlowGrab host. 3. Select the Task Push. Page 36/40 flowgrab.com – the home of vRO workflows Figure 32 - Select FlowGrab host and Task. 4. Enter your FlowGrab credentials and click Submit to continue. Page 37/40 flowgrab.com – the home of vRO workflows Figure 33 - Push task 5. The list of all your projects with team names are displayed on Choose project dropdown list. Select one of your projects in FlowGrab and click Submit to continue. Page 38/40 flowgrab.com – the home of vRO workflows Figure 34 - Push project selection 6. The status of the Commit task is displayed and possibility to continue with the following tasks: Import – Imports the new version of the project from FlowGrab back to vRO. Quit – Quits the workflow. Page 39/40 flowgrab.com – the home of vRO workflows Figure 35 - Push task status. Page 40/40 flowgrab.com – the home of vRO workflows