Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction

Deploy Utilities plugin

2 minute readExtensibilityDeveloper productivity

This plugin provides CloudBees CD/RO procedures you can use to perform the following operations:

  • Decommission environments: Create a process step easily using a utility procedure to tear down all the dynamically-created environments, in the context of either a pipeline (process) or a job (procedure).

  • Create a schedule to trigger gate: Create a stage gate that is triggered by a schedule. The idea is to prevent a stage to start before a specific date and time.

Prerequisites

This plugin uses an updated version of Perl, cb-perl shell (Perl v5.32), and requires CloudBees CD/RO agents version 10.3+ to work.

Plugin Version 3.0.1.2024020854

Plugin procedures

For all parameter descriptions below, required parameters are shown in bold italics.

Decommission environments

This procedure will allow users to create a process step easily using utility procedure which will tear down all the dynamically created environments. This procedure can work in the context of either Pipeline or a Job (Process or Procedure).

Parameter Description

EnvironmentList

Provide comma separated list of environments to tear down, in a form of '/projects/[Project Name]/environments/[Environment Name]'.

Create snapshot

This procedure allows the users to create an application snapshot.

Parameter Description

SnapshotName

Name of the snapshot to create

ApplicationName

Name of the application for which the snapshot needs to be created. Either this parameter or ServiceName parameter should be provided.

ServiceName

Name of the service for which the snapshot needs to be created. Either this parameter or ApplicationName parameter should be provided.

ProjectName

Name of the project that the application or service belongs to.

EnvironmentName

Name of the environment on which the application or service is deployed.

EnvironmentProjectName

Name of the project that the environment belongs to, if different from the application or service project.

Overwrite

If checked, delete any existing snapshot with the same name before creating the snapshot

ComponentVersions

This option applies only when the environment name is not specified. For an application snapshot, provide a Space-delimited list of component names and versions to be used. Use keyword 'LATEST' to indicate latest version. E.g., ec_comp1-version=1.1 ec_comp2-version=LATEST.

Release notes

EF-Utilities 3.0.1

  • Improved SSL/TLS certificate validation to ensure that when the Ignore SSL issues parameter is selected that SSL/TLS validation is properly disabled.

EF-Utilities 3.0.0

  • Upgraded from Perl 5.8 to Perl 5.32. The plugin is not backward compatible with CloudBees CD/RO versions prior to 10.3. Starting from this release, a new agent is required to run plugin procedures.

EF-Utilities 1.1.12

  • The documentation has been migrated to the main documentation site.

EF-Utilities 1.1.10

Renaming to "CloudBees"

EF-Utilities 1.1.9

  • Added metadata that is required for 9.0 release.

EF-Utilities 1.1.8

  • Removed default value for ServiceName parameter in Create Snapshot procedure.

EF-Utilities 1.1.7

  • Microservice suppport for Create Snapshot was added.

EF-Utilities 1.0.7

  • Minor changes in documentation.

EF-Utilities 1.0.6

  • Renamed createSnapshot procedure to Create Snapshot

  • Re-enabled Create Snapshot procedure after fixes.

EF-Utilities 1.0.5

  • Optionally handle quoted environment paths in DecommissionEnvironments procedure.

  • Temporarily disabled 'createSnapshot' procedure.

EF-Utilities 1.0.4

  • Temporarily disabled 'createScheduleToTriggerGate' procedure.

EF-Utilities 1.0.3

  • Added 'Create Snapshot' procedure.

EF-Utilities 1.0.2

  • Fix #24 Add changePermissions on the plugin for projects

  • Fix #26 add timeZone parameter to createScheduleToTriggerGate