Due to some maintenance issues, this service has been switched in read-only mode, you can find more information about the why

and how to migrate your plugin documentation in this blogpost

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 48 Next »

Plugin Information

View Skytap Cloud CI on the plugin site for more information.

Older versions of this plugin may not be safe to use. Please review the following warnings before using an older version:

This plugin allows you to use Jenkins to run continuous integration and automated testing workflows using dynamically-created development and testing environments in Skytap

Introduction

The Skytap Cloud CI Plugin for Jenkins allows you to create and configure Skytap Cloud environments as part of your Jenkins-based continuous integration workflow. In a matter of minutes, you can create a Skytap virtual environment from a golden template and then use that environment to develop your application or run test passes for unit testing, functional testing, integration testing, stress/performance testing or user acceptance testing. All of the VM and network settings are saved with the template, so once you've created an environment, the network is already set up and you're ready to go. 

With Skytap Cloud CI Plugin for Jenkins, you can add the following actions to your Jenkins build steps:

  • Add Configuration to Project
  • Change Configuration State
  • Connect to Network in another Configuration (ICNR)
  • Connect to VPN Tunnel
  • Create Configuration from Template
  • Create Published URL
  • Create Template from Configuration
  • Delete Configuration
  • Add Template to Project
  • Merge Template into Configuration
  • Create Published Service
  • List Published URL for Configuration
  • List VM Published Service

Each of these actions is described in more detail below.

Requirements

To use the Skytap Cloud CI Plugin for Jenkins, you must have a Skytap account.

If you do not have a Skytap account, you can sign up for a demo account at http://www.skytap.com/

Installing the Skytap Cloud CI Plugin for Jenkins

From the Jenkins Web UI

To install the plugin from the Jenkins Web UI:

1. Navigate to the Jenkins Manage Plugins page.


  

2. Select the Available tab and filter for “Skytap”

3. Select the “Install” checkbox next to “Skytap Cloud CI Plugin for Jenkins.”

4. Click Download now and install after restart.

When Jenkins restarts, you will have access to Skytap Actions in the Jenkins Project Configuration screen “Add Build Step” dropdown menu.

From a Downloaded Skytap Cloud CI Plugin for Jenkins file

To install the plugin from the Jenkins plugin repository:

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 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:

When Jenkins restarts, you will have access to Skytap Actions in the Jenkins Project Configuration screen “Add Build Step” dropdown menu.

Configuring the Plugin

Enter Your Skytap Cloud Authentication Credentials

Enter your Skytap User ID and API security token in the Skytap Cloud Plugin configuration panel for your Jenkins build project.

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. 

Skytap Action Logging

The Skytap Cloud Plugin configuration panel on the “Manage Jenkins->Configure System” page controls logging of Skytap Actions.

If the checkbox is checked, verbose output on the operation of Skytap Actions will be sent to the Jenkins Project build console.

Supported Actions for Skytap Cloud

The Skytap Cloud Actions that are available for use in Jenkins project builds are exposed in the Jenkins Project Configuration screen in the “Add Build Step” dropdown menu as an “Execute Skytap Action” menu pick:

Once you select “Execute Skytap Action” you will be presented with a “Skytap Action” dropdown menu listing the available actions:
 
Depending on which action you select you will be presented with a set of input and output parameters to specify in order to enable execution of the Skytap Action.  The specific input and output parameters that are required differ depending on which Skytap Action you select.  These parameters are described below in the discussion of individual Skytap Actions.

Add Configuration to Project

This Skytap Action allows the user to specify a Skytap Environment to add to a Skytap Project.


 

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Project ID --or- Project Name

The user can specify a specific Skytap Project ID (an integer) or a Skytap Project Name.  Whichever method is used, the project must already exist and be accessible by the user's Skytap account.

Add Template to Project

This Skytap Action allows the user to specify a Skytap Template to add to a Skytap Project.

Parameters

Template ID --or- Template File

The user can specify a specific Skytap Template ID (an integer), if one is known.  If the template was created using the “Create Template from Configuration” Skytap Action, the user can specify the Skytap template by specifying the “Template Data Save File” that is an output of the “Create Template from Configuration” Skytap Action.

Project ID --or- Project Name

The user can specify a specific Skytap Project ID (an integer) or a Skytap Project Name.  Whichever method is used, the project must already exist and be accessible by the users Skytap account.

Change Configuration State

When this Skytap Action is selected, the user must then select the desired state to which they wish to transition the environment.  Choices are “Run Configuration”, “Suspend Configuration”, and Shutdown Configuration”.

Once a state change action is specified the user can fill out the remaining parameters.

Parameters

Power off VM if shutdown fails

The “Power off VM if shutdown fails” checkbox serves as a failsafe if a VM fails to shutdown.  If this checkbox is checked, and the specified Skytap Environment fails to shutdown after a period of 5 minutes, the specified Skytap Environment will be forcefully shutdown or “powered off”.  This is equivalent to clicking the “Power off this machine” button in the Skytap Web GUI.

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Connect to Network in another Configuration (ICNR)

When this Skytap Action is selected, the specified networks in the two specified environments will be connected using the Internal Configuration Network Routing (ICNR) protocol.  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 must already be configured to allow an ICNR connection to occur. You can read more about ICNR in the Skytap Help Documentation.

Parameters

Source Configuration ID --or- Source Configuration Data File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Source Network Name

This required parameter specifies the name of the network in the source environment to use in the ICNR connection attempt. If there is more than one network in the environment with the specified name (not recommended), the first network encountered in the meta data associated with the environment will be used.


Target Configuration ID --or- Target Configuration Data File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Target Network Name

This required parameter specifies the name of the network in the source environment to use in the ICNR connection attempt.  The network in the Target Network Name must be configured to be visible to other networks.

Connect to VPN Tunnel

When this Skytap Action is selected, the specified Skytap VPN definition will be connected to the specified network in the specified Skytap Environment.

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Configuration Network Name

This required parameter specifies the name of the network in the Skytap Environment to use in the VPN connection attempt.

VPN ID

This parameter is the Integer ID of the Skytap VPN definition to which to connect the specified network in the environment.

Create Configuration from Template

This Skytap Action allows the user to specify a Skytap Template from which to create a Skytap Environment.

Parameters

Template ID --or- Template File

The user can specify a specific Skytap Template ID (an integer), if one is known.  If the template was created using the “Create Template from Configuration” Skytap Action, the user can specify the Skytap template by specifying the “Template Data Save File” that is an output of the “Create Template from Configuration” Skytap Action.

Configuration Name

This parameter allows the user to specify a name for the created environment.

Configuration Data Save File

This output file contains the Skytap Environment metadata in json format.  This metadata contains the Skytap Environment ID as well as the other metadata that defines the Skytap Environment.  This file can then be used as input to Skytap Actions that require a Skytap Environment ID or other Skytap Environment metadata.

Create Published URL

When this Skytap Action is selected, a Skytap Published URL will be created and associated with the specified environment.

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

URL Save Filename

When the Published URL is created, the text of the URL will be written into the file specified in the Filename specified in this parameter.

Select Permissions

This dropdown list specifies the permissions associated with the Published URL that will be created.  The meaning of these permissions can be reviewed in the Skytap Help materials at this URL: Skytap Published URL Help

Require Password for Access

If this checkbox is checked, the user can specify a password that will be required before anyone using the created Published URL will be allowed to access the associated Skytap resource.

Create Published Service

When this Skytap Action is selected, a Skytap Published Service will be added to the port number specified by the “Port Number” parameter in the network with the name specified by the “Network Name” parameter in the virtual machine specified by the “VM ID” or “VM Name” parameter in the environment specified by the “Configuration ID” or “Configuration File” parameter.

If the specified environment has more than one Virtual Machine with the name specified by the “Virtual Machine Name” parameter, the first Virtual Machine with the specified name that is listed in the environment metadata will be used.

If the specified environment has more than one network with the name specified by the “Network Name” parameter, the first network with the specified name that is listed in the environment metadata will be used.

The text of the public URL and port in the form “public-URL:port-number” is saved in a file with the name specified in the file specified by the “Published Service Save Filename” parameter. 

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

VM ID --or- VM Name

This parameter specifies the Virtual Machine to which the Published Service is to be attached.  The specification can be a VM ID or a VM Name.  Note that if the specified environment has more than one VM with the same name, the first VM with that name that is encountered in the Skytap Environment metadata definition will be selected.

Network Name

This parameter specifies the Network to which the Published Service is to be attached. Note that if the specified VM has more than one network with the same name, the first network with that name that is encountered in the Skytap Environment metadata definition will be selected.

Port Number

This parameter specifies the Port to which the Published Service will be connected.

Published Service Save Filename

This parameter specifies the file to which the text that describes the created Published Service will be written.  The format of the text will be of the form “public URL:port-number”.

Create Template from Configuration

This Skytap Action allows the user to specify a Skytap Environment from which to create a Skytap Template.

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Template Name

This parameter allows the user to specify a name for the created template.

Template Description

This parameter allows the user to specify a description for the created template.

Template Data Save Filename

This output file contains the Skytap Template metadata in json format.  This metadata contains the Skytap Template ID as well as the other metadata that defines the Skytap Environment.  This file can then be used as input to Skytap Actions that require a Skytap Template ID or other Skytap Template metadata.

Delete Configuration

This Skytap Action allows a user to delete the specified Skytap Environment.

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

List Published URL for Configuration

The environment desktops URL with the specified Published URL Name for the specified environment is written into the file specified by the “Published URL Save Filename” parameter.  Published URLs for individual VMs in an environment are not supported.

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Published URL Name

This parameter specifies the name of the desired published URL.  If more than one published URL in the specified environment has the same name, the first URL encountered in the environment metadata will be selected.

Published URL Save Filename

The text of the published environment URL will be written into the file specified in this parameter.

List VM Published Service

The Skytap Published Service for the port specified in the “Port Number” parameter in the network with the name specified by the “Network Name” parameter in the virtual machine specified by the “VM ID” or “VM Name” parameter in the environment specified by the “Configuration ID” or “Configuration File” parameter is written into the file specified by the “Published Service Save Filename” parameter.

If the specified environment has more than one Virtual Machine with the name specified by the “Virtual Machine Name” parameter, the first Virtual Machine with the specified name that is listed in the environment metadata will be used.

If the specified environment has more than one network with the name specified by the “Network Name” parameter, the first network with the specified name that is listed in the environment metadata will be used.

The text of the public URL and port in the form “public-URL:port-number” is saved in a file with the name specified in the file specified by the “Published Service Save Filename” parameter.


 

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

VM ID --or- VM Name

This parameter specifies the Virtual Machine to which the Published Service is to be attached.  The specification can be a VM ID or a VM Name.  Note that if the specified environment has more than one VM with the same name, the first VM with that name that is encountered in the Skytap Environment metadata definition will be selected.

Network Name

This parameter specifies the Network to which the Published Service is to be attached. Note that if the specified VM has more than one network with the same name, the first network with that name that is encountered in the Skytap Environment metadata definition will be selected.

Port Number

This parameter specifies the Port to which the Published Service will be connected.

Published Service Save Filename

This parameter specifies the file to which the text that describes the created Published Service will be written.  The format of the text will be of the form “public URL:port-number”.

Merge Template into Configuration

The Virtual Machines contained in the Skytap Template identified by the specified Skytap Template ID or Template Data File are added to the Skytap Environment identified by the specified Skytap Configuration ID or Configuration Data File.

  

Parameters

Configuration ID --or- Configuration File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Template ID --or- Template File

The user can specify a specific Skytap Environment ID (an integer), if one is known.  If the environment was created using the “Create Configuration from Template” Skytap Action, the user can specify the Skytap Environment by specifying the “Configuration Data Save File” that is an output of the “Create Configuration from Template” Skytap Action.

Configuration Data Save File

This optional output file contains the new Skytap Environment metadata in json format.  This metadata contains the Skytap Environment ID as well as the other metadata that defines the Skytap Environment.  This file can then be used as input to Skytap Actions that require a Skytap Environment ID or other Skytap Environment metadata.

  • No labels