Deploy

Deploying to webMethods Cloud Container

Cloud deployment is the process of deploying user-created packages and configurations that reside within on-premise runtimes or repositories to webMethods Cloud Container. Using Software AG Designer you can seamlessly deploy your on-premise Integration Server packages and configuration assets to solutions present on Cloud Container.

Note: In the Cloud Container context, configuration assets are limited to Integration Server and Universal Messaging configurations.

Software AG Designer allows you to deploy the Integration Server packages or configuration assets that you have created, verified, and tested on on-premise Integration Server or Universal Messaging to Cloud Container. When you initiate the deployment from Software AG Designer, Integration Server packages and configuration assets are built from Integration Server and Command Central respectively, and are published to an asset repository present in Software AG Designer.

After performing variable substitutions to make the on-premises configuration data compatible for Cloud Container, you can publish the packages and configurations from the asset repository to a remote repository provisioned for the tenant on Cloud Container.

Platform Manager plug-ins for Integration Server and Universal Messaging continuously monitor the remote repository on Cloud Container. When a fresh deployment is detected, Platform Manager plug-ins deploy the Integration Server packages and configuration assets to respective runtime instances on webMethods Cloud Container.

Note: Deploying assets to Cloud Container using Software AG Designer eliminates the previous need to install or invoke webMethods Deployer on cloud for the purpose of Cloud Container.

The following figure provides a high-level basic overview of the process involved in deploying on-premises Integration Server packages and configuration assets to Cloud Container.

Installation Information

Install Software AG Command Central using the Command Central bootstrapper or provision a Command Central container from the Docker Store. For instructions, see the Command Central documentation.

Install the following products into a different directory or on a different machine, using the Software AG Installer or Software AG Command Central:

If you want to use an external RDBMS for webMethods Integration Server, install webMethods Database Component Configurator on any machine on the same network as your database server, create the database components for webMethods Integration Server, and then connect webMethods Integration Server to the database components.

For detailed instructions, see the following documents:

Cloud Container Approaches

Choose the following approaches to publish user-created packages and configurations to a solution created in webMethods Cloud Container. See the Creating Solution section in the Cloud Container help for information on how to create a solution in Cloud Container.

Using Software AG Designer

Connecting to webMethods Cloud Container

Using Designer you can deploy your on-premises Integration Server packages and configuration assets to Cloud Container. Before deploying the packages and configuration assets, you must configure a connection to Cloud Container.

Before you configure a connection to Cloud Container, ensure that the following criteria are met:

Configuring a Connection to Cloud Container

You need to provide specific information in Designer for initiating a connection to Cloud Container. Designer saves this information in a connection configuration. You can add, edit, and update connection configurations in Designer.

Adding a Connection Configuration

Using Designer you can add connections to different instances of Cloud Container.

To add a connection configuration for Cloud Container

  1. In Designer, select Window > Preferences.

  2. In the preferences navigation tree, select Software AG > webMethods Cloud.

  3. Click Add.

  4. In the Add connection configuration dialog box, enter the following information:

    Field Description
    Name The name to use for the Cloud Container connection configuration. Note: The name cannot contain control characters, special characters, and characters outside of the basic ASCII character set, such as multi-byte characters.
    URL URL of the webMethods Cloud host to which Designer is to connect. For example, https://mysubdomain.container.webmethodscloud.com
    User The user name for an account on Cloud Container.
    Password The password for the specified User.
    Save password (in the Eclipse secure storage) Indicates whether the password for the specified user account should be saved in Eclipse secure storage. Cloud Container uses this password from the Eclipse secure storage whenever user authorization is required. If you want to save the password in Eclipse secure storage, select this check box. If you decide not to save the password in Eclipse secure storage, you must specify your password each time your user authorization is required for connecting to Cloud Container.
  5. To verify whether Cloud Container can be accessed by using the specified information, click Test.

  6. To store the connection configuration details, click OK. A connection configuration is added to the Connections page with the specified details. The first connection configuration that you create is automatically marked as default. This default configuration is indicated with a check mark on the Connections page. Designer always uses the default connection configuration for Cloud Container. If there are multiple connections configured, you can select the connection that you want to make it as default.

Editing a Connection Configuration

You can edit a connection configuration for webMethods Cloud if there are any changes in the configuration values.

To edit a connection configuration for webMethods Cloud

  1. In Designer, select Window > Preferences.

  2. In the preferences navigation tree, select Software AG > webMethods Cloud.

  3. Click Edit.

  4. Enter new values in the connection configuration fields you want to change.

  5. In the Edit Connection Configuration dialog box, click OK.

  6. In the Connections page, click OK.

Removing a Connection Configuration

You can remove connection configurations for webMethods Cloud one at a time from the Connections page.

To remove a connection configuration for webMethods Cloud

  1. In Designer, select Window > Preferences

  2. In the preferences navigation tree, select Software AG > webMethods Cloud.

  3. Select the webMethods Cloud connection configuration you want to remove.

  4. Click Remove. Designer prompts you to confirm that you want to remove the selected connection configuration.

  5. Click OK.

Deployable Assets and Configurations

Deployable assets and configurations for webMethods Integration Server

Configuration/Asset Type Asset/Configuration
ACLs Configuration
Groups Configuration
Consumer Web service endpoint alias Configuration
Extended Settings * Configuration
Global Variables Configuration
JMS aliases Configuration
JNDI aliases Configuration
Keystores Configuration
Provider Web service endpoint alias Configuration
Resources Settings * Configuration
SMTP settings * Configuration
Truststores Configuration
Users Configuration
webMethods messaging Configuration
Flow Service Asset
Java Service Asset
Map Service Asset
OData Service Asset
Adapter Service Asset
.NET Service Asset
C Service Asset
Adapter Notification Asset
Document Type Asset
Flat File Dictionary Asset
Flat File Schema Asset
JMS Trigger Asset
REST API Descriptor Asset
REST Resource Asset
Schema Asset
Specification Asset
Web Service Descriptor Asset
webMethods Messaging Trigger Asset
XML Document Type Asset
XSLT Service Asset
JSON Document Type Asset
* Restart Required

JSON Document Type Properties

You can view the JSON document type properties from the JSON schema section of the properties view. When you deploy a JSON document type from Integration Server, the constraints applied to the elements and attributes are preserved as part of the validation under the JSON schema section.

Property Description
Schema Displays the version of the JSON Schema standard to which the schema conforms.
ID Displays a URI for the schema, and the base URI that other URI references within the schema are resolved against.
Title A title for a JSON document type or field represented by the JSON schema.
Description Description of a JSON document type or field.
Read only This property corresponds to the readOnly JSON schema annotation. It indicates if the value (of the selected field or document) is managed by Integration Server.
Write only This property corresponds to the writeOnly JSON schema annotation. It determines if the selected field or document is retrieved from Integration Server.
Validations Specifies the requirements for successful validation of JSON schema. Validation keywords differ based on the data type used in the JSON schema.

Deployable assets and configurations for webMethods CloudStreams

Note: You cannot deploy the webMethods CloudStreams runtime assets such as database, OAuth token, streaming, provider, subscriber and large data configuration that you have created, verified, and tested to webMethods Cloud Container.

Configuration/Asset Type Asset/Configuration
CloudStreams Connector Services Asset
CloudStreams Connection Asset
* Restart Required

Deployable configurations for Software AG Universal Messaging

Configuration Type Asset/Configuration
Channels Transient
Simple
Reliable
Persistent
Mixed
Off-Heap
Paged
JNDI Connection Factories Connection Factory>Shared Durable Type
TopicConnection Factory>Shared Durable Type
Queue Connection Factory
XA Connection Factory
JNDI Destinations Topic
Queue
Queues
Simple
Reliable
Persistent
Mixed
Off-Heap
Paged
* Restart Required

Deploying Packages and Configuration Assets to Cloud Container

Using Software AG Designer, you can deploy Integration Server packages and configuration assets to Cloud Container.

Before deploying packages and configuration assets to Cloud Container, ensure the following:

  1. In the Package Navigator view, select the Integration Server package that you want to deploy to Cloud Container.

  2. Right-click the package and click Deploy to Cloud.

  3. In the Publish Assets to Cloud dialog box, select the package to deploy. You can select multiple packages. If you want to publish the configuration assets along with the selected Integration Server package, select Include runtime configurations, click Next, and go to step 4. Otherwise, click Next and go to step 5. Designer fetches the configuration data from Command Central.

  4. In the Confirm selected configurations dialog box, select the configuration that you want to deploy and clickNext.

  5. In the Integration Server package variable substitution dialog box, select the package and edit the value of the property that you want to modify before deploying to cloud. Click Next.

  6. In the Select Cloud Solution dialog box, select the solution on webMethods Cloud Container to which you want to deploy the assets and click Finish. Designer deploys the assets and configurations to a remote repository provisioned for the tenant on webMethods Cloud Container.

Checking the Deployment Status

After you deploy the assets to the Cloud Container, you can check the deployment status.

To check the deployment status

  1. In the Service Development perspective of Software AG Designer, select Window > Show View > Other.

  2. In the Show View dialog box, select Software AG Service Development>Deployment Status.

  3. Click Open. Software AG Designer displays the Deployment Status view with the current deployment status of the assets.

Note:

  • To reload the deployment status, click .
  • To remove a specific deployment status, select the asset under the Asset Name and click .
  • Debugging Services in webMethods Cloud Container

    Cloud Container allows you to connect your on-premise Software AG Designer to the Integration Server(s) running in a container as part of solution landscape.

    How do I debug Integration Server(s) Services for Cloud Container?

    You can debug Integration Server services using Cloud Service Development perspective in Designer. The experience is similar to the way you debug services using Designer.

    To debug the services in Cloud Container

    1. Open the Cloud Service Development perspective in Designer and configure a connection to Cloud Container.

      The default configuration is indicated with a check mark on the connections page. Designer always uses the default connection configuration for Cloud Container. If there are multiple connections configured, you can select the connection that you want to make it as default.

    2. View the tenant details in the Cloud Explorer view and connect to the Cloud Container server. The Cloud Explorer view displays the contents of the Cloud Container to which Designer is currently connected. Click Connect to Server to log in. Designer will list all active solutions available for that selected tenant. Further, the solution displays all the packages available for the selected Integration Server in Cloud Container.

      The following image displays a side-by-side comparison of two services.

    3. Execute the services in Cloud Container using Designer. In Designer you can select services and execute them by clicking Run > Debug As > Debug Configurations.

    Deploying Adapter for JDBC Assets

    To deploy Adapter for JDBC related driver jars and TypeMapping configurations to webMethods Cloud Container solutions, you can select the core JDBC adapter package WmJDBCAdapter from Software AG Designer, which will deploy the contents only from <webM\_Home\>\\Integration Server\\instances\\<instance\_Name\>\\packages\\WmJDBCAdapter\\code\\jars and <webM\_Home\>\\Integration Server\\instances\\<instance\_Name\>\\packages\\WmJDBCAdapter\\config folders.

    To enable the assets such as Adapter Connections and Polling Notifications on Cloud Container, ensure that you set the State After Deployment value to enable during deployment from Software AG Designer. The state of the assets such as Adapter Connections and Polling Notifications must be disabled from on-premises before deploying to Cloud Container to ensure that the on-premises Integration Server records are not processed. To deploy Adapter for JDBC and asset packages to Cloud Container, see Deploying Packages and Configuration Assets to Cloud Container.

    Notes:

    Limitations

    Deploying Adapter for webSphereMQ Assets

    To deploy webMethods MQ Adapter related driver jars to webMethods Cloud Container, you can select the core MQ adapter package WmMQAdapter from Software AG Designer, which will deploy the contents only from <webM\_Home\>\\Integration Server\\instances\\<instance\_Name\>\\packages\\WmMQAdapter\\code\\jars folders.

    To enable the assets such as Adapter Connections, Listeners and Listener Notifications on Cloud Container, ensure that you set the State After Deployment value to enable during deployment from Software AG Designer. The state of the assets must be disabled in on-premises before deploying to Cloud Container to ensure that the on-premises Integration Server messages from IBM WebSphereMQ server are not processed. To deploy webMethods MQ Adapter and asset packages to Cloud Container, see Deploying Packages and Configuration Assets to Cloud Container.

    Notes:

    Limitations:

    Two way SSL connections are not supported.

    Asset Repository

    Asset Repository is a binary repository that provides components for managing user assets . Asset Repository enables the process of repository-based deployment, in which runtime servers pull assets from a repository. You can build Integration Server packages and configuration assets and add to the repository making the assets available for deployment to Cloud Container. Asset Repository is installed along with Software AG Designer using the Software AG Installer.

    The Asset Repository view in Software AG Designer allows you to build, deploy, refresh, remove, or retract the assets.

    Opening the Asset Repository View

    To open the Asset Repository view

    1. In the Service Development perspective of Designer, select Window > Show View > Other.

    2. In the Show View dialog box, select Software AG Service Development>Asset Repository.

    3. Click OK.

    Building Packages and Assets in Asset Repository View

    If the Asset Repository view does not already display the list of Integration Server packages and configuration assets, you can build them.

    To build packages and configuration assets

    1. In Asset Repository view, click the View Menu button .

    2. Select Build. The Asset Repository view displays all the newly created Integration Server packages and configuration assets.

    Deploying Packages and Assets from Asset Repository View

    You can deploy Integration Server package or configuration assets using the Asset Repository view.

    To deploy packages and configuration assets from Asset Repository View

    1. In Asset Repository view, select the Integration Server package or configuration assets that you want to deploy to webMethods Cloud Container.

    2. Right-click the package and click Deploy to Cloud.

    3. In the Publish Assets to Cloud dialog box, select the package to deploy. If you want to publish the configuration assets along with the selected Integration Server package, select Include runtime configurations, click Next, and go to step 4. Otherwise, click Next and go to step 5.

    4. In the Confirm selected configurations dialog box, select the configuration that you want to deploy and clickNext. Designer fetches the configuration data from Software AG Command Central.

    5. In the Integration Server package variable substitution dialog box, select the package and edit the value of the property that you want modify before deploying to cloud. Click Next.

    6. In the Select Cloud Solution dialog box, select the solution on webMethods Cloud Container to which you want to deploy the assets and click Finish. Software AG Designer deploys the assets and configurations to a remote repository provisioned for the tenant on webMethods Cloud Container.

    Retracting Packages and Assets

    Using Designer you can retract Integration Server packages, configuration assets, or both from webMethods Cloud Container.

    To retract packages and configuration assets

    1. In Asset Repository view, select the Integration Server package or configuration assets that you want to retract.

    2. Right-click and select Retract. Designer retracts the packages and configuration assets from webMethods Cloud Container.

    Deleting Packages and Assets

    You can delete Integration Server packages or configuration assets from the Asset Repository view and from webMethods Cloud Container. You can do this to remove packages and configuration assets with incorrect variable substitution or remove old versions of them from webMethods Cloud Container.

    To delete packages and configuration assets

    1. In Asset Repository view, select the Integration Server package or configuration assets that you want to delete.

    2. Right-click and select Remove. Software AG Designer removes the Integration Server packages or configuration assets from the Asset Repository view and webMethods Cloud Container.

    Deploying Command Central Assets to webMethods Cloud

    Command Central can export configuration properties for Software AG run-time components as YAML templates. Configuration properties are exported as Command Central composite assets using Software AG Designer, stored in the Landscape Asset Repository, and deployed to product instances, running on webMethods Cloud Container.

    For information about the Software AG products you need to install for Cloud Container, see the Deploying to webMethods Cloud Container section.

    To create Command Central assets and deploy them to webMethods Cloud Container, in Designer:

    1. Connect to Command Central.

    2. Select and export the configurations to be deployed.

    3. Edit the YAML configurations.

    4. Deploy the assets to webMethods Cloud Container.

    For more information about deploying assets, see the Deploying to webMethods Cloud Container section.

    Using Landscape Navigator to View Runtime Configurations

    Using Landscape Navigator view, you can connect to Command Central and view the list of registered installations and runtime instances. For more information about connecting to Command Central, see the Creating Command Central Definitions section.

    What Does the Landscape Navigator View Contain?

    You use Landscape Navigator view and Configuration Browser views to display the list of installations that are registered in Command Central. The available run-time instances are listed in the view for each installation and these available run-time instances are available for deploy to webMethods Cloud Container.

    Landscape Navigator view provides an option to connect to a local or remote Command Central server. To view the contents of installations that are registered in Command Central, you must configure a connection to Command Central and then establish a connection.

    You can find Landscape Navigator and Configuration Browser views under the Windows > Show View > Other > Software AG Command Central.

    Command Central definitions create the connection between Designer and Command Central. The definition for a server contains the connection information needed to establish a connection with the Command Central server.

    Creating a Command Central Definition

    1. On the Landscape Navigator toolbar, click Add Command Central connection icon..

    2. In the New Command Central Connection dialog box, enter the details for connecting to the Command Central server as described in following table:

      Field Description
      Connection name The connection name.
      Command Central Location Choose one of the following options to specify the location:
      - URL: The URL for Command Central connection. For example, https://[Command_Central_host]:[Command_Central_port]/cce
      - Installation Directory: The local Software AG product installation directory where Command Central is installed.
    3. Under Authentication, enter the details as described in the following table:

      Field Description
      Username Username to use for authentication on the Command Central.
      Password The password to use for authentication on the Command Central.
      Connection timeout (s): The maximum seconds Designer waits for response from Command Central.
    4. Click Save password. Designer stores the password in Eclipse secure storage location.

    5. Click Test Connection to ping the Command Central server and to verify that the connection is working.

    6. Click Finish. Designer refreshes the Landscape Navigator view and displays the new connection.

    Editing a Command Central Definition

    If there are changes in the associated Command Central server that require you to update the server definition, edit the Command Central connection properties. For example, to add or edit the username and password, you must edit the Command Central Connection page to reflect that change.

    To edit a Command Central definition

    1. Open the Landscape Navigator view.

    2. Select the connection you want to edit.

    3. Right-click the connection and select Edit Command Central Connection.

    4. Edit the connection properties as needed.

    Deleting a Command Central Definition

    To delete a Command Central definition

    1. Open the Landscape Navigator view.

    2. Select the connection that you want to delete.

    3. Right-click the connection and select Delete Command Central Connection.

    4. Click Yes to confirm the deletion from the view.

    Designer offers a detailed view of run-time specific configuration in Configuration Browser view. Designer retrieves information about a specific run-time component selected in Landscape Navigator.

    The following table describes the runtime component information that is displayed in the Configuration Browser view.

    Name Description
    Name Display name of the configuration instance.
    Id Id of the runtime instance.
    Product Product to which the runtime instance belongs.
    Category Configuration category to which the runtime instance belongs.
    Deployable Whether or not the asset is deployable to webMethods Cloud Container.
    Description Description of the configuration instance.

    Browsing Runtime Instances and Configurations

    After you connect to Command Central, you can use the Landscape Navigator view to browse the registered installations, for available runtimes and corresponding configurations.

    When you expand an installation node, you can view the list of the runtime instances in that installation. You can also view the name and the runtime status as ONLINE, UNKNOWN, FAILED, OFFLINE, and so on. Upon expanding the runtime instances, the list of configurations are displayed. You can view the configuration data for each configuration instance in the Properties view, under the Data tab.

    Deploying Customized Configuration to webMethods Cloud Container

    Using Designer you can deploy customized configuration templates to webMethods Cloud Container. You can use Landscape Navigator view to export the configuration into a Designer configuration project. Designer can be used to build and deploy this project to webMethods Cloud Container. For continuous integration purpose, these projects can be stored in Version Control System location and built through Asset Build Environment and deployed to webMethods Cloud Container.

    The following figure depicts the processes involved in exporting deployable configurations.

    You can export one or more runtime configurations to a YAML template file or as a deployable asset. You can export only deployable configurations. Deployable configurations are those configurations that can be deployed to webMethods Cloud Container. Configuration Browser view lets you identify these deployable configurations assets in the list with the green check mark icon.

    You can export deployable configuration from a runtime instance as YAML template within a configuration project. For more information about configuration projects, see Using Configuration Project. This YAML template can be manually edited and build as deployable asset. Alternatively, you can export configurations as deployable asset, which can be readily deployed to cloud solutions.

    To export a configuration

    1. On the Landscape Navigator view , select one or more configurations from a runtime to export.

    2. Right-click and select Export Configurations.

    3. Under Location, provide the following information for the configuration project: Project: The project name for configuration project. You can assign a project in either of the following ways:

      1. Browse and select an existing configuration template project.
      2. Specify a new configuration project resource. For more information about creating a new project resource, see Using Configuration Project.
    4. In theName field, select a template name. The template contains the data for the selected configurations.

    5. Under Format, select any one of the following values: YAML source: To export configurations to YAML template. You can manually edit and build YAML template as a deployable asset. Deployable Asset : To export configurations that are readily deployable for cloud solutions.

    6. In the Parameterization field, type the name of a parameter used to identify parameterization. An identifier can include lowercase a-z, uppercase A-Z, digits, dollar sign, and underscore. An identifier cannot start with a digit and cannot include any other special characters.

    7. Click Next. By default, Designer displays deployable configurations that are included for export.

    8. Select the configuration contents to confirm the set of configurations to export.

    9. Click Finish. The exported YAML template file will open in an editor. You can view the exported contents using the Project Explorer view.

    The configuration project is used for adding, editing, and building configuration templates exported from Integration Server and Universal Messaging runtimes. This project is pre-configured to build with Asset Build Environment which is used to prepare a deployable configuration asset from YAML source.

    Before you configure a project, specify the build path entries to be used as the default path. For more information on specifying build path entries, see the Build Path Preferences page in Designer.

    To create a configuration project

    1. In Designer, navigate to File > New > Project > SoftwareAG.

    2. Under SoftwareAG element, select Asset Builder and click Configuration template.

    3. Click Next. Designer displays New Configuration Project dialog box.

    4. In the Project name field, type the new name for the project.

    5. Clear the Use default location check box, to choose a different location. By default Designer uses the Workspace root location. For example, c: \[username]\workspace.

    6. Click Browse adjacent to the Location field. Navigate to and select the location directory.

    7. In the Project Settings, edit the default project structure preference to use for the source and output of builds.

    8. Under Working sets, select check box Add project to working sets to specify a working sets.

    9. Click Finish. Designer creates a configuration project.

    Note: You can install third-party YAML editors such as YEdit for Syntax highlighting support.

    Designer stores each configuration template as a YAML resource. A configuration template may contain multiple configuration types and corresponding instances from either Integration Server or Universal Messaging runtime. You can add or edit configuration types or instances in a configuration template exported from Landscape Navigator. Designer uses the default YAML editor, or the Eclipse text editor to load the template.

    To add configuration type or instance to a template

    1. On the Landscape Navigator view , select an existing configuration from a runtime.

    2. In the Properties view, select Template tab. The Template tab displays the YAML source for the selected configuration.

    3. Copy the required configuration data from the YAML source.

    4. Append the data in the template. Designer internally validates the YAML content for syntactical correctness and produces Deployable Configuration Asset upon save.

    Note: You can install third-party YAML editors such as YEdit for Syntax highlighting support.

    To deploy configuration assets to webMethods Cloud Container

    1. In Project Explorer view, select the configuration project that you want to deploy to webMethods Cloud Container.

    2. Right-click the project and click Deploy Configurations to Cloud.

    3. In the Configuration Templates dialog box, select the templates to deploy. Click Next.

    4. In the Configuration Template Variable Substitution dialog box, select the template and edit the values of the property that you want to modify before deploying to cloud. Click Next.

    5. In the Select Cloud Solution dialog box, select the solution on Cloud Container to which you want to deploy the assets and click Finish. Designer deploys the configurations assets to a remote repository provisioned for the tenant on webMethods Cloud Container.