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

Sections in this document:

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:

Before You Begin

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/

Step 1: 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. 

Option 1:
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.

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

Step 2: Configuring the Plugin

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

  1. To enter your Skytap credentials:## Navigate to the Skytap Cloud Plugin configuration panel for your Jenkins build project.## Enter your Skytap User ID and API security token. 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.  # To enable verbose logging for Skytap actions:## Navigate to Manage Jenkins > Configuration System. ## In the Skytap Cloud Plugin settings, check Enable Console Logging of Skytap Actions. Logs will be sent to the Jenkins Project build console.

Step 3: Adding 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. 

Skytap Actions and Required Parameters

NOTE: Throughout these actions, Skytap environments are called "configurations." Configurations and environments are the same.

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.
NOTE: If the environment contains multiple networks with the same name (not recommended), the first network encountered in the metadata associated with the environment will be used.

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.
NOTE: If the VM contains multiple networks 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 action creates a Skytap template from a Skytap configuration.

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.

Template Name

Enter a name for the new template.

Template Data Save File

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

Delete Configuration

This action deletes a Skytap environment.

Required Parameter

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.

List Published URL for Configuration

This action returns information about a published URL in the 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.

List VM Published Service

This action returns information about a published service in the 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.

Merge Template into Configuration

This action will copy VMs from a template into an existing 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.

  • No labels