1. dbmaestro/devops-automation@1.0.1

dbmaestro/devops-automation@1.0.1

Partner
Sections
DBmaestro DevOps Platform, an enforced change management platform that automates and streamlines database development and deployment tasks. DBmaestro is the leading DevOps database solution provider for research and development organizations with multiple database vendors and environments. DBmaestro brings true continuous delivery – complete with the practices proven to be most effective for application development – to the database. Our product transforms development operations by: Dramatically increasing productivity Reducing development costs Adding a surefire safety net for database automation These benefits are achieved by leveraging a guaranteed single point-of-truth source control system and a powerful impact analysis engine. The DBmaestro DevOps Platform automates and streamlines database development and deployment tasks and provides a centralized system for managing database development. The automated deployment solution simplifies the process of deploying changes from development to integration environments. Integral to the design is a sophisticated permission-architecture for customizing roles and ensuring security.
Created: September 20, 2021Version Published: October 28, 2021Releases: 2
Org Usage:
< 25
Categories:

Orb Quick Start Guide

Use CircleCI version 2.1 at the top of your .circleci/config.yml file.

1 version: 2.1

Add the orbs stanza below your version, invoking the orb:

1 2 orbs: devops-automation: dbmaestro/devops-automation@1.0.1

Use devops-automation elements in your existing workflows and jobs.

Opt-in to use of uncertified orbs on your organization’s Security settings page.

Usage Examples

build-run

This job will create project package by Buid, deploy it to the Release source and QA environments Then - transfer this package to "Release" project and deployed to Release Source and Production Job description 1. Package is created using build command for environment Dev_Env_1 for project "Development" 2. Release source is being updated to the latest version using update command at project "Development" 3. Same package is being deployed to the QA environment at project "Development" 4. Package is being transferred to the project "Release" 5. Release source at project "Release" is being updated to the latest version using update command 6. Finally, package is being deployed to the Production environment (Prod_Env_1) of "Release" project

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 version: '2.1' orbs: dop: dbmaestro/devops-automation@1.0.0 jobs: dbm-deploy: docker: - image: cimg/openjdk:16.0.2 environment: DBMAESTRO_AUTH_TYPE: DBmaestroAccount DBMAESTRO_SERVER_ADDRESS: dbm.automation.host:8017 DBMAESTRO_USERNAME: test@dbmaestro.com steps: - checkout - dop/download-automation-jar - dop/build: environment_name: Dev_Env_1 project_name: Development version_level: MAJOR - dop/upgrade: environment_name: Release Source package_name: '@latestversion' project_name: Development - dop/upgrade: environment_name: QA_Env_1 package_name: '@latestversion' project_name: Development - dop/transfer-up-package: project_name: Development source_package: '@latestversion' target_project_name: Release version_level: MINOR - dop/upgrade: environment_name: Release Source package_name: '@latestversion' project_name: Release - dop/upgrade: environment_name: Prod_Env_1 package_name: '@latestversion' project_name: Release workflows: test-run: jobs: - dbm-deploy

package-run

This job will create project package from user created scripts and a package manifest using the Package command, and then deploy it to the Release source. The package manifest is a .json file named Package.json consisting of a header section and an array of script sections in the order in which the scripts should be executed when an environment is upgraded or downgraded. The upgrade and downgrade scripts are stored in the Upgrade and Downgrade directories respectively. These two directories are subdirectories of another directory. Details are specified in https://dbmaestro.atlassian.net/wiki/spaces/DBm20Docs/pages/1173331919/Generating+Project+Packages+by+Automation Job description 1. Package manifest is created using create-manifest command 2. Package folder is being zipped 3. New package is being imported to DBmaestro using package command 4. Package is being pre-checked using pre-check command 5. Release source is being updated using update command

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 version: '2.1' orbs: dop: dbmaestro/devops-automation@1.0.0 jobs: dbm-deploy: docker: - image: cimg/openjdk:16.0.2 environment: DBMAESTRO_AUTH_TYPE: DBmaestroAccount DBMAESTRO_SERVER_ADDRESS: dbm.automation.host:8017 DBMAESTRO_USERNAME: test@dbmaestro.com steps: - checkout - dop/download-automation-jar - dop/create-manifest-file: path_to_scripts_folder: V3 - run: command: cd V3&&zip -r ../V3.zip *&&cd .. name: Zip the package - dop/package: file_path: V3.zip project_name: DEMO - dop/pre-check: package_name: V3 project_name: DEMO - dop/upgrade: environment_name: Release Source package_name: V3 project_name: DEMO workflows: test-run: jobs: - dbm-deploy

Commands

add-tag

Assign a Tag to an Object - A Tag is a text descriptor for assigning attributes, properties and metadata to a package or script. For example, a Jenkins build number or build date. - A Tag must be associated with a Tag Type. Therefore, both the Tag Name and Tag Type Name must be specified. - A Tag may also be assigned to an Object through the DBmaestro DevOps Platform or by a package manifest. - An Object Name can be associated with more than one Object Type. Therefore, if ObjectName is specified, then ObjectTypeName must also be specified

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
object_name
DBmaestro object name.
No
''
string
object_type_name
DBmaestro object type name.
No
''
string
package_name
DBmaestro package name
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tag_name
DBmaestro tag name.
Yes
-
string
tag_type_name
DBmaestro tag type name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

add-tag-type

Add a Tag Type to the DBmaestro DevOps Platform - A Tag Type must be created before a Tag can be assigned to an Object. - A Tag Type is a text descriptor for a Tag. For example, "custom", "task".

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tag_type_name
DBmaestro tag type name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

apply-label

Perform Apply Label operation on an Environment A label is an aggregation of the latest check-in for all objects in Source control for a schema or database.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
environment_name
DBmaestro environment name
Yes
-
string
label_description
label description.
Yes
-
string
label_name
Label name.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

backup-environment

Queue a Backup Environment Job

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
backup_description
Backup description.
No
''
string
backup_name
Backup name.
Yes
-
string
environment_name
DBmaestro environment name
Yes
-
string
ignore_env_version_mismatch
Ignore environment version mismatch
No
'True'
enum
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

build

Queue a Build Environment job to the DBmaestro DevOps Platform Available in SQL Server projects only

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
after_current_deployed_version
Ignore environment version mismatch
No
'False'
enum
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
baseline_label_name
Name of label to be used as baseline
No
''
string
environment_name
DBmaestro environment name
Yes
-
string
label_name
Label name to be used or applied
No
''
string
package_name
Package name
No
''
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name
version_level
MAJOR or MINOR
No
''
enum
version_type
Specifies the version type to be used in build process
No
''
enum

cancel-job

Cancel a Job in the DBmaestro DevOps Platform

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
job_id
DBmaestro job id.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

create-manifest-file

Create or Update a Package manifest file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
operation
Package operation
No
CreateOrUpdate
enum
path_to_scripts_folder
Path to sripts folder
Yes
-
string
scripts_order_scope
Scripts order scope
No
Global
enum
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name

custom-build

Queue a CustomBuild Job to the DBmaestro DevOps Platform Enables the build of scripts between any two projects/environments

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
baseline_environment_name
Baseline environment name
No
''
string
baseline_project_name
Baseline project name
No
''
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
source_environment_name
Source environment name
Yes
-
string
source_label_name
Label name to be used as source
No
''
string
source_project_name
Source project name
Yes
-
string
source_version_type
Specifies the source version type to be used in build process
Yes
-
enum
target_environment_name
Target environment name
Yes
-
string
target_label_name
Label name to be used as target in build process
No
''
string
target_project_name
Target project name
Yes
-
string
target_version_type
Specifies the target version type to be used in build process
Yes
-
enum
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

delete-project

Delete a Project

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

delete-project-mapping

Delete a Project Mapping from the DBmaestro DevOps Platform

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
target_project_name
Target project name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

delete-tag

Delete a Tag from an Object

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
object_name
DBmaestro object name.
No
''
string
object_type_name
DBmaestro object type name.
No
''
string
package_name
DBmaestro package name
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tag_name
DBmaestro tag name.
Yes
-
string
tag_type_name
DBmaestro tag type name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

delete-tag-type

Delete a Tag Type - If a Tag associated with a Tag Type has been assigned to an Object, then that Tag Type cannot be deleted.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tag_type_name
DBmaestro tag type name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

display-project-mapping

Display a Project Mapping in the DBmaestro DevOps Platform

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
target_project_name
Target project name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

download-automation-jar

Ensure environment has DBmaestroAgent.jar If not - download it

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name

export-project

Export a Project to a .json file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
file_path
Full .json file path to project.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

get-env-packages

Print a list of packages in an Environment

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
date_format
Java SimpleDateFormat.
No
''
string
environment_name
DBmaestro environment name.
Yes
-
string
file_path
Full .json file path to project.
No
''
string
from_date
Start date from which to check.
No
''
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
to_date
End date up to which to check.
No
''
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

get-latest

Update the Dev environment to the latest version or label for a project deployed by version, or to the latest package or label for a project deployed by task. The update environment operation is supported with the latest baseline

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
baseline_label_name
Baseline label name
No
''
string
create_scripts_only
Ignore environment version mismatch
No
'False'
enum
environment_name
DBmaestro environment name
Yes
-
string
label_name
Label name
No
''
string
package_name
Source package name
No
''
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

get-roles

Retrieve all DBmaestro roles and save in a .csv file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
file_path
Full .json file path to project.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

get-specific

Update the Dev environment to a specific version or label for a project deployed by version, or to a specific package or label for a project deployed by task. The update environment operation is supported with or without a baseline to allow preservation of developer changes to the Dev environment.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
baseline_label_name
Baseline label name
No
''
string
create_scripts_only
Ignore environment version mismatch
No
'False'
enum
environment_name
DBmaestro environment name
Yes
-
string
label_name
Label name
No
''
string
package_name
Source package name
No
''
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

get-user-project-roles

Retrieve all DBmaestro users and roles listed by project and save in a .csv file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
file_path
Full .json file path to project.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

import-project

Import a Project from a .json file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
file_path
Full .json file path to project.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

package

Queue a Package Job to the DBmaestro DevOps Platform - Creates a Package for an Environment - If Oracle scripts do not include the buffer flush directive ('/') and CancelJob has been issued, then a warning will be displayed next to the script unless suppressed and ignored through the -IgnoreScriptWarnings parameter. This warning CAN also be ignored deliberately through the DBmaestro DevOps Platform interface.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
file_path
Full .json file path to project.
Yes
-
string
ignore_script_warnings
Ignore/don't ignore warnings in scripts
No
'True'
enum
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

pre-check

Perform a policy enforcement and pre-validation on a Package - If a PreRun Environment has been created during Project creation, then a simulation is run in the PreRun Environment as well. The PreRun Environment option is not available in a DB2 project.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
package_name
DBmaestro package name
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

pre-check-env

Perform a policy enforcement and pre-validation on a Package in an Environment

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
environment_name
DBmaestro environment name
Yes
-
string
package_name
DBmaestro package name
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

project-mapping

Queue a Project Mapping to the DBmaestro DevOps Platform - A Project Mapping must be constructed between two projects before the TransferUpPackage, TransferDownPackage or TransferPackage functions can be executed. The primary purpose of the mapping is to link schema differences between projects and enable constructing and managing a multi-project pipeline.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
keep_state
Keep the state of the package
No
'False'
enum
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name.
Yes
-
string
schema_map
Link between source schema versus target schema. i.e. <'SchemaNameX1=SchemaNameY1,SchemaNameX2=SchemaNameY2...'>
No
''
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
target_project_name
Target project name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
transfer_opened_package
Allow transferring open packages in TransferUpPackage and TransferDownPackage functions
No
'False'
enum
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

restore-environment

Restore an Environment from a saved Backup

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
backup_name
Backup name.
Yes
-
string
environment_name
DBmaestro environment name
Yes
-
string
force_set_version
Ignore environment version mismatch
No
'False'
enum
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

rollback

Queue a Rollback Environment Job to Database Release Automation - If -CreateScriptsOnly is specified, then the Rollback Job is not queued. Instead, a Rollback Job package is created but not executed. The Rollback package will be available for execution in the Upgrade command.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
backup_behavior
<AlwaysCreateBackup> or <UsePolicy> or <SkipCreatingBackup>
No
''
enum
create_scripts_only
Execute package
No
'False'
enum
environment_name
DBmaestro environment name
Yes
-
string
label_name
Label name to be used or applied
No
''
string
package_name
Label name to be used or applied
No
''
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
restore_behavior
<AlwaysRestore> or <SkipRestore>
No
''
enum
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

run-package-dev

Perform Apply Label operation on an Environment A label is an aggregation of the latest check-in for all objects in Source control for a schema or database.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
environment_name
DBmaestro environment name
Yes
-
string
package_name
Package name.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
script_type
<Upgrade> or <Downgrade>
No
Upgrade
enum
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

set-version

Set the Environment Package version - Validates that the Environment matches the Release Source deployed Package Label for the requested Package. If valid, sets the Target Environment to that version. - If -Force is specified, the Target environment version is set as requested, even if the validation fails.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
environment_name
DBmaestro environment name
Yes
-
string
force
Force the operation, ignoring usual operation block
No
'False'
enum
package_name
Package name.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

sync-permissions

Synchronize permissions for all Active Directory or LDAP users

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

transfer-down-package

Queue a DBmaestro DevOps Platform job to Transfer a Package from a Project to a downstream Target Project - A Project Mapping must have been created before the function can be executed. - The Target Project must be at a lower level in the Project Mapping hierarchy than the Source Package.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
source_package
Source package name
Yes
-
string
target_package
Target package name
No
''
string
target_project_name
Target project name
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name
version_level
MAJOR or MINOR
No
''
enum

transfer-package

Queue a Project Transfer Job to the DBmaestro DevOps Platform - A Project Mapping must have been created before the TransferPackage function can be executed.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
source_package
Source package name
Yes
-
string
target_package
Target package name
No
''
string
target_project_name
Target project name
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name
version_level
MAJOR or MINOR
No
''
enum

transfer-up-package

Queue a DBmaestro DevOps Platform job to Promote a Package from a Project to an upstream Target Project - A Project Mapping must have been created before the function can be executed. - The Target Project must be at a higher level in the Project Mapping hierarchy than the Source Package.

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
source_package
Source package name
Yes
-
string
target_package
Target package name
No
''
string
target_project_name
Target project name
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name
version_level
MAJOR or MINOR
No
''
enum

update-project

Update a Project from a .json file

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
file_path
Full .json file path to project.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

update-tag-type

Add a Tag Type to the DBmaestro DevOps Platform - A Tag Type must be created before a Tag can be assigned to an Object. - A Tag Type is a text descriptor for a Tag. For example, "custom", "task".

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
new_tag_type_name
New tag type name.
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tag_type_name
DBmaestro tag type name.
Yes
-
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

upgrade

Queue an Upgrade Environment Job to the DBmaestro DevOps Platform

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
backup_behavior
<AlwaysCreateBackup> or <UsePolicy> or <SkipCreatingBackup>
No
''
enum
environment_name
DBmaestro environment name
Yes
-
string
package_name
Label name to be used or applied
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
restore_behavior
<AlwaysRestore> or <SkipRestore>
No
''
enum
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tag_name
Tag name
No
''
string
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

validate

Validate an Environment with Database Release Automation Checks for environment drift from specified version

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
environment_name
DBmaestro environment name
Yes
-
string
package_name
DBmaestro package name. By default runs validation against current version
No
'@currentversion'
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

view-labels

Print out a list of labels for an Environment

Show command Source
PARAMETER
DESCRIPTION
REQUIRED
DEFAULT
TYPE
auth_type
DBmaestro auth type
No
DBMAESTRO_AUTH_TYPE
env_var_name
environment_name
DBmaestro environment name
Yes
-
string
password
DBmaestro password
No
DBMAESTRO_PASSWORD
env_var_name
project_name
DBmaestro project name
Yes
-
string
server_address
DBmaestro server address
No
DBMAESTRO_SERVER_ADDRESS
env_var_name
tool_path
Path where the DBmaestroAgent.jar is located
No
DBMAESTRO_TOOL_PATH
env_var_name
use_ssl
Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n.
No
DBMAESTRO_USE_SSL
env_var_name
username
DBmaestro username
No
DBMAESTRO_USERNAME
env_var_name

Orb Source

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 # This code is licensed from CircleCI to the user under the MIT license. # See here for details: https://circleci.com/developer/orbs/licensing version: 2.1 description: | DBmaestro DevOps Platform, an enforced change management platform that automates and streamlines database development and deployment tasks. DBmaestro is the leading DevOps database solution provider for research and development organizations with multiple database vendors and environments. DBmaestro brings true continuous delivery – complete with the practices proven to be most effective for application development – to the database. Our product transforms development operations by: Dramatically increasing productivity Reducing development costs Adding a surefire safety net for database automation These benefits are achieved by leveraging a guaranteed single point-of-truth source control system and a powerful impact analysis engine. The DBmaestro DevOps Platform automates and streamlines database development and deployment tasks and provides a centralized system for managing database development. The automated deployment solution simplifies the process of deploying changes from development to integration environments. Integral to the design is a sophisticated permission-architecture for customizing roles and ensuring security. display: home_url: https://www3.dbmaestro.com/circleci source_url: https://github.com/DBMaestroDev/circleci-orb commands: add-tag: description: | Assign a Tag to an Object - A Tag is a text descriptor for assigning attributes, properties and metadata to a package or script. For example, a Jenkins build number or build date. - A Tag must be associated with a Tag Type. Therefore, both the Tag Name and Tag Type Name must be specified. - A Tag may also be assigned to an Object through the DBmaestro DevOps Platform or by a package manifest. - An Object Name can be associated with more than one Object Type. Therefore, if ObjectName is specified, then ObjectTypeName must also be specified parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name object_name: default: "" description: DBmaestro object name. type: string object_type_name: default: "" description: DBmaestro object type name. type: string package_name: description: DBmaestro package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tag_name: description: DBmaestro tag name. type: string tag_type_name: description: DBmaestro tag type name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash AddTag(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -AddTag -ProjectName "'$DBM_PROJECT_NAME'" -PackageName "'$DBM_PACKAGE_NAME'" -TagTypeName "'$DBM_TAG_TYPE_NAME'" -TagName "'$DBM_TAG_NAME'"' if [[ -n ${OBJ_TYPE_NAME} && -n ${OBJ_NAME} ]]; then CMDLINE=$CMDLINE'-ObjectTypeName "'$OBJ_TYPE_NAME'" -ObjectName "'$OBJ_NAME'"' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then AddTag fi environment: DBM_OBJECT_NAME: << parameters.object_name >> DBM_OBJECT_TYPE_NAME: << parameters.object_type_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_TAG_NAME: << parameters.tag_name >> DBM_TAG_TYPE_NAME: << parameters.tag_type_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Add tag add-tag-type: description: | Add a Tag Type to the DBmaestro DevOps Platform - A Tag Type must be created before a Tag can be assigned to an Object. - A Tag Type is a text descriptor for a Tag. For example, "custom", "task". parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tag_type_name: description: DBmaestro tag type name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -AddTagType -TagTypeName "$DBM_TAG_TYPE_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PASSWORD: << parameters.password >> DBM_TAG_TYPE_NAME: << parameters.tag_type_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Add tag type apply-label: description: | Perform Apply Label operation on an Environment A label is an aggregation of the latest check-in for all objects in Source control for a schema or database. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name environment_name: description: DBmaestro environment name type: string label_description: description: label description. type: string label_name: description: Label name. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -ApplyLabel -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -LabelName "$DBM_LABEL_NAME" -LabelDescription "$DBM_LABEL_DESCRIPTION" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UseSSL "$DBM_USE_SSL" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_LABEL_DESCRIPTION: << parameters.label_description >> DBM_LABEL_NAME: << parameters.label_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Apply label backup-environment: description: | Queue a Backup Environment Job parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name backup_description: default: "" description: Backup description. type: string backup_name: description: Backup name. type: string environment_name: description: DBmaestro environment name type: string ignore_env_version_mismatch: default: "True" description: Ignore environment version mismatch enum: - "True" - "False" type: enum password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash BackupEnvironment(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -BackupEnvironment -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'" -BackupName "'$DBM_BACKUP_NAME'" -IgnoreEnvVersionMismatch "'$DBM_IGNORE_ENV_VERSION_MISMATCH'"' if [[ -n ${DBM_BACKUP_DESCRIPTION} ]]; then CMDLINE=$CMDLINE' -BackupDescription "'$DBM_BACKUP_DESCRIPTION'"' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then BackupEnvironment fi environment: DBM_BACKUP_DESCRIPTION: << parameters.backup_description >> DBM_BACKUP_NAME: << parameters.backup_name >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_IGNORE_ENV_VERSION_MISMATCH: << parameters.ignore_env_version_mismatch >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Backup environment build: description: | Queue a Build Environment job to the DBmaestro DevOps Platform Available in SQL Server projects only parameters: after_current_deployed_version: default: "False" description: Ignore environment version mismatch enum: - "True" - "False" type: enum auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name baseline_label_name: default: "" description: Name of label to be used as baseline type: string environment_name: description: DBmaestro environment name type: string label_name: default: "" description: Label name to be used or applied type: string package_name: default: "" description: Package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name version_level: default: "" description: MAJOR or MINOR enum: - MAJOR - MINOR - "" type: enum version_type: default: "" description: Specifies the version type to be used in build process enum: - latest - label - latestlabel - changesets - live - "" type: enum steps: - run: command: |- #!/bin/bash Build(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -Build -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'" ' if [[ -n ${DBM_VERSION_TYPE} ]]; then CMDLINE=$CMDLINE'-VersionType "'$DBM_VERSION_TYPE' "' fi if [[ -n ${DBM_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-LabelName "'$DBM_LABEL_NAME'" ' fi if [[ -n ${DBM_BASELINE_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-BaselineLabelName "'$DBM_BASELINE_LABEL_NAME'" ' fi if [[ -n ${DBM_PACKAGE_NAME} ]]; then CMDLINE=$CMDLINE'-PackageName "'$DBM_PACKAGE_NAME'" ' fi if [[ -n ${DBM_VERSION_LEVEL} ]]; then CMDLINE=$CMDLINE'-CreatePackage -VersionLevel "'$DBM_VERSION_LEVEL' -AfterCurrentDeployedVersion "'$DBM_AFTER_CURRENT_DEPLOYED_VERSION' "' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' echo "$CMDLINE" eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then Build fi environment: DBM_AFTER_CURRENT_DEPLOYED_VERSION: << parameters.after_current_deployed_version >> DBM_BASELINE_LABEL_NAME: << parameters.baseline_label_name >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_LABEL_NAME: << parameters.label_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_VERSION_LEVEL: << parameters.version_level >> DBM_VERSION_TYPE: << parameters.version_type >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Build cancel-job: description: | Cancel a Job in the DBmaestro DevOps Platform parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name job_id: description: DBmaestro job id. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -CancelJob -JobId "$DBM_JOB_ID" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_JOB_ID: << parameters.job_id >> DBM_PASSWORD: << parameters.password >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Add tag create-manifest-file: description: | Create or Update a Package manifest file parameters: operation: default: CreateOrUpdate description: Package operation enum: - CreateOrUpdate - Create - Update type: enum path_to_scripts_folder: description: Path to sripts folder type: string scripts_order_scope: default: Global description: Scripts order scope enum: - Global - Schema type: enum tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -CreateManifestFile -PathToScriptsFolder "$DBM_PATH_TO_SCRIPTS_FOLDER" -Operation "$DBM_OPERATION" -ScriptsOrderScope "$DBM_SCRIPTS_ORDER_SCOPE" environment: DBM_OPERATION: << parameters.operation >> DBM_PATH_TO_SCRIPTS_FOLDER: << parameters.path_to_scripts_folder >> DBM_SCRIPTS_ORDER_SCOPE: << parameters.scripts_order_scope >> PDBM_TOOL_PATH: << parameters.tool_path >> name: Create manifest file custom-build: description: | Queue a CustomBuild Job to the DBmaestro DevOps Platform Enables the build of scripts between any two projects/environments parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name baseline_environment_name: default: "" description: Baseline environment name type: string baseline_project_name: default: "" description: Baseline project name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name source_environment_name: description: Source environment name type: string source_label_name: default: "" description: Label name to be used as source type: string source_project_name: description: Source project name type: string source_version_type: description: Specifies the source version type to be used in build process enum: - latest - label - latestlabel - live type: enum target_environment_name: description: Target environment name type: string target_label_name: default: "" description: Label name to be used as target in build process type: string target_project_name: description: Target project name type: string target_version_type: description: Specifies the target version type to be used in build process enum: - latest - label - latestlabel - live type: enum tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash CustomBuild(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -CustomBuild -SourceProjectName "'$DBM_SOURCE_PROJECT_NAME'" -SourceEnvName "'$DBM_SOURCE_ENVIRONMENT_NAME'" -TargetProjectName "'$DBM_TARGET_PROJECT_NAME'" -TargetEnvName "'$DBM_TARGET_ENVIRONMENT_NAME'" ' if [[ -n ${DBM_BASELINE_PROJECT_NAME} && -n ${DBM_BASELINE_ENVIRONMENT_NAME} ]]; then CMDLINE=$CMDLINE'-BaselineProjectName "'$DBM_BASELINE_PROJECT_NAME' -BaselineEnvName "'$DBM_BASELINE_ENVIRONMENT_NAME'" ' fi CMDLINE=$CMDLINE'-SourceVersionType "'$DBM_SOURCE_VERSION_TYPE'" -TargetVersionType "'$DBM_TARGET_VERSION_TYPE'" ' if [[ -n ${DBM_SOURCE_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-SourceLabelName "'$DBM_SOURCE_LABEL_NAME' "' fi if [[ -n ${DBM_TARGET_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-TargetLabelName "'$DBM_TARGET_LABEL_NAME' "' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' echo "$CMDLINE" eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then CustomBuild fi environment: DBM_BASELINE_ENVIRONMENT_NAME: << parameters.baseline_environment_name >> DBM_BASELINE_PROJECT_NAME: << parameters.baseline_project_name >> DBM_PASSWORD: << parameters.password >> DBM_SOURCE_ENVIRONMENT_NAME: << parameters.source_environment_name >> DBM_SOURCE_LABEL_NAME: << parameters.source_label_name >> DBM_SOURCE_PROJECT_NAME: << parameters.source_project_name >> DBM_SOURCE_VERSION_TYPE: << parameters.source_version_type >> DBM_TARGET_ENVIRONMENT_NAME: << parameters.target_environment_name >> DBM_TARGET_LABEL_NAME: << parameters.target_label_name >> DBM_TARGET_PROJECT_NAME: << parameters.target_project_name >> DBM_TARGET_VERSION_TYPE: << parameters.target_version_type >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Custom build delete-project: description: | Delete a Project parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -DeleteProject -ProjectName "$DBM_PROJECT_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Delete project delete-project-mapping: description: | Delete a Project Mapping from the DBmaestro DevOps Platform parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name target_project_name: description: Target project name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -DeleteProjectMapping -ProjectName "$DBM_PROJECT_NAME" -TargetProjectName "$DBM_TARGET_PROJECT_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_TARGET_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Delete project mapping delete-tag: description: | Delete a Tag from an Object parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name object_name: default: "" description: DBmaestro object name. type: string object_type_name: default: "" description: DBmaestro object type name. type: string package_name: description: DBmaestro package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tag_name: description: DBmaestro tag name. type: string tag_type_name: description: DBmaestro tag type name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash DeleteTag(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -DeleteTag -ProjectName "'$DBM_PROJECT_NAME'" -PackageName "'$DBM_PACKAGE_NAME'" -TagTypeName "'$DBM_TAG_TYPE_NAME'" -TagName "'$DBM_TAG_NAME'" ' if [[ -n ${OBJ_TYPE_NAME} && -n ${OBJ_NAME} ]]; then CMDLINE=$CMDLINE'-ObjectTypeName "'$OBJ_TYPE_NAME'" -ObjectName "'$OBJ_NAME'"' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then DeleteTag fi environment: DBM_OBJECT_NAME: << parameters.object_name >> DBM_OBJECT_TYPE_NAME: << parameters.object_type_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_TAG_NAME: << parameters.tag_name >> DBM_TAG_TYPE_NAME: << parameters.tag_type_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Delete tag delete-tag-type: description: | Delete a Tag Type - If a Tag associated with a Tag Type has been assigned to an Object, then that Tag Type cannot be deleted. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tag_type_name: description: DBmaestro tag type name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -DeleteTagType -TagTypeName "$DBM_TAG_TYPE_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PASSWORD: << parameters.password >> DBM_TAG_TYPE_NAME: << parameters.tag_type_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Delete tag type display-project-mapping: description: | Display a Project Mapping in the DBmaestro DevOps Platform parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name target_project_name: description: Target project name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -DisplayProjectMapping -ProjectName "$DBM_PROJECT_NAME" -TargetProjectName "$DBM_TARGET_PROJECT_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_TARGET_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Add tag download-automation-jar: description: | Ensure environment has DBmaestroAgent.jar If not - download it parameters: tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name steps: - run: command: "Download(){\nif [ -z \"${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}\" ]; then echo \"DBmaestro tool path is not set\"&&exit 1; fi\n#Check if dbmaestroagent.jar already exists\nif [ -f \"${DBM_TOOL_PATH}/DBmaestroAgent.jar\" ]; then\n echo \"${DBM_TOOL_PATH}/DBmaestroAgent.jar already exists.\"\n exit 0\nfi\n\n# the directory of the script\nDIR=\"$( cd \"$( dirname \"${BASH_SOURCE[0]}\" )\" && pwd )\"\n\n# the temp directory used, within $DIR\n# omit the -p parameter to create a temporal directory in the default location\nDBM_TEMP=$(mktemp -d -p \"$DIR\")\n\n# check if tmp dir was created\nif [ ! -d \"$DBM_TEMP\" ]; then\n echo \"Could not create temp dir\"\n exit 1\nfi\n\n# deletes the temp directory\nfunction cleanup { \n rm -rf \"$DBM_TEMP\"\n echo \"Deleted temp working directory $DBM_TEMP\"\n}\n\n# register the cleanup function to be called on the EXIT signal\ntrap cleanup EXIT\n\n# Download and unzip jar\nwget https://dbmaestro.com/Downloads/DOP-X/Utilities/DBmaestroAgent.zip -O \"$DBM_TEMP/DBmaestroAgent.zip\"\necho \"${DBM_TOOL_PATH}\"\nmkdir -p \"${DBM_TOOL_PATH}\"\nunzip \"$DBM_TEMP/DBmaestroAgent.zip\" -d \"${DBM_TOOL_PATH}\"\necho \"Downlaod completed\"\n}\n\n# Will not run if sourced for bats-core tests.\n# View src/tests for more information.\nORB_TEST_ENV=\"bats-core\"\nif [ \"${0#*$ORB_TEST_ENV}\" == \"$0\" ]; then\n Download\nfi" environment: PDBM_TOOL_PATH: << parameters.tool_path >> name: Download Agent export-project: description: | Export a Project to a .json file parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name file_path: description: Full .json file path to project. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -ExportProject -ProjectName "$DBM_PROJECT_NAME" -FilePath "$DBM_FILE_PATH" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_FILE_PATH: << parameters.file_path >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Export project get-env-packages: description: | Print a list of packages in an Environment parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name date_format: default: "" description: Java SimpleDateFormat. type: string environment_name: description: DBmaestro environment name. type: string file_path: default: "" description: Full .json file path to project. type: string from_date: default: "" description: Start date from which to check. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name to_date: default: "" description: End date up to which to check. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash GetEnvPackages(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -GetEnvPackages -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'"' if [[ -n ${DBM_FROM_DATE} ]]; then CMDLINE=$CMDLINE' -FromDate "'$DBM_FROM_DATE' "' fi if [[ -n ${DBM_TO_DATE} ]]; then CMDLINE=$CMDLINE'-ToDate "'$DBM_TO_DATE' "' fi if [[ -n ${DBM_DATE_FORMAT} ]]; then CMDLINE=$CMDLINE'-DateFormat "'$DBM_DATE_FORMAT' "' fi if [[ -n ${DBM_FILE_PATH} ]]; then CMDLINE=$CMDLINE'-FilePath "'$DBM_FILE_PATH' "' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then GetEnvPackages fi environment: DBM_DATE_FORMAT: << parameters.date_format >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_FILE_PATH: << parameters.file_path >> DBM_FROM_DATE: << parameters.from_date >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_TO_DATE: << parameters.to_date >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Get environment packages get-latest: description: | Update the Dev environment to the latest version or label for a project deployed by version, or to the latest package or label for a project deployed by task. The update environment operation is supported with the latest baseline parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name baseline_label_name: default: "" description: Baseline label name type: string create_scripts_only: default: "False" description: Ignore environment version mismatch enum: - "True" - "False" type: enum environment_name: description: DBmaestro environment name type: string label_name: default: "" description: Label name type: string package_name: default: "" description: Source package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash GetLatest(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -GetLatest -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'" ' if [[ -n ${DBM_PACKAGE_NAME} ]]; then CMDLINE=$CMDLINE'-PackageName "'$DBM_PACKAGE_NAME'" ' fi if [[ -n ${DBM_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-LabelName "'$DBM_LABEL_NAME'" ' fi if [[ -n ${DBM_BASELINE_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-BaselineLabelName "'$DBM_BASELINE_LABEL_NAME'" ' fi if [[ -n ${DBM_CREATE_DCRIPTS_ONLY} ]]; then CMDLINE=$CMDLINE'-CreateScriptsOnly "'$DBM_CREATE_DCRIPTS_ONLY'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' echo "$CMDLINE" eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then GetLatest fi environment: DBM_BASELINE_LABEL_NAME: << parameters.baseline_label_name >> DBM_CREATE_DCRIPTS_ONLY: << parameters.create_scripts_only >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_LABEL_NAME: << parameters.baseline_label_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Get latest get-roles: description: | Retrieve all DBmaestro roles and save in a .csv file parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name file_path: description: Full .json file path to project. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBmaestro password is not set"&&exit 1; fi echo $DBM_PWD java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -GetRoles -FilePath "$DBM_FILE_PATH" -Server "$DBM_SERVER_ADDRESS" -UseSSL "$DBM_USE_SSL" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_FILE_PATH: << parameters.file_path >> DBM_PASSWORD: << parameters.password >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Get roles get-specific: description: | Update the Dev environment to a specific version or label for a project deployed by version, or to a specific package or label for a project deployed by task. The update environment operation is supported with or without a baseline to allow preservation of developer changes to the Dev environment. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name baseline_label_name: default: "" description: Baseline label name type: string create_scripts_only: default: "False" description: Ignore environment version mismatch enum: - "True" - "False" type: enum environment_name: description: DBmaestro environment name type: string label_name: default: "" description: Label name type: string package_name: default: "" description: Source package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash GetSpecific(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -GetSpecific -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'" ' if [[ -n ${DBM_PACKAGE_NAME} ]]; then CMDLINE=$CMDLINE'-PackageName "'$DBM_PACKAGE_NAME'" ' fi if [[ -n ${DBM_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-LabelName "'$DBM_LABEL_NAME'" ' fi if [[ -n ${DBM_BASELINE_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-BaselineLabelName "'$DBM_BASELINE_LABEL_NAME'" ' fi if [[ -n ${DBM_CREATE_DCRIPTS_ONLY} ]]; then CMDLINE=$CMDLINE'-CreateScriptsOnly "'$DBM_CREATE_DCRIPTS_ONLY'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then GetSpecific fi environment: DBM_BASELINE_LABEL_NAME: << parameters.baseline_label_name >> DBM_CREATE_DCRIPTS_ONLY: << parameters.create_scripts_only >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_LABEL_NAME: << parameters.baseline_label_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Get specific get-user-project-roles: description: | Retrieve all DBmaestro users and roles listed by project and save in a .csv file parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name file_path: description: Full .json file path to project. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -GetUserProjectRoles -FilePath "$DBM_FILE_PATH" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_FILE_PATH: << parameters.file_path >> DBM_PASSWORD: << parameters.password >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Get users-projects-roles mappings import-project: description: | Import a Project from a .json file parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name file_path: description: Full .json file path to project. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -ImportProject -FilePath "$DBM_FILE_PATH" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_FILE_PATH: << parameters.file_path >> DBM_PASSWORD: << parameters.password >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Import project package: description: | Queue a Package Job to the DBmaestro DevOps Platform - Creates a Package for an Environment - If Oracle scripts do not include the buffer flush directive ('/') and CancelJob has been issued, then a warning will be displayed next to the script unless suppressed and ignored through the -IgnoreScriptWarnings parameter. This warning CAN also be ignored deliberately through the DBmaestro DevOps Platform interface. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name file_path: description: Full .json file path to project. type: string ignore_script_warnings: default: "True" description: Ignore/don't ignore warnings in scripts enum: - "True" - "False" type: enum password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash Package(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -Package -ProjectName "'$DBM_PROJECT_NAME'" ' if [[ -n ${DBM_IGNORE_SCRIPT_WARNINGS} ]]; then CMDLINE=$CMDLINE'-IgnoreScriptWarnings "'$DBM_IGNORE_SCRIPT_WARNINGS'" ' fi if [[ -n ${DBM_FILE_PATH} ]]; then CMDLINE=$CMDLINE'-FilePath "'$DBM_FILE_PATH'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' echo "$CMDLINE" eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then Package fi environment: DBM_FILE_PATH: << parameters.file_path >> DBM_IGNORE_SCRIPT_WARNINGS: << parameters.ignore_script_warnings >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Package pre-check: description: | Perform a policy enforcement and pre-validation on a Package - If a PreRun Environment has been created during Project creation, then a simulation is run in the PreRun Environment as well. The PreRun Environment option is not available in a DB2 project. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name package_name: description: DBmaestro package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -PreCheck -ProjectName "$DBM_PROJECT_NAME" -PackageName "$DBM_PACKAGE_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UseSSL "$DBM_USE_SSL" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Pre-check pre-check-env: description: | Perform a policy enforcement and pre-validation on a Package in an Environment parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name environment_name: description: DBmaestro environment name type: string package_name: description: DBmaestro package name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -PreCheck -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -PackageName "$DBM_PACKAGE_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UseSSL "$DBM_USE_SSL" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Pre-check env project-mapping: description: | Queue a Project Mapping to the DBmaestro DevOps Platform - A Project Mapping must be constructed between two projects before the TransferUpPackage, TransferDownPackage or TransferPackage functions can be executed. The primary purpose of the mapping is to link schema differences between projects and enable constructing and managing a multi-project pipeline. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name keep_state: default: "False" description: Keep the state of the package enum: - "True" - "False" type: enum password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name. type: string schema_map: default: "" description: Link between source schema versus target schema. i.e. <'SchemaNameX1=SchemaNameY1,SchemaNameX2=SchemaNameY2...'> type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name target_project_name: description: Target project name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name transfer_opened_package: default: "False" description: Allow transferring open packages in TransferUpPackage and TransferDownPackage functions enum: - "True" - "False" type: enum use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash ProjectMapping(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -ProjectMapping -ProjectName "'$DBM_PROJECT_NAME'" -TargetProjectName "'$DBM_TARGET_PROJECT_NAME'" ' if [[ -n ${DBM_SCHEMA_MAP} ]]; then CMDLINE=$CMDLINE'-SchemaMap "'$DBM_SCHEMA_MAP'" ' fi if [[ -n ${DBM_TRANSFER_OPENED_PACKAGE} ]]; then CMDLINE=$CMDLINE'-TransferOpenedPackage "'$DBM_TRANSFER_OPENED_PACKAGE'" ' fi if [[ -n ${DBM_KEEP_STATE} ]]; then CMDLINE=$CMDLINE'-KeepState "'$DBM_KEEP_STATE'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' echo "$CMDLINE" eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then ProjectMapping fi environment: DBM_KEEP_STATE: << parameters.keep_state >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_SCHEMA_MAP: << parameters.schema_map >> DBM_TARGET_PROJECT_NAME: << parameters.target_project_name >> DBM_TRANSFER_OPENED_PACKAGE: << parameters.transfer_opened_package >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Project mapping restore-environment: description: | Restore an Environment from a saved Backup parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name backup_name: description: Backup name. type: string environment_name: description: DBmaestro environment name type: string force_set_version: default: "False" description: Ignore environment version mismatch enum: - "True" - "False" type: enum password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -RestoreEnvironment -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -BackupName "$DBM_BACKUP_NAME" -ForceSetVer "$DBM_FORCE_SET_VERSION" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_BACKUP_NAME: << parameters.backup_name >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_FORCE_SET_VERSION: << parameters.force_set_version >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Restore environment rollback: description: | Queue a Rollback Environment Job to Database Release Automation - If -CreateScriptsOnly is specified, then the Rollback Job is not queued. Instead, a Rollback Job package is created but not executed. The Rollback package will be available for execution in the Upgrade command. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name backup_behavior: default: "" description: <AlwaysCreateBackup> or <UsePolicy> or <SkipCreatingBackup> enum: - AlwaysCreateBackup - UsePolicy - SkipCreatingBackup - "" type: enum create_scripts_only: default: "False" description: Execute package enum: - "True" - "False" type: enum environment_name: description: DBmaestro environment name type: string label_name: default: "" description: Label name to be used or applied type: string package_name: default: "" description: Label name to be used or applied type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string restore_behavior: default: "" description: <AlwaysRestore> or <SkipRestore> enum: - AlwaysRestore - SkipRestore - "" type: enum server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash Rollback(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -Rollback -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'" ' if [[ -n ${DBM_PACKAGE_NAME} ]]; then CMDLINE=$CMDLINE'-PackageName "'$DBM_PACKAGE_NAME'" ' fi if [[ -n ${DBM_LABEL_NAME} ]]; then CMDLINE=$CMDLINE'-LabelName "'$DBM_LABEL_NAME'" ' fi if [[ -n ${DBM_CREATE_SCRIPTS_ONLY} ]]; then CMDLINE=$CMDLINE'-CreateScriptsOnly "'$DBM_CREATE_SCRIPTS_ONLY'" ' fi if [[ -n ${DBM_BACKUP_BEHAVIOR} ]]; then CMDLINE=$CMDLINE'-BackupBehavior "'$DBM_BACKUP_BEHAVIOR'" ' fi if [[ -n ${DBM_RESTORE_BEHAVIOR} ]]; then CMDLINE=$CMDLINE'-RestoreBehavior "'$DBM_RESTORE_BEHAVIOR'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' echo "$CMDLINE" eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then Rollback fi environment: DBM_BACKUP_BEHAVIOR: << parameters.backup_behavior >> DBM_CREATE_SCRIPTS_ONLY: << parameters.create_scripts_only >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_LABEL_NAME: << parameters.label_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_RESTORE_BEHAVIOR: << parameters.restore_behavior >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Rollback run-package-dev: description: | Perform Apply Label operation on an Environment A label is an aggregation of the latest check-in for all objects in Source control for a schema or database. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name environment_name: description: DBmaestro environment name type: string package_name: description: Package name. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string script_type: default: Upgrade description: <Upgrade> or <Downgrade> enum: - Upgrade - Downgrade type: enum server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -RunPackageDev -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -PackageName "$DBM_PACKAGE_NAME" -ScriptType "$DBM_SCRIPT_TYPE" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UseSSL "$DBM_USE_SSL" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_SCRIPT_TYPE: << parameters.script_type >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Run package on dev set-version: description: | Set the Environment Package version - Validates that the Environment matches the Release Source deployed Package Label for the requested Package. If valid, sets the Target Environment to that version. - If -Force is specified, the Target environment version is set as requested, even if the validation fails. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name environment_name: description: DBmaestro environment name type: string force: default: "False" description: Force the operation, ignoring usual operation block enum: - "True" - "False" type: enum package_name: description: Package name. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -SetVersion -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -PackageName "$DBM_PACKAGE_NAME" -Force "$DBM_FORCE" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UseSSL "$DBM_USE_SSL" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_FORCE: << parameters.force >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Set version sync-permissions: description: | Synchronize permissions for all Active Directory or LDAP users parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -SyncPermissions -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_PASSWORD: << parameters.password >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Sync permissions transfer-down-package: description: | Queue a DBmaestro DevOps Platform job to Transfer a Package from a Project to a downstream Target Project - A Project Mapping must have been created before the function can be executed. - The Target Project must be at a lower level in the Project Mapping hierarchy than the Source Package. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name source_package: description: Source package name type: string target_package: default: "" description: Target package name type: string target_project_name: description: Target project name type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name version_level: default: "" description: MAJOR or MINOR enum: - MAJOR - MINOR - "" type: enum steps: - run: command: |- #!/bin/bash TransferDownPackage(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -TransferDownPackage -ProjectName "'$DBM_PROJECT_NAME'" -TargetProjectName "'$DBM_TARGET_PROJECT_NAME'" -SourcePackage "'$DBM_SOURCE_PACKAGE'" ' if [[ -n ${DBM_TARGET_PACKAGE} ]]; then CMDLINE=$CMDLINE' -TargetPackage "'$DBM_TARGET_PACKAGE'" ' fi if [[ -n ${DBM_VERSION_LEVEL} ]]; then CMDLINE=$CMDLINE'-VersionLevel "'$DBM_VERSION_LEVEL'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then TransferDownPackage fi environment: DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_SOURCE_PACKAGE: << parameters.source_package >> DBM_TARGET_PACKAGE: << parameters.target_package >> DBM_TARGET_PROJECT_NAME: << parameters.target_project_name >> DBM_VERSION_LEVEL: << parameters.version_level >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Transfer down package transfer-package: description: | Queue a Project Transfer Job to the DBmaestro DevOps Platform - A Project Mapping must have been created before the TransferPackage function can be executed. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name source_package: description: Source package name type: string target_package: default: "" description: Target package name type: string target_project_name: description: Target project name type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name version_level: default: "" description: MAJOR or MINOR enum: - MAJOR - MINOR - "" type: enum steps: - run: command: |- #!/bin/bash TransferPackage(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -TransferPackage -ProjectName "'$DBM_PROJECT_NAME'" -TargetProjectName "'$DBM_TARGET_PROJECT_NAME'" -SourcePackage "'$DBM_SOURCE_PACKAGE'" ' if [[ -n ${DBM_TARGET_PACKAGE} ]]; then CMDLINE=$CMDLINE' -TargetPackage "'$DBM_TARGET_PACKAGE'" ' fi if [[ -n ${DBM_VERSION_LEVEL} ]]; then CMDLINE=$CMDLINE'-VersionLevel "'$DBM_VERSION_LEVEL'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then TransferPackage fi environment: DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_SOURCE_PACKAGE: << parameters.source_package >> DBM_TARGET_PACKAGE: << parameters.target_package >> DBM_TARGET_PROJECT_NAME: << parameters.target_project_name >> DBM_VERSION_LEVEL: << parameters.version_level >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Transfer package transfer-up-package: description: | Queue a DBmaestro DevOps Platform job to Promote a Package from a Project to an upstream Target Project - A Project Mapping must have been created before the function can be executed. - The Target Project must be at a higher level in the Project Mapping hierarchy than the Source Package. parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name source_package: description: Source package name type: string target_package: default: "" description: Target package name type: string target_project_name: description: Target project name type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name version_level: default: "" description: MAJOR or MINOR enum: - MAJOR - MINOR - "" type: enum steps: - run: command: |- #!/bin/bash TransferUpPackage(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -TransferUpPackage -ProjectName "'$DBM_PROJECT_NAME'" -TargetProjectName "'$DBM_TARGET_PROJECT_NAME'" -SourcePackage "'$DBM_SOURCE_PACKAGE'" ' if [[ -n ${DBM_TARGET_PACKAGE} ]]; then CMDLINE=$CMDLINE' -TargetPackage "'$DBM_TARGET_PACKAGE'" ' fi if [[ -n ${DBM_VERSION_LEVEL} ]]; then CMDLINE=$CMDLINE'-VersionLevel "'$DBM_VERSION_LEVEL'" ' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then TransferUpPackage fi environment: DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_SOURCE_PACKAGE: << parameters.source_package >> DBM_TARGET_PACKAGE: << parameters.target_package >> DBM_TARGET_PROJECT_NAME: << parameters.target_project_name >> DBM_VERSION_LEVEL: << parameters.version_level >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Transfer up package update-project: description: | Update a Project from a .json file parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name file_path: description: Full .json file path to project. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -UpdateProject -FilePath "$DBM_FILE_PATH" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_FILE_PATH: << parameters.file_path >> DBM_PASSWORD: << parameters.password >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Update project update-tag-type: description: | Add a Tag Type to the DBmaestro DevOps Platform - A Tag Type must be created before a Tag can be assigned to an Object. - A Tag Type is a text descriptor for a Tag. For example, "custom", "task". parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name new_tag_type_name: description: New tag type name. type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tag_type_name: description: DBmaestro tag type name. type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -UpdateTagTypeName -TagTypeName "$DBM_TAG_TYPE_NAME" -NewTagTypeName "$DBM_NEW_TAG_TYPE_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_NEW_TAG_TYPE_NAME: << parameters.new_tag_type_name >> DBM_PASSWORD: << parameters.password >> DBM_TAG_TYPE_NAME: << parameters.tag_type_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Update tag type upgrade: description: | Queue an Upgrade Environment Job to the DBmaestro DevOps Platform parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name backup_behavior: default: "" description: <AlwaysCreateBackup> or <UsePolicy> or <SkipCreatingBackup> enum: - AlwaysCreateBackup - UsePolicy - SkipCreatingBackup - "" type: enum environment_name: description: DBmaestro environment name type: string package_name: description: Label name to be used or applied type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string restore_behavior: default: "" description: <AlwaysRestore> or <SkipRestore> enum: - AlwaysRestore - SkipRestore - "" type: enum server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tag_name: default: "" description: Tag name type: string tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: |- #!/bin/bash Upgrade(){ if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi CMDLINE='java -jar "'$DBM_TOOL_PATH'/DBmaestroAgent.jar" -Upgrade -ProjectName "'$DBM_PROJECT_NAME'" -EnvName "'$DBM_ENVIRONMENT_NAME'" -PackageName "'$DBM_PACKAGE_NAME'" ' if [[ -n ${DBM_TAG_NAME} ]]; then CMDLINE=$CMDLINE'-TagName "'$DBM_TAG_NAME' "' fi if [[ -n ${DBM_BACKUP_BEHAVIOR} ]]; then CMDLINE=$CMDLINE'-BackupBehavior "'$DBM_BACKUP_BEHAVIOR' "' fi if [[ -n ${DBM_RESTORE_BEHAVIOR} ]]; then CMDLINE=$CMDLINE'-RestoreBehavior "'$DBM_RESTORE_BEHAVIOR' "' fi CMDLINE=$CMDLINE' -Server "'$DBM_SERVER_ADDRESS'" -AuthType "'$DBM_AUTH_TYPE'" -UserName "'$DBM_USERNAME'" -Password "'$DBM_PWD'"' eval "$CMDLINE" } # Will not run if sourced for bats-core tests. # View src/tests for more information. ORB_TEST_ENV="bats-core" if [ "${0#*$ORB_TEST_ENV}" == "$0" ]; then Upgrade fi environment: DBM_BACKUP_BEHAVIOR: << parameters.backup_behavior >> DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> DBM_RESTORE_BEHAVIOR: << parameters.restore_behavior >> DBM_TAG_NAME: << parameters.tag_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Upgrade validate: description: | Validate an Environment with Database Release Automation Checks for environment drift from specified version parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name environment_name: description: DBmaestro environment name type: string package_name: default: '@currentversion' description: DBmaestro package name. By default runs validation against current version type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -Validate -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -PackageName "$DBM_PACKAGE_NAME" -Server "$DBM_SERVER_ADDRESS" -UseSSL "$DBM_USE_SSL" -AuthType "$DBM_AUTH_TYPE" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_PACKAGE_NAME: << parameters.package_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: Validate environment view-labels: description: | Print out a list of labels for an Environment parameters: auth_type: default: DBMAESTRO_AUTH_TYPE description: DBmaestro auth type type: env_var_name environment_name: description: DBmaestro environment name type: string password: default: DBMAESTRO_PASSWORD description: DBmaestro password type: env_var_name project_name: description: DBmaestro project name type: string server_address: default: DBMAESTRO_SERVER_ADDRESS description: DBmaestro server address type: env_var_name tool_path: default: DBMAESTRO_TOOL_PATH description: Path where the DBmaestroAgent.jar is located type: env_var_name use_ssl: default: DBMAESTRO_USE_SSL description: Use or don't use SSL/https protocol to connect to the DBmaestro agent. Default is n. type: env_var_name username: default: DBMAESTRO_USERNAME description: DBmaestro username type: env_var_name steps: - run: command: | if [ -z "${DBM_TOOL_PATH:=${!PDBM_TOOL_PATH:-'tools/dbmaestro'}}" ]; then echo "DBmaestro tool path is not set"&&exit 1; fi if [ -z "${DBM_SERVER_ADDRESS:=${!PDBM_SERVER_ADDRESS}}" ]; then echo "DBmaestro server address is not set"&&exit 1; fi if [ -z "${DBM_USE_SSL:=${!PDBM_USE_SSL:-n}}" ]; then echo "DBmaestro SSL usage is not set"&&exit 1; fi if [ -z "${DBM_AUTH_TYPE:=${!PDBM_AUTH_TYPE:-DBmaestroAccount}}" ]; then echo "DBmaestro auth type is not set"&&exit 1; fi if [ -z "${DBM_USERNAME:=${!PDBM_USERNAME}}" ]; then echo "DBmaestro username is not set"&&exit 1; fi if [ -z "${DBM_PWD:=${!DBM_PASSWORD}}" ]; then echo "DBMAESTRO_PASSWORD variable is not set"&&exit 1; fi java -jar "$DBM_TOOL_PATH/DBmaestroAgent.jar" -ViewLabels -ProjectName "$DBM_PROJECT_NAME" -EnvName "$DBM_ENVIRONMENT_NAME" -Server "$DBM_SERVER_ADDRESS" -AuthType "$DBM_AUTH_TYPE" -UseSSL "$DBM_USE_SSL" -UserName "$DBM_USERNAME" -Password "$DBM_PWD" environment: DBM_ENVIRONMENT_NAME: << parameters.environment_name >> DBM_PASSWORD: << parameters.password >> DBM_PROJECT_NAME: << parameters.project_name >> PDBM_AUTH_TYPE: << parameters.auth_type >> PDBM_SERVER_ADDRESS: << parameters.server_address >> PDBM_TOOL_PATH: << parameters.tool_path >> PDBM_USE_SSL: << parameters.use_ssl >> PDBM_USERNAME: << parameters.username >> name: View labels examples: build-run: description: | This job will create project package by Buid, deploy it to the Release source and QA environments Then - transfer this package to "Release" project and deployed to Release Source and Production Job description 1. Package is created using build command for environment Dev_Env_1 for project "Development" 2. Release source is being updated to the latest version using update command at project "Development" 3. Same package is being deployed to the QA environment at project "Development" 4. Package is being transferred to the project "Release" 5. Release source at project "Release" is being updated to the latest version using update command 6. Finally, package is being deployed to the Production environment (Prod_Env_1) of "Release" project usage: version: "2.1" orbs: dop: dbmaestro/devops-automation@1.0.0 jobs: dbm-deploy: docker: - image: cimg/openjdk:16.0.2 environment: DBMAESTRO_AUTH_TYPE: DBmaestroAccount DBMAESTRO_SERVER_ADDRESS: dbm.automation.host:8017 DBMAESTRO_USERNAME: test@dbmaestro.com steps: - checkout - dop/download-automation-jar - dop/build: environment_name: Dev_Env_1 project_name: Development version_level: MAJOR - dop/upgrade: environment_name: Release Source package_name: '@latestversion' project_name: Development - dop/upgrade: environment_name: QA_Env_1 package_name: '@latestversion' project_name: Development - dop/transfer-up-package: project_name: Development source_package: '@latestversion' target_project_name: Release version_level: MINOR - dop/upgrade: environment_name: Release Source package_name: '@latestversion' project_name: Release - dop/upgrade: environment_name: Prod_Env_1 package_name: '@latestversion' project_name: Release workflows: test-run: jobs: - dbm-deploy package-run: description: | This job will create project package from user created scripts and a package manifest using the Package command, and then deploy it to the Release source. The package manifest is a .json file named Package.json consisting of a header section and an array of script sections in the order in which the scripts should be executed when an environment is upgraded or downgraded. The upgrade and downgrade scripts are stored in the Upgrade and Downgrade directories respectively. These two directories are subdirectories of another directory. Details are specified in https://dbmaestro.atlassian.net/wiki/spaces/DBm20Docs/pages/1173331919/Generating+Project+Packages+by+Automation Job description 1. Package manifest is created using create-manifest command 2. Package folder is being zipped 3. New package is being imported to DBmaestro using package command 4. Package is being pre-checked using pre-check command 5. Release source is being updated using update command usage: version: "2.1" orbs: dop: dbmaestro/devops-automation@1.0.0 jobs: dbm-deploy: docker: - image: cimg/openjdk:16.0.2 environment: DBMAESTRO_AUTH_TYPE: DBmaestroAccount DBMAESTRO_SERVER_ADDRESS: dbm.automation.host:8017 DBMAESTRO_USERNAME: test@dbmaestro.com steps: - checkout - dop/download-automation-jar - dop/create-manifest-file: path_to_scripts_folder: V3 - run: command: cd V3&&zip -r ../V3.zip *&&cd .. name: Zip the package - dop/package: file_path: V3.zip project_name: DEMO - dop/pre-check: package_name: V3 project_name: DEMO - dop/upgrade: environment_name: Release Source package_name: V3 project_name: DEMO workflows: test-run: jobs: - dbm-deploy
Developer Updates
Get tips to optimize your builds
Or join our research panel and give feedback
By submitting this form, you are agreeing to ourTerms of UseandPrivacy Policy.