Solsta Runner Plugin: Team City

Installation and Usage Instructions

teamcity-icon-logo-black-and-grey

The Solsta Runner Plugin for TeamCity adds various runner 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 or CDN in order to make releases available for download by Solsta desktop clients.

Agent Requirements

In order for TeamCity Agent to execute a runner from this plugin, it must have the following components installed:

  • .NET 6.0

Installation

Within your TeamCity server, use the instructions from Installing Additional Plugins to install the Solsta Runner plugin.

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. Restart your TeamCity server after the uninstall (the web UI will prompt you to do this as well).

After the restart, upload the latest Solsta Runner Plugin for TeamCity .zip file, then enable the plugin as you had done during the initial installation. Next, wait for the server to push the latest version of the plugin to your agents. Your agents may be listed under the disconnected section and show “Agent has unregistered (will upgrade)” as a status:

TeamCity recommends waiting up to 10 minutes for agents to be updated. After they receive the latest plugin they will show “connected” again. We recommend reviewing any build steps from the Solsta Runner plugin before executing any new build distributions.

Setup

The Solsta Runner Plugin 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 runners from this plugin in your TeamCity project.

Authentication

The Solsta Runner plugin provides three new Runner Types to use as build steps in TeamCity. Each runner type 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 runner deploys (uploads) a new release to the server, bucket or CDN associated with the specified Environment. When creating a Build Step, select Solsta Deploy as the Runner 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 runner 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 runner 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 runner 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 runner 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.