wso2/wso2sp-editor repository overview

⁠Supported tags and respective Dockerfile links

• 4.4.0 (Dockerfile)⁠
• 4.4.0-alpine (Dockerfile)⁠
• 4.4.0-centos (Dockerfile)⁠
• 4.3.0, latest (Dockerfile)⁠
• 4.3.0-alpine (Dockerfile)⁠
• 4.3.0-centos (Dockerfile)⁠

⁠Quick reference

• Where to get help:
  Docker Community Forums⁠, Docker Community Slack⁠, Stack Overflow⁠ or mail to WSO2 Developer mailing list⁠

• Where to file issues:
  Product specific issues at WSO2 Stream Processor product repository⁠ and Docker resource usage issues at product Docker resource repository⁠

• Maintained by:
  WSO2 Inc.⁠

• Supported Docker versions:
  Docker v17.09.0 or above

⁠About Editor profile of WSO2 Stream Processor

WSO2 Stream Processor is a Streaming SQL based, high performant, lightweight, open source stream processing platform, facilitating the creation of real-time, intelligent, actionable business insights, and data products for digital businesses. It allows you to collect events via multiple transports and in multiple formats. It uses streaming SQL to process streams, detect complex events, calculate time-based aggregations, and make predictions using machine learning models.

This runs the developer environment where the following can be carried out:

• Creating Siddhi applications/Siddhi application templates.

• Testing and debugging Siddhi applications to determine whether they are ready to be used in a production environment.

⁠How to use this image.

⁠Start an Editor profile instance

The following command starts a Linux Ubuntu-based Editor profile Docker image.

$ docker run -it -p 9390:9390 --name editor wso2/wso2sp-editor:4.3.0

Here, port 9390 has been mapped to the corresponding Docker host (host machine on top of which containers are spawned) port.

⁠Container shell access and viewing server logs

Assuming you have started a Docker container instance of Editor profile as instructed in the previous section Start an Editor profile instance,

• The Editor profile server log is available through Docker's container log:

$ docker logs editor

• The Docker exec command allows you to run commands inside a Docker container. The following command line will give you a bash shell inside the container you created:

$ docker exec -it editor bash

⁠Pass arguments during server startup

⁠Running in debug mode

To start a Docker container instance of the Editor profile in debug mode (assuming 5005 to be the remote debugging port), use the following command:

$ docker run -it -p 9390:9390 -p 5005:5005 --name another-editor wso2/wso2sp-editor:4.3.0 -debug 5005

⁠How to update configurations

Configurations would lie on the Docker host machine and they can be volume mounted to the container. All the configurations related to Editor profile are in deployment.yaml file. Each component has a corresponding heading in the YAML file that covers most of the component-specific configuration like Carbon configuration parameters, data source configuration, cluster configuration, etc. As an example, steps required to change the port offset using deployment.yaml is as follows:

• Stop the Editor profile container if it's already running.

In Editor profile product distribution, deployment.yaml configuration file can be found at {DISTRIBUTION_HOME}/conf/editor/deployment.yaml. Copy the file to some suitable location of the host machine, referred to as {SOURCE_CONFIGS}/deployment.yaml and increase the port offset value under wso2.carbon -> ports by 1.

• Grant read permission to other users for {SOURCE_CONFIGS>/deployment.yaml.

$ chmod o+r {SOURCE_CONFIGS}/deployment.yaml

• Run the image by mounting the file to the container as follows:

$ docker run -p 9390:9390 --volume {SOURCE_CONFIGS}/deployment.yaml:{TARGET_CONFIGS}/deployment.yaml wso2/wso2sp-editor:4.3.0

Here, {TARGET_CONFIGS} refers to /home/wso2carbon/wso2sp-4.3.0/conf/editor folder of the container.

⁠Image Variants

Multiple product profile Docker images based on different base operating systems are available.

⁠wso2sp-editor:{version}

Ubuntu 18.04 LTS based Docker image with AdoptOpenJDK 8 pre-installed has been used as the base Docker image⁠.

Editor profile of WSO2 Stream Processor has been installed on top of this Docker image.

⁠wso2sp-editor:{version}-alpine

Alpine based Docker image with AdoptOpenJDK 8 pre-installed has been used as the base Docker image⁠.

Editor profile of WSO2 Stream Processor has been installed on top of this Docker image.

⁠wso2sp-editor:{version}-centos

CentOS 7 based Docker image⁠ has been used. AdoptOpenJDK 8 and Editor profile of WSO2 Stream Processor have been installed on top of this Docker image.

⁠License

View license information⁠ for the software contained in this image.

As with all Docker images, these are likely to contain other software which may be under other licenses (such as Bash, etc. from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.