Solsta Runner Plugin: Jenkins

Installation and Usage Instructions

444-4441461_jenkins-logo-black-and-white-jenkins-ci-hd_adobe_express

The Solsta Plugin for Jenkins adds various build steps that use the Solid State Networks console tools and Manifest API service to deploy and promote releases within the Solsta ecosystem. Deploying consists of converting and uploading raw files (assets) to a bucket or CDN in order to make releases available for download by Solsta desktop clients. The plugin supports both Jenkins freestyle and pipeline projects (see below for details).

Article updated September 14th, 2022 for Solsta Jenkins Plugin version 1.20 or later. 

Node Requirements

In order for a Jenkins Node to execute a build step from this plugin, it must have the following components installed:

  • .NET 6.0

Installation

Within your Jenkins server, use the “advanced installation” instructions from Managing Plugins to upload and install the Solsta plugin .hpi file.

Updating the Plugin

If you are updating the plugin from a previous version, we recommend uninstalling the existing plugin first. Uninstalling a plugin will not permanently remove its steps from any of your existing projects.

After the uninstall, upload and install the latest Solsta Plugin for Jenkins .hpi file and then restart your Jenkins server. This is required when installing new plugins and it ensures your server is using the latest version. We recommend reviewing any build steps from the Solsta plugin before executing any new builds.

Optional Setup via Solsta Desktop Application

The Solsta Plugin allows for the creation of Products, Environments and Repositories within the Solsta deployment database during the deployment step, however, those objects can also be created in the Solsta Desktop Application. Please see the articles below for more information:

Authentication

The Solsta Plugin provides three new options to use as build steps in Jenkins. Each build step requires a Client ID and Client Secret from Solid State Networks. These credentials were provided when your company signed up for Solsta. Contact your company’s primary contact with Solid State Networks or open a support ticket for assistance.

Solsta Deploy

The Solsta Deploy step deploys (uploads) a new release to the server, bucket or CDN associated with the specified Environment. When creating a Build Step, select Solsta Deploy from the dropdown and then fill out the following fields.

  • Create checkbox – when checked, the Product, Environment and Repository you specify in the fields below will be automatically created during deployment. When unchecked, you will be picking existing Products, Environments and Repositories using dropdown boxes.
  • Product – Target product for deployment
  • Environment – Target environment within containing product
  • Repository – Target repository within containing environment
  • Release Version – Optional, specify a dynamic environment variable or build parameter to use as a friendly version number within Solsta Desktop Application (e.g. 1.0.12).
  • Working Directory – relative path to folder within build checkout directory. The contents of the folder will be deployed.

 

Pipeline Project Support

The screenshot above shows configuring the plugin in a Jenkins “Freestyle” project. If your Jenkins project is a  “Pipeline” type, you can use the Pipeline Syntax section of Jenkins to generate a snippet for each of the steps available from this plugin. In the Sample Step dropdown, each step from the plugin will be pre-pended by ssn_.

  • ssn_cleanup: Solsta Cleanup
  • ssn_deploy: Solsta Deploy
  • ssn_promote: Solsta Promote

On the Snippet Generator page, select your desired Sample Step and fill out each of the fields. Afterwards, scroll down and click the Generate Pipeline Script button:

From here, you can copy and paste the snippet into your Pipeline deployment script. Of course, you can update it with any dynamic values or environment variables as necessary.

Solsta Promote

The Solsta Promote step promotes the latest release from a source Product, Environment and Repository to a target Product, Environment and Repository. If the source and target Environments have different source location values (buckets or origin servers), the promote step will automatically copy all necessary files from the source location to the target location as part of the promotion step.

Also, if the target environment has an update path count value greater than zero, the promote step will automatically create delta update paths within the target Environment and Repository as part of the promotion step.

  • Source Product – Source product for promotion
  • Source Environment – Source environment within containing product
  • Source Repository – Source repository within containing environment
  • Target Product – Target product for promotion
  • Target Environment – Target environment within containing product
  • Target Repository – Target repository within containing environment

Solsta Cleanup

The Solsta Cleanup step cleans up (deletes) old, unused release data from the server, bucket or CDN associated with the specified Environment. Deleting releases is upcoming functionality in the Solsta Desktop Application.

  • Product – Target product for cleanup
  • Environment – Target environment within containing product
  • Trial Run – Checking this box performs a dry run, listing which files would be deleted without actually deleting them.

 

License

© Solid State Networks, LLC. All Rights Reserved.