Solsta Runner Plugin: QuickBuild

Installation and Usage Instructions

The Solsta Deployment Plugin for QuickBuild adds various build step types 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 in order to make releases available for download by Solsta desktop clients.

Agent Requirements

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

  • .NET 6.0

Installation

Within your QuickBuild server, use the instructions from Plugin Management to install the Solsta Deployments Plugin.

Updating the Plugin

Use the steps below to update the plugin to a new version: 

  1. Stop your QuickBuild server/service
  2. Replace the existing plugin file in your plugins directory with the latest version. Example: deploy-quickbuild-plugin-1.15_deploy-3.7_direct-6.1.1.jar
  3. Start (or restart) your QuickBuild server/service

Note that updating the plugin will not remove its steps from any of your existing projects or build configurations. 

Within your QuickBuild server UI, navigate to Administration > Plugin Management and find the “Solsta Deployments Plugin” to ensure the latest version is installed. 

Setup

The Solsta Plugin for QuickBuild requires the creation of Products, Environments and Repositories within the Solsta deployment database. Please see the articles below for how to create those objects using the Solsta Desktop Application.

Once these objects have been created, you can use the build steps from this plugin in your QuickBuild project.

Authentication

The Solsta Deployments Plugin provides three new types of build steps in QuickBuild. 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 build step deploys (uploads) a new release to the server, bucket or CDN associated with the specified Environment. When creating a new Build Step, select Solsta Deploy as the build step type and then fill out the following fields.

  • Product – Target product for deployment
  • Environment – Target environment within containing product
  • Repository – Target repository within containing environment
  • Working Directory – relative path to folder within build checkout directory. The contents of the folder will be deployed.

Solsta Promote

The Solsta Promote build 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 during its execution. 

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.

  • 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 build 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.

Project status

A project is never done, only released and abandoned.