Skip to content

VSTS Extension to integrate with IBM WebSphere Application Server

License

Notifications You must be signed in to change notification settings

microsoft/vsts-ibm-websphere-extension

Repository files navigation

Azure DevOps Extension for IBM WebSphere Application Server
Provides deployment task that automatically installs/updates enterprise applications in WebSphere Application Servers.
Install now!

Azure DevOps Extension for IBM WebSphere Application Server

This extension contains a deployment task which allows you to automate the installation and update of applications to IBM WebSphere Application Servers. This extension installs the following components:

  • A service endpoint for connecting to IBM WebSphere Application Server on Azure DevOps and Team Foundation Server 2017.
  • A build task to install / update enterprise applications on WebSphere Application Servers.

Prerequisites

  • In order to automate the installation and update of enterprise applications to WebSphere Application Servers, the build agent must have access to the 'wsadmin' commands. Please follow the IBM WebSphere document to setup the command environment. To check if the environment is setup correctly:
    • You can run wsadmin.sh(Linux) / wsadmin.bat(Windows) command from the terminal or command line respectively. Make sure IBM WebSphere bin/ directory is in the PATH.
    • Execute "wsadmin.sh -conntype SOAP -host <your_websphere_hostname> -port <your_websphere_SOAP_port> -username <your_username> -password <your_password> -c AdminControl.getNode()" on the build agent. It should return the node name of the IBM WebSphere Application Server.
    • You may need to create a profile in your build agent to make the command line work.

Quick Start

Once you have set up the WebSphere environment, perform the following steps to automate the deployment of applications to WebSphere Application Servers:

  1. Install the IBM WebSphere extension from the Team Services Marketplace.

  2. Go to your Azure DevOps or TFS project, click on the Build tab, and create a new build definition (the "+" icon) that is hooked up to your project's appropriate source repository.

  3. Click Add build step... and select the necessary tasks to generate your release assets (e.g. Maven, Gradle).

  4. Click Add build step... and select IBM WebSphere Deployment task from the Deploy category.

  5. Configure the IBM Websphere Deployment task with the desired authentication method, and the install / update options.

  6. Click the Queue Build button or push a change to your configured repository in order to run the newly defined build.

  7. Your Websphere application changes will now be automatically installed / updated to the WebSphere Application Servers!

IBM WebSphere Application Deployment Task

  1. Open your build definition and add the "IBM WebSphere Deployment" task. The task can be found in the 'Deploy' section.

    IBM WebSphere Deployment Task

  2. Details of the install / update deployment task. Note that this task includes both install and update cases. If the target application does not exist, it will install it; Otherwise it will update the target application.

    IBM WebSphere Deployment Task Details

    • Setup Connection Options.
    • Enter the application name.
    • Enter the update content path. This should be the path points to the application file. Wildcards can be used, but the pattern must resolve to exactly one file.
    • By default "Install Application If Not Exist" is checked. If the application does not exist, it will be first installed.
    • Enter the target cell, node, and application server name if this application is expected to be installed for the first time.
    • Enter the optional context root information. If left blank, the default context root will be "/your_application_name".
    • Enter the optional Web Module, Virtual Host, and URI information. If left blank, the task will attempt to extract this information automatically from the application file.
    • By default "Start Application" is checked. It will start the application after the installation.
  3. If you are certain that the target application already exists in the IBM WebSphere Application Server, you can uncheck the "Install Application If Not Exist". The task will then hide fields that are only relevant to installation:

    IBM WebSphere Update-only Task Details

Setup Connection Options

The tasks provide two options to connect to IBM WebSphere Application Server:

  1. Connecting with an "IBM WebSphere" endpoint.

    • This option is supported on Azure DevOps and Team Foundation Server 2017. On Team Foundation Server 2015, please use other options to connect.

    IBM websphere Endpoint

    • Connection name: name used to identify this connection.
    • Hostname / IP Address: IP address or the hostname of the computer on which the IBM WebSphere is running. The hostname must be resolvable by the build agent. Do not prefix with protocol names.
    • Port: SOAP port of the target WebSphere.
    • Username and Password: Administrative user name and password of the target WebSphere. Make you can use this pair to login the WebSphere console.
  2. Manually enter credentials.

    • The same fields from "IBM WebSphere" endpoint section are repeated within the task.

Support

Support for this extension is provided on our GitHub Issue Tracker. You can submit a bug report, a feature request or participate in discussions.

Contributing to the Extension

See the developer documentation for details on how to contribute to this extension.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Privacy Statement

The Microsoft Visual Studio Product Family Privacy Statement describes the privacy statement of this software.

About

VSTS Extension to integrate with IBM WebSphere Application Server

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published