Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Download the "skytap.hpi" plugin file from the Jenkins plugin repository.
  2. Navigate to the Jenkins Manage Plugins page.
  3. Select the Advanced tab.
  4. From the “Upload Plugin” section, click Choose File
  5. Navigate to the downloaded Skytap Cloud CI Plugin for Jenkins plugin file (skytap.hpi) and select it. 
  6. Click Upload
  7. After the plugin is uploaded, restart Jenkins by navigating to http://_your-jenkins-server_/jenkins/restart
  8. Click Yes to confirm the action:.
     

Step 2: Configuring the Plugin

...

  1. To enter your Skytap credentials:## Navigate to the Skytap Cloud Plugin configuration panel for your Jenkins build project.
    1. Enter your Skytap User ID and API security token. 
       
      NOTE: You can retrieve your user ID (user name) and API security token from your Skytap account settings page (https://cloud.skytap.com/account). If you do not have an API security token listed, use the instructions at http://help.skytap.com/#Access_Policy.html to enable API security tokens in your account.
  2. To enable verbose logging for Skytap actions:## Navigate to Manage Jenkins >Configuration Configure System.
    Image Modified
    1. In the Skytap Cloud Plugin settings, check select Enable Console Logging of Skytap Actions.
      Logs will be sent to the Jenkins Project build console.

...

  1. Navigate to the Jenkins Project Configuration screen.
  2. From the Add build step dropdown menu, select Execute Skytap Action
  3. Select an available action:
  4. Enter any required input or output parameters. For a description of each action and the required parameters, see the sections below. 

...

This action connects two networks in different Skytap environments. This feature is useful during testing, where one or more test environments need to access a central resource, such as a database or Active Directory server. The network subnets in the two environments The networks must already be configured to allow an Inter-Configuration Network Routing (ICNR) connection to occur. You can read more about ICNR in the Skytap Help Documentation. 

Required Parameters

Description

Source Configuration ID or Source Configuration Data File

Enter a Skytap environment ID (an integer), if one is known.  
If the environment was created in an earlier step (using the "Create Configuration from Template” Skytap action), enter the Configuration Data Save File created from that step.

Source Network Name

Enter the name of the network in the source environment.

Target Configuration ID or Target Configuration Data File

Enter a Skytap environment ID (an integer), if one is known.  
If the environment was created in an earlier step (using the "Create Configuration from Template” Skytap action), enter the Configuration Data Save File created from that step.

Target Network Name

Enter the name of the network in the target environment. This network must be visible to other networks. 

...

Create Published URL

This action creates a Skytap Published URL for an a Skytap environment.

Required Parameters

Description

Configuration ID or Configuration File

Enter a Skytap environment ID (an integer), if one is known. 
If the environment was created in an earlier step (using the "Create Configuration from Template” Skytap action), enter the Configuration Data Save File created from that step.

URL Save Filename

Enter a file where the URL can be written to after the published URL is created.

Select Permissions

Select a permission level for VMs in the published URL. The permissions are explained in more detail on the Skytap Published URL Help Page For more information about permissions, see the Skytap Help Documentation.

Require Password for Access

If checked, enter a password to restrict access to the published URL.

Create Published Service

This action creates a Skytap Published Service port opening on a VM's network adapter. This is commonly used to open RDP or SSH access to a VM.
  

...

This action returns information about a published URL in the a Skytap environment.

Required Parameters

Description

Configuration ID or Configuration File

Enter a Skytap configuration ID (an integer), if one is known. 
If the configuration was created in an earlier step (using the "Create Configuration from Template” Skytap action), enter the Configuration Data Save File created from that step.

Published URL Name

Enter the name of the desired published URL.
NOTE: If the environment has multiple published URLs with the same name, the first URL encountered in the environment metadata will be selected.

Published URL Save Filename

Enter a file where the URL can be written to.

...

This action returns information about a published service in the a Skytap environment.

Required Parameters

Description

Configuration ID or Configuration File

Enter a Skytap configuration ID (an integer), if one is known. 
If the configuration was created in an earlier step (using the "Create Configuration from Template” Skytap action), enter the Configuration Data Save File created from that step.

VM ID or VM Name

Enter the ID or name of the virtual machine the published service is attached to.
NOTE: If the environment has multiple VMs with the same name, the first VM in the Skytap environment metadata definition will be selected.

Network Name

Enter the name of the network the published service is attached to.
NOTE: If the VM has multiple networks with the same name, the first network in the Skytap environment metadata definition will be selected.

Port Number

Enter the port number the published service is attached to (for example, 3389 for RDP access).

Published Service Save Filename

Enter a file where the “public-URL:port-number” can be written to.
NOTE: The port number in this text will be different than the port number specified above. Skytap uses port mappings to obscure the port openings on the public Internet.

...

This action will copy VMs from a Skytap template into an existing a Skytap environment.


Parameters

Description

Configuration ID or Configuration File (Required)

Enter a Skytap configuration ID (an integer), if one is known. 
If the configuration was created in an earlier step (using the "Create Configuration from Template” Skytap action), enter the Configuration Data Save File created from that step.

Template ID or Template File (Required)

Enter a Skytap template ID (an integer), if one is known. 
If the template was created in an earlier step (using the "Create Template from Configuration” Skytap action), enter the Template Data Save File created from that step.

Configuration Data Save File (Optional)

To create a new Configuration Data Save File with updated environment metadata, enter a new file. This file can be used in actions that require a Skytap environment ID or other environment metadata.