Unsupported content

 

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Working with the eZDeploy utility

The eZDeploy utility is a command-line-based interface utility that is used to export and import BMC Cloud Lifecycle Management service blueprints. With this utility, you can import the downloaded content from BMC Communities and the appropriate artifacts in BMC Cloud Lifecycle Management (service blueprints with option and option choices and service catalog), BMC Server Automation (BL packages), and BMC Atrium Orchestrator (Atrium Orchestrator workflows) to create a service offering in BMC Cloud Lifecycle Management. You can also use this utility to share your service blueprints with the rest of the BMC Communities and allow them to use your cloud deployment's best practices.

Note

The BMC eZDeploy toolkit is validated with the .eZ packages of BMC Zipkits for CLM uploaded in BMC Communities. Before using this toolkit for importing or exporting other service blueprint and service catalog components please refer to the Limitations of the eZDeploy utility.

The following sections provide an overview of the eZDeploy utility:

The following topics provide information and instructions for configuring and using the eZDeploy utility:

TopicDetails

This topic provides details on how to download the eZDeploy utility for your Linux or Microsoft Windows environment.

Note: You do not need to install the utility. You just have to untar/unzip the downloaded Linux/Microsoft Windows eZDeploy utility.

Configuring environment for the eZDeploy utility

This topic provides the prerequisites to be completed for configuring your environment for using the eZDeploy utility. It also details the procedure for managing eZDeploy profiles.

Using the eZDeploy 1.0.00 utility

This topic provides an overview on how you can use eZDeploy version 1.0.00 utility to export or import a service blueprint or service catalog.

Using the eZDeploy 1.1.00 utility 

This topic provides an overview on how you can use eZDeploy version 1.1.00 utility to export or import a service blueprint or service catalog. You can also validate an exported or imported service blueprint or service catalog. For detailed steps see:

Version 1.0.00 of eZDeploy utility

This section provides information about version 1.0.00 of the eZDeploy utility.

Product compatibility

The eZDeploy 1.0.00 release integrates with BMC Cloud Lifecycle Management 3.1 only.

Key features

  • Ability to export and import service blueprints along with all BMC Server Automation artifacts, including system packages, software packages, and NSH scripts.
    • Service blueprints are exported and imported along with all BMC Server Automation artifacts (system packages, software packages, and NSH scripts). Prior to the eZDeploy utility, the service blueprint JSON file and BMC Server Automation artifacts were exported and imported manually.
    • BMC Atrium Orchestrator workflows, if any, can also be exported and imported. Prior to the eZDeploy utility, BMC Atrium Orchestrator workflows were imported and exported manually from the BMC Atrium Orchestrator repository.
    • Product Catalog entries from the Definitive Media Library are linked to the service blueprint during import. Prior to the eZDeploy utility, because BMC Server Automation artifacts could not be imported, no Product Catalog entries were created during import.
  • Ability to create Product Catalog entries in the Definitive Media Library during import. 
  • Ability to export and import service blueprint option choices
  • Ability to export and import service catalog

The following table lists the export and import functionality of the eZDeploy utility pertaining to the service blueprint component.

BMC Cloud Lifecycle Management componentExportImport
Functional model(tick)(tick)
All deployment models(tick)(tick)
Tags(tick)(tick)
Post-deployment actions(error)(error)
Operations (BMC Atrium Orchestrator Workflow/NSH scripts) (tick)(tick)

Options and option choices

Note: Options and option choices are imported however they need to be associated with a service offering manually after import.

(tick)(tick)
Service Offering(tick)(tick)
Requestable Definitions(error)(error)

Post-deployment actions

Note: Post-deployment actions need to be created manually after import of service catalog.

(error)(error)
BMC Server Automation system packages (tick)(tick)
BMC Server Automation software packages (tick)(tick)

See Using the eZDeploy 1.0.00 utility for details.

Note

Although BMC Server Automation Virtual Guest Packages are not exported from the BMC Cloud Lifecycle Management system, eZDeploy exports the necessary metadata that is needed for import operations.

Version 1.1.00 of eZDeploy utility

This section provides information about version 1.1.00 of the eZDeploy utility.

Product compatibility

The eZDeploy 1.1.00 release integrates with BMC Cloud Lifecycle Management 3.1 only.

Key features

In addition to the eZDeploy 1.0.00 features, eZDeploy 1.1.00 utility provides the following benefits:

  • Importing the eZDeploy package in both interactive and non-interactive mode.
  • Specifying a single location for the softwares to be used during import.
  • Applying a custom prefix during import.
  • Exporting service catalog as an eZDeploy package.

See Using the eZDeploy 1.1.00 utility for details.

Version 1.1.1 of eZDeploy utility

In addition to the eZDeploy 1.1.00 features, eZDeploy 1.1.1 utility provides the fixes for known issues in eZDeploy 1.1. See Known and corrected issues for details of the issue fixed.

See Using the eZDeploy 1.1.00 utility for details on using the eZDeploy 1.1.1 utility for BMC Cloud Lifecycle Management 3.1.

Note

It is recommended that you download and use the latest version of eZDeploy for BMC Cloud Lifecycle Management 3.1 (eZDeploy-1.1.1-Windows.zip or eZDeploy-1.1.1-Linux.tar.gz) from BMC Communities.

Limitations of the eZDeploy utility

  • Only single session of eZDeploy can be active from a single server.
  • If a custom prefix is not provided by the user, BMC Cloud Lifecycle Management artifacts are imported with a default prefix of eZ-
  • Request definition must be created manually after import.
  • Post-deployment actions must be created manually after import of service catalog.
  • Options must be associated with a service offering manually after import of service catalog.
  • The option included in the Service being exported must have at least one option choice.
  • Incase blueprint, option, service catalog is already present in the target system, new artifacts are created with a numbered suffix when importing another service blueprint or service catalog.
  • The source and the target BMC Cloud Lifecycle Management environment for importing eZ package should be of the same BMC Cloud Lifecycle Management version.
  • The VGP creation process uses the template reference and licenses, but not other properties, such as timezone. You must update these properties manually after you create the VGP.
  • Entitlement package must be associated manually after importing the service catalog.
  • If custom properties are defined for BMC Server Automation packages, these packages must be imported manually before running eZDeploy.
  • In BL Packages, the deploy job name and PRODUCT_NAME must be same for eZDeploy to export packages.
  • Ensure that you provide the correct BMC Atrium Orchestrator module version because eZDeploy does not validate this version. If the module that you specify does not exist, a file with a module name is created but does not have any content.
  • eZDeploy creates request definitions type as Compute only irrespective of the original request definition type of the service imported. For example: OpenStack service has the request definition type as OpenStack, but after importing the OpenStack service the request definition type is set to Compute by eZDeploy. You must then manually set the correct request definition type for the imported service.
  • eZDeploy supports importing a single service blueprint in a service catalog and does not support multiple service offerings with different service blueprints (for example: one has an AWS blueprint and another has an Azure service blueprint) in a service catalog.

Related topics

Was this page helpful? Yes No Submitting... Thank you

Comments