Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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.

...

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 configuration page for your Jenkins build project.## Under Build Environment, enter your Skytap User ID and API security token. 
      Image Modified
    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 > Configure System.
    ## In the Skytap Cloud Plugin settings, select Enable Console Logging of Skytap Actions
    Logs will be sent to the Jenkins Project build console.
    Image Modified

Step 3: Adding Skytap Actions to Your 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:
    Image Removed Image Added
  4. Enter any required parameters. For a description of each action and the required parameters, see the sections below. 

Reference: Skytap Actions and Required Parameters

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

...

If you see different action names, please update the Skytap Cloud CI Plugin to the latest version.

Add Environment to Project

This action adds a Skytap environment to a Skytap project.

Image RemovedImage Added
 

Required Parameters

Description

Configuration Environment ID or Configuration Environment 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 Environment from Template” Skytap action), enter the Configuration Environment 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.

...

This action adds a Skytap template to a Skytap project.

Image RemovedImage Added

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” Environment” 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

...

Environment State

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

Image RemovedImage Added

Parameters

Description

Action (Required)

Select "Run ConfigurationEnvironment", "Suspend ConfigurationEnvironment", or "Shutdown ConfigurationEnvironment"

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 Environment ID or Configuration Environment 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 Environment from Template” Skytap action), enter the Configuration Environment Data Save File created from that step.

Connect to Network in another

...

Environment (ICNR)

This action connects two networks in different Skytap environments. The networks must already be configured to allow an Inter-Configuration Network Routing (ICNR) connection to occur. 

Image RemovedImage Added

Required Parameters

Description

Source Configuration Environment ID or Source Configuration Environment 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 Environment from Template” Skytap action), enter the Configuration Environment Data Save File created from that step.

Source Network Name

Enter the name of the network in the source environment.

Target Configuration Environment ID or Target Configuration Data EnvironmentData 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 Environment from Template” Skytap action), enter the Configuration Data Environment 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. 

...

This action will connect a Skytap environment to a Skytap VPN.
Image Removed Image Added

Required Parameters

Description

Configuration ID Environment ID or Configuration FileEnvironmentFile)

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 Environment from Template” Skytap action), enter the Configuration Data Environment Data Save File created from that step.

Configuration Network Environment 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

...

Environment from Template

This action creates a Skytap environment from a Skytap template.
Image Removed Image Added

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” Environment” Skytap action), enter the Template Data Save File created from that step.

Configuration Name Environment Name

Enter a name for the new environment.

Configuration Data Environment Data Save File

Enter a name for the output file (for example, env.json). The plugin will create the output file and populate it with Skytap environment metadata in JSON format. The metadata includes the Skytap environment ID and other information about the environment. This file can be used in Skytap actions that require a Skytap environment ID or other environment metadata.

Create

...

Sharing Portal

This action creates a Published URL for Sharing Portal for a Skytap environment.

Image RemovedImage Added

Required Parameters

Description

Configuration ID Environment ID or Configuration Environment 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 Environment from Template” Skytap action), enter the Configuration Data Environment Data Save File created from that step.

URL Save Filename

Enter a name for the output file (for example, puburl.txt). The plugin will create the output file and populate it with the published URLsharing portal's address. 

Select Permissions

Select a permission level for VMs in the published URLthe sharing portal. 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 URLsharing portal.

Create Published Service

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

Required Parameters

Description

Configuration ID Environment ID or Configuration File Environment 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 Environment from Template” Skytap action), enter the Configuration Data Environment 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 name for the output file (for example, pubservice.txt). The plugin will create the output file and populate it with the “public-URL:port-number”.
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

...

Environment

This action creates a Skytap template from a Skytap configurationenvironment.

Image RemovedImage Added

Required Parameters

Description

Configuration ID Environment ID or Configuration File Environment File

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

Template Name

Enter a name for the new template.

Template Data Save File

Enter a name for the output file (for example, template.json). The plugin will create the output file and populate it with 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 Skytap actions that require a Skytap template ID or other template metadata.

Delete

...

Environment

This action deletes a Skytap environment.

Image RemovedImage Added

Required Parameter

Description

Configuration ID Environment ID or Configuration File Environment File

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

List

...

Sharing Portal for

...

Environment

This action returns the address for an existing published URL sharing portal in a Skytap environment.

Image RemovedImage Added

Required Parameters

Description

Configuration ID Environment ID or Configuration File Environment File

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

Published URL Sharing Portal Name

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

Published URL Sharing Portal Save Filename

Enter a name for the output file (for example, puburl.txt).  The plugin will populate this file with the published URLsharing portal's address.

List VM Published Service

This action returns the "public-URL:port-number" for an existing published service in a Skytap environment.

Image RemovedImage Added

Required Parameters

Description

Configuration ID Environment ID or Configuration File Environment File

Enter a Skytap configuration environment ID (an integer), if one is known. 
If the configuration environment was created in an earlier step (using the "Create Configuration from Environment from Template” Skytap action), enter the Configuration Data Environment 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 name for the output file (for example, pubservice.txt). The plugin will create and populate this file with the "public-URL:port-number."
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

...

Environment

This action will copy VMs from a Skytap template into a Skytap environment.
Image Removed    Image Added

Parameters

Description

Configuration ID Environment ID or Configuration File Environment File (Required)

Enter a Skytap configuration environment ID (an integer), if one is known. 
If the configuration environment was created in an earlier step (using the "Create Configuration from Environment from Template” Skytap action), enter the Configuration Data Environment 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” Environment” Skytap action), enter the Template Data Save File created from that step.

Configuration Data Environment Data Save File (Optional)

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