Objective

You have a given SOA composite that was developed in JDeveloper and the source code is managed in a GIT repository.  The goal of the tutorial is to automate the deployment of the composite across multiple environments.  This automation will include:

• cloning the composite from a GIT repository

• compiling and packaging the composite into a SAR file

• deploying the SAR file to multiple environments

• utilizing a global config plan to adjust environment-specific URLs as deployments progress through the environments

We will walk through each of the FlexDeploy features that will be created/configured to accomplish this goal and have the composite deployed in a very short amount of time.

The tutorial does not cover every feature or configuration option available in FlexDeploy.

Checklist

Create SOA Project using Blueprint

The assumption is that you have FlexDeploy installed and ready for use. When logged into the FlexDeploy, you will see the Home page. Click on the + icon on the top and click “Create Project” to create a new project.

Open

The screen displays the list of blueprints technologies supported by the FlexDeploy. Select the blueprint from the list or you can search for the blueprint in the search filter present in the top. In our case, we will select the SOA Composite blueprint.

Open

General Configuration

Scroll through this guide to fill in the blueprint properties. It is a best practice to name the Project with the same name as the SOA Composite, a FlexDeploy property (ProjectName and FD_PROJECT_NAME) will be automatically set and can be utilized during the configuration.

Project Info

The Build and Deploy options are auto-selected.

Source Control

Click on source repository dropdown. If you have already created a connection to your source code repository, select it from the list. Enter the sparse checkout folder, if any.

Otherwise add one by clicking on “Create new Source Repository”. Enter the sparse checkout folders script, if any.

Inputs Info

We selected the SCM type as GIT. The properties related to the GIT source control management will be displayed on the screen.

Click on Create New Credential to create a new credential password for GIT password. Enter the credential Name which is unique name to identify the password. In the secret text, enter the password and click on Save.

After saving the credential, click on Save again on the SCM instance. Do a Test Connection. The green color ticket mark will show that the connection is successful.

Enter the sparse checkout folder value, if any.

Gather Build and Deployment information

Enter values for any workflow properties which are required for the build and deploy.  In the image below, no properties are required for this build. Select the target endpoint that the build and deploy should execute on.

Target Properties

The Project Name will be auto updated as HRSOAService since it takes the value same as SOA Composite.

The Folder path is auto updated to FlexDeploy/SOA/ and it creates the project under folder named same as Jdeveloper workspace name i.e. HRSOAService and click on “Create”.

We can see the Folder hierarchy on the top of the project.

Summary

General Configuration

Build and Deploy Workflows

Project Properties

These properties are project scoped resources and can be changed per project.  The plugin operations that were added to the workflows determine the available project properties that can be configured.  The property that are updated are the and SOA Composite Name and SOA partition, which is the organizational structure for composites on the SOA server. You can filter out the properties by using the search filter properties in the top.

Source Control

Branch Name

Change the branch name similar to the git repositories branch name. Click on Save.

SCM Instance

Viewing the current list of Integrations is achieved by selecting Topology from the menu, then the Integrations tab from the left-hand pane.  There are eleven types of integrations in FlexDeploy, but we will focus on Source Control in this tutorial.

Target Properties

Select Topology from the menu and then select Topology Overview from the left menu.  You will see a table that has Instances as the rows and Environments as the columns with colored circles representing the Target.  Color coding represents:

• RED - no required properties are set and/or the Endpoint is not configured

• YELLOW - some of the required properties are set and/or the Endpoint is not configured

• GREEN - all required properties are set and the Endpoint is configured

Selecting the GREEN circle for DEV will display the configurable properties/Endpoint and allows for the configuration of the properties.

Build Execution

FlexDeploy is configured with everything that is required to execute a build and deploy request for the SOA composite, we can execute the first build.  Click on Execution tab to submit the build request for that package. Click on Build.

The Build Request Form will appear and we need to:

1. select the environment we want to build the composite in, the environments that had the Build Environment checkbox will appear in the dropdown

2. select the SCM Branch that was configured on the project, this will be pre-populated if there is only one configured Branch.

3. submit the request, this will initiate the soaBuild workflow

Upon submission, the build workflow is initiated and the workflow steps are executed on the SOA instance in the Dev environment, utilizing the SOADEV endpoint.  Upon completion of the workflow, the execution status will be successful.

With the successful execution of the build, a SAR file artifact is created, stored in the artifact repository and marked with the Project Version.  Every build will generate a new Project Version.  The generated SAR artifact and the discovered project specific config plans can be viewed from the Execution Id link and the Artifacts tab.

Navigate to steps tab in order to view the workflow steps. Click on the link to view the plugin logs.

Now the composite can be deployed to an environment by selecting the icon as shown in the below screenshot.

The Deploy Request Form will appear and we need to:

1. The Project Version will be updated same as the build project version. However, the dropdown will contain all previously create Project Versions

2. select the Environment that the deployment will be executed in

3. The Deploy Instance, will be updated same as the deploy instance on the General Configuration.  However, Deployments can happen on multiple instances.

4. submit the request, this will initiate the soaDeploy workflow

Upon submission, the deploy workflow is initiated and the workflow steps are executed on the SOA instance in the Dev environment, utilizing the SOADEV endpoint.  Upon completion of the workflow, the execution status will be successful. With the successful execution of the deploy, the SAR file artifact will be deployed to the Dev environment.

The Execution Id is a link to all of the execution data related to each request, such as

1. the workflow execution steps

2. the logs for each workflow step, which can be viewed by clicking on the link under the step

3. the artifact, which can be downloaded

4. the project and environment instance property values at the time of execution

Congratulations! You have successfully completed the SOA Suite tutorial.

Now that you have configured FlexDeploy for one composite, it is extremely easy to add more composites.  Simply use the Copy Project feature and a new project will be created with all of the configuration completed already.