WSO2 carbon building process

WSO2 carbon [1] server which serves as the base for all the WSO2 products is built based on OSGi technology [2]. This blog post aims to briefly explain the code spaces that involves when building carbon server from source.

Steps to be followed to build WSO2 carbon 4.2.0 code base is explained in "Building from source" page [3]. After building kernel code space you can find the working carbon server pack at the <local-kernel-directory>/distribution/product/modules/distribution/target directory. User do not have to build platform code space to get the base carbon server, platform space needs to be built only if user needs another specific product like WSO2 ESB.

When user issues maven command with necessary build phases (Ex - mvn clean install) in their terminal from location <local-kernel-directory>, maven build process starts building checked out code in the following order.

  1. dependencies
  2. parent
  3. service-stubs
  4. core
  5. features
  6. samples
  7. distribution
These code spaces can be found directly inside the <local-kernel-directory>.

dependencies 


This code space contains 3rd party library code that are necessary for carbon server to operate. Code for these 3rd party libraries are maintained by WSO2 to make sure they meet carbon server's requirements. Therefore these 3rd party libraries have two part version numbers like X.Y.Z-wso2vN. In my previous post "Structure of WSO2 code repository"[4] I have explained what these version numbers mean.

parent 


Parent space contains a pom.xml file containing a set of properties defined to track versions of shared dependencies to be used. This pom file provide a single location to store and maintain all the dependency versions to be used in buidling the server. 

service-stubs 


Carbon server provides a set of web services that are defined by a set of wsdl files and can be called via external or internal soap client. Service-stub space provides a set of java stub implementations of these services so that a developer can easily call these web services calling these stubs.

core 


Core code space contains implementations done by WSO2 for the carbon server. Among these implementations there are OSGi bundles managing server space, features to manage user accounts, registry implementation to hold any resources user might need to add and UI bundles to support these implementations.

features 


WSO2 has developed a operational unit called feature which is a list of components and/or other features. "Introduction to feature management" [5] page of carbon documentation provides more detail about features. Features code space contains configurations used to build generic features necessary for carbon server operation.

samples 


This code space contains samples created to explain and demonstrate the functionality of WSO2 carbon server.

distribution


Build configurations in distribution directory created the final distributable WSO2 carbon server pack in the location <local-kernel-directory>/distribution/product/modules/distribution/target. This process takes all the above built artifacts such as 3rd party libraries, features and sample and combine them to create the final product.

References 


[1] http://wso2.com/products/carbon/
[2] http://www.osgi.org/Technology/WhatIsOSGi
[3] https://docs.wso2.com/display/Carbon420/Building+from+Source
[4]http://sameerak-blog.blogspot.com/2015/05/structure-of-wso2-code-repository.html
[5]https://docs.wso2.com/display/Carbon420/Introduction+to+Feature+Management




Popular posts from this blog

Running a Docker build agent on Azure Kubernetes Service (AKS)

Image
In this blog post, we are going to run the Docker build agent we created in a previous blog post and run it on Azure Kubernetes Service (AKS).  Prerequisites   1. An Azure DevOps project to connect the AKS hosted build agent. We are going to use the PartsUnlimited project we created in an  earlier post  which meets these criteria. 2. Have Docker installed on your local machine with the ability to create and run Windows containers (Refer to the troubleshooting section on this post for instructions on how to switch). 3. Have Azure CLI installed on your machine. Steps First, we are going to tag the previously created docker build agent with a new tag more suitable for version control, and run it to test operation. 1. To create the docker agent we need to create a new folder and download the following Dockerfile file . ( Link to the normal view ) and start.ps1 file . ( Link to the normal view ) files into a local folder as follows. 2. Then open a Powershell window and change the director
Read more

Azure DevOps Docker DotNet Build Agent

This blog post presents how to create and run a DotNet Azure DevOps pipeline as a Docker container. However, there is a slight problem when running VSTest on this container, and the remedy to this problem is explained in this post. Sources related to this container are located in this GitHub repo . Steps to create, run and test Docker DotNet build agent  Clone this GitHub repo to the local machine. Open a Powershell window and navigate to the folder where the cloned project is located. Execute “ docker build -t dockeragent:latest . ” to create the Docker image. Execute “ docker run -e AZP_URL=<Azure DevOps instance> -e AZP_TOKEN=<PAT token> -e AZP_AGENT_NAME=mydockeragent -e AZP_POOL=<(optional) pool to register the agent under> dockeragent:latest " to run a container based on the created image. Please remember to replace the placeholders with the information related to your Azure DevOps project. In a web browser navigate to the Agents tab under the Agent pool y
Read more

Building Azure DevOps pipelines with a Docker agent

Image
 In this post, we are going to create a Docker image to use as a build agent to Azure DevOps pipelines. The process followed in this blog post is similar to the process followed in the post where we used an Azure VM as the build agent . The difference is, instead of using an Azure VM as an agent, we are going to run a Docker container as an agent on localhost. Prerequisites   1. An Azure DevOps project to build using the Docker agent. We are going to use the PartsUnlimited project we created in an  earlier post  which meets these criteria. 2. Have Docker installed on your local machine with the ability to create and run Windows containers (Refer to the troubleshooting section on how to switch). Steps There are a lot of steps involved in creating a Docker agent and running the build pipeline on it. So I will add subtopics between steps to group steps related to a specific subtask. 1. Creating the Agent pool and generating personal access for the new build agent 1.1. Navigate to  dev.azu
Read more