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

You can install the plugin from the Jenkins web UI, or you can download the plugin from the plugin repository. 

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

To configure the plugin, you will need to enter to your Skytap credentials. Optionally, you can also enable verbose logging.

Enter Your Skytap Cloud Authentication Credentials

To enter your Skytap credentials:

1. Navigate to the Skytap Cloud Plugin configuration panel for your Jenkins build project.

2. 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. 

Enable Skytap Action Logging (Optional)

To enable verbose logging for Skytap actions:

1. Navigate to Manage Jenkins > Configuration System.

2. In the Skytap Cloud Plugin settings, check Enable Console Logging of Skytap Actions. Logs will be sent to the Jenkins Project build console.

Add Skytap Actions to Your Build Steps

Once the plugin is installed and configured, you can add Skytap actions to your Jenkins build steps:

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.

Add Configuration to Project

This action adds a Skytap environment to a Skytap project.


 

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.

Project ID or Project Name

Enter a Skytap project ID (an integer) or a Skytap project name. The project must already exist and be accessible from your Skytap account.

Add Template to Project

This action adds a Skytap template to a Skytap project.

Required Parameters

Description

Template ID or Template File

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.

Project ID or Project Name

Enter a Skytap project ID (an integer) or a Skytap project name. The project must already exist and be accessible from your Skytap account.

Change Configuration State

This action will run, suspend, or shut down a Skytap environment.

Parameters

Description

Action (Required)

Select "Run Configuration", "Suspend Configuration", or "Shutdown Configuration"

Power off VM if shutdown fails (Optional)

If this option is checked, Skytap will forcibly power off any VMs that do not shut down within 5 minutes.

Configuration ID or Configuration File (Required)

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.

Connect to Network in another Configuration (ICNR)

This action connects two networks in different 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 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. 

NOTE: If there is more than one network in the environment with the specified name (not recommended), the plugin will use the first network encountered in the metadata associated with the environment.

Connect to VPN Tunnel

This action will connect a Skytap environment to a Skytap VPN.

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.

Configuration Network Name

Enter the name of the network in the Skytap environment. If there is more than one network in the environment with the specified name (not recommended), the plugin will use the first network encountered in the metadata associated with the environment.

VPN ID

Enter the Skytap VPN ID (an integer).

Create Configuration from Template

This action creates a Skytap environment from a Skytap template.

Required Parameters

Description

Template ID or Template File

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 Name

Enter a name for the new environment.

Configuration Data Save File

This output file will contain the Skytap environment metadata in JSON format. The metadata includes the Skytap environment ID and other information about the environment. This file can be used as input to Skytap actions that require a Skytap environment ID or other environment metadata.

Create Published URL

This action creates a Skytap Published URL for an 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

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.

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.

VM ID or VM Name

Enter the ID or name of the virtual machine you want to attach the published service to. Note: If the environment has more than one VM with the same name, the first VM in the Skytap environment metadata definition will be selected.

Network Name

Enter the name of the network you want to attach the published service to. If the VM has more than one network with the same name, the first network in the Skytap environment metadata definition will be selected.

Port Number

Enter the port number you want to connect the published service to (for example, 3389 for RDP access).

Published Service Save Filename

Enter a file where the “public-URL:port-number” can be written to after the published service is created. 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.

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