Merge pull request #7 from AnuGayan/master

 Update README.md file and change product zip name to wso2si

README.md

@@ -15,43 +15,71 @@
   ~  specific language governing permissions and limitations
   ~  under the License.
   -->
+
+# Streaming Integrator
 
-# WSO2 Streaming Integrator 
+[![Jenkins Build Status](https://wso2.org/jenkins/view/wso2-dependencies/job/products/job/streaming-integrator/badge/icon)](https://wso2.org/jenkins/view/wso2-dependencies/job/products/job/streaming-integrator/)
+  [![GitHub Release](https://img.shields.io/github/release/wso2/streaming-integrator.svg)](https://github.com/wso2/streaming-integrator/releases/)
+  [![GitHub Release Date](https://img.shields.io/github/release-date/wso2/streaming-integrator.svg)](https://github.com/wso2/streaming-integrator/releases)
+  [![GitHub Open Issues](https://img.shields.io/github/issues-raw/wso2/streaming-integrator.svg)](https://github.com/wso2/streaming-integrator/commits/master)
+  [![GitHub Last Commit](https://img.shields.io/github/last-commit/wso2/streaming-integrator.svg)](https://github.com/wso2/streaming-integrator/commits/master)
+  [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
+## Introduction
 
-### Introduction
+WSO2 Streaming Integrator is an open-source streaming data processing engine which lets users integrate streaming data and/or take action based on streaming data.
 
-WSO2 Streaming Integrator is an open-source  streaming data processing engine which lets users integrate streaming data and/or take action based on streaming data
-
-### What Does Streaming Integrator do?
+## What does Streaming Integrator do?
 
 WSO2 Streaming Integration has the capability of consuming streaming data, apply stream processing techniques to process them and Integrate the process data with one or more destinations and/or trigger integration
 
+![Streaming Integrator/ Workflow](docs/images/streaming-integrator.png)
+
+## Download
+
+The Streaming Integrator is currently on development stage so please follow the [How to build]() section to build the streaming integrator from the source.
+<!-- Please download the latest WSO2 Streaming Integrator release from [here]()  -->
+
+## Building from the Source
+
+Please follow the steps mentioned below to build the WSO2 Streaming Integrator from source.
+
+1. Clone or download the source code from this repository.
+2. Run the `mvn clean install` from the root directory of the repository
+3. The generated Streaming Integrator distribution can be found at `streaming-integrator/modules/distribution/target/-streaming-integrator-<version>.zip`
+
+## Getting Started
+
+Get started with Streaming integrator in a few minutes by following [Streaming Integrator Quick Start Guide](https://docs.wso2.com/display/SP4xx/Quick+Start+Guide)
 
-### Architecture Diagram
+## Deploy in Docker
 
+WSO2 Streaming Integrator has a docker distribution so that it can be deployed in any container-orchestration system.
+The docker image can be build from the source or can be download directly from the docker_hub.
 
+### Build the docker image
 
-### Download ####
+To build the docker image from the source the host machine should have docker installed and run the `mvn clean install -Ddocker.skip=false` from the root directory.
 
-Please download the latest stable WSO2 Stream Processor release from [https://wso2.com/analytics-and-stream-processing/install](https://wso2.com/analytics-and-stream-processing/install)
+### Get from docker hub
 
-#### How to Run ####
+Please use following command to get the docker image from the docker hub.
 
-Please refer to our quick start guide on how to start and run the WSO2 Stream Processor.
-https://docs.wso2.com/display/SP4xx/Quick+Start+Guide
+```bash
+docker pull wso2/streaming-integrator
+```
 
-#### Documentation ####
+## Deploy in kubernetes
 
-Please see the [WSO2 Documentation site for WSO2 SP](https://docs.wso2.com/display/SP4xx)
+WSO2 Streaming Integrator can be deployed in a Kubernetes cluster using Siddhi Operator. For more details please refer to [Installing the Streaming Integrator Using Kubernetes](https://docs.wso2.com/display/INSTALL/Installing+Enterprise+Integrator+Using+Kubernetes)
 
-#### Support ####
+## Support
 
 We are committed to ensuring that your enterprise middleware deployment is completely supported from evaluation to production. Our unique approach ensures that all support leverages our open development methodology and is provided by the very same engineers who build the technology.
 
-For more details and to take advantage of this unique opportunity please visit http://wso2.com/support.
+For more details and to take advantage of this unique opportunity please visit our [support site](http://wso2.com/support).
 
 
-#### Reporting Issues  ####
+## Reporting Issues
 
-We encourage you to report issues, documentation faults and feature requests regarding WSO2 SP through the [WSO2 SP Issue Tracker](https://github.com/wso2/product-sp/issues).
+We encourage you to report issues, documentation faults and feature requests regarding WSO2 Streaming integrator through the [WSO2 SI Issue Tracker](https://github.com/wso2/streaming-integrator/issues).

modules/distribution/carbon-home/resources/dockerfiles/Dockerfile

@@ -20,4 +20,4 @@
 
 FROM wso2/streaming-integrator:latest
 
-COPY files/siddhi-files /home/wso2carbon/wso2-streaming-integrator/wso2/server/deployment/siddhi-files
+COPY files/siddhi-files /home/wso2carbon/wso2si/wso2/server/deployment/siddhi-files

modules/distribution/pom.xml

@@ -1095,7 +1095,7 @@
                             <descriptors>
                                 <descriptor>${basedir}/src/assembly/bin.xml</descriptor>
                             </descriptors>
-                            <finalName>wso2-streaming-integrator-${project.version}</finalName>
+                            <finalName>wso2si-${project.version}</finalName>
                             <appendAssemblyId>false</appendAssemblyId>
                         </configuration>
                     </execution>
@@ -1113,10 +1113,10 @@
                             <skip>${docker.skip}</skip>
                             <target>
                                 <echo message="prepare phase"/>
-                                <unzip src="${project.build.directory}/${project.artifactId}-${project.version}.zip" dest="${project.build.directory}/docker"/>
-                                <move file="${project.build.directory}/docker/${project.artifactId}-${project.version}" tofile="${project.build.directory}/docker/${project.artifactId}"/>
-                                <chmod file="${project.build.directory}/docker/${project.artifactId}/bin/*.sh" perm="+x"/>
-                                <chmod file="${project.build.directory}/docker/${project.artifactId}/wso2/server/bin/*.sh" perm="+x"/>
+                                <unzip src="${project.build.directory}/wso2si-${project.version}.zip" dest="${project.build.directory}/docker"/>
+                                <move file="${project.build.directory}/docker/wso2si-${project.version}" tofile="${project.build.directory}/docker/wso2si"/>
+                                <chmod file="${project.build.directory}/docker/wso2si/bin/*.sh" perm="+x"/>
+                                <chmod file="${project.build.directory}/docker/wso2si/wso2/server/bin/*.sh" perm="+x"/>
                             </target>
                         </configuration>
                         <goals>

modules/distribution/src/assembly/bin.xml

@@ -17,7 +17,7 @@
   -->
 <assembly>
     <includeBaseDirectory>true</includeBaseDirectory>
-    <baseDirectory>wso2-streaming-integrator-${project.version}</baseDirectory>
+    <baseDirectory>wso2si-${project.version}</baseDirectory>
     <id>WSO2 Streaming Integrator Distribution</id>
     <formats>
         <format>zip</format>
@@ -88,25 +88,6 @@
             </includes>
             <fileMode>444</fileMode>
         </fileSet>
-        <fileSet>
-            <directory>../samples</directory>
-            <outputDirectory>samples</outputDirectory>
-            <excludes>
-                <exclude>target/**</exclude>
-                <exclude>scripts/**</exclude>
-                <exclude>pom.xml</exclude>
-                <exclude>LICENSE.txt</exclude>
-                <exclude>release-notes.html</exclude>
-                <exclude>**/*.ipr</exclude>
-                <exclude>**/*.iwr</exclude>
-                <exclude>**/*.eclipse</exclude>
-                <exclude>**/*.iml</exclude>
-                <exclude>**/*.releaseBackup</exclude>
-                <exclude>%regex[(?!.*utils/).*pom.xml]</exclude>
-                <exclude>**/target/**</exclude>
-            </excludes>
-            <fileMode>644</fileMode>
-        </fileSet>
         <fileSet>
             <directory>carbon-home/deployment/siddhi-files</directory>
             <outputDirectory>wso2/server/deployment/siddhi-files</outputDirectory>

modules/distribution/src/assembly/filter.properties

@@ -2,4 +2,4 @@ product.name=WSO2 Streaming Integrator
 product.version=1.0.0
 server.name=WSO2 Carbon Kernel
 server.version=5.2.7
-product.wum.name=wso2-streaming-integrator
+product.wum.name=wso2si

modules/distribution/src/docker-distribution/filtered/Dockerfile

@@ -27,7 +27,7 @@ ARG USER_GROUP=wso2
 ARG USER_GROUP_ID=802
 ARG USER_HOME=/home/${USER}
 # docker image build arguments for wso2 product installation
-ARG STREMING_INTEGRATOR_NAME=wso2-streaming-integrator
+ARG STREMING_INTEGRATOR_NAME=wso2si
 ARG STREMING_INTEGRATOR_HOME=${USER_HOME}/${STREMING_INTEGRATOR_NAME}
 
 # create the user and group
@@ -46,4 +46,4 @@ WORKDIR ${USER_HOME}
 EXPOSE 7443 7070 9717 9612 7711 7611
 
 # initiate container and execute the micro integrator product startup script
-ENTRYPOINT ["/home/wso2carbon/wso2-streaming-integrator/bin/server.sh"]
+ENTRYPOINT ["/home/wso2carbon/wso2si/bin/server.sh"]

modules/performance/README.md

@@ -20,8 +20,8 @@ How to run
 7. Sample client that are used for the tests can be found inside modules/performance/sample-clients
 8. Copy that TCP Client to <SP_HOME>/samples
 9. Navigate to <SP_HOME>/bin
-10. Issue the command as ./worstreaming-integrator.sh
-    * Once WSO2 SP server is successfully started, a log similar to the following is printed in the Terminal.
+10. Issue the command as ./server.sh
+    * Once WSO2 SI server is successfully started, a log similar to the following is printed in the Terminal.
         * WSO2 Streaming Integrator started in x sec
 11. Start the TCP-Client using "ant" command
     * If the client starts successfully, the following messages appear on the terminal.