esp-kubernetes

Note: These instructions are specific to SAS Event Stream Processing 6.2 or later.

Overview

This project is a repository of tools that enable you to develop, deploy, and test an ESP server and SAS Event Stream Processing clients in a Kubernetes cluster. The tools consist of a set of deployment scripts, YAML template files, and sample projects (XML files) that you can run in the cluster. Before you use the tools available in this project, you must download the pre-built Docker images made available through your SAS Event Stream Processing Software Order Email (SOE).

See the SAS Event Stream Processing on Linux: Deployment Guide for information about how to download the required Docker images and load them onto a local Docker repository.

The deployment scripts supplied require you to do either of the following:

• Specify the location of the images on the command line
• Set several environmment variables that indicate the location of the images

For example, setting the following environment variables enable the deployment scripts to pick up the appropriate Docker images:

export IMAGE_ESPESM="docker.sas.com/pdt/sas-esmapplication:6.2.0-20191029.1572337034992"
export IMAGE_ESPSRV="docker.sas.com/pdt/sas-esp:6.2.0-20191029.1572348916638"
export IMAGE_ESPSTRMVWR="docker.sas.com/pdt/sas-espstreamviewer:6.2.0-20191029.1572339074874"
export IMAGE_ESPSTUDIO="docker.sas.com/pdt/sas-espstudio:6.2.0-20191029.1572338415245"
export IMAGE_METERBILL="docker.sas.com/pdt/sas-espmbs:6.2.0-20191029.1572348254917"
export IMAGE_OPERATOR="docker.sas.com/pdt/sas-espcompop:6.2.0-20191029.1572348554623"
export IMAGE_BILLAGENT="repulpmaster.unx.sas.com/lookaside/18b072c9-60bc-45ca-a854-43c3ae8c13b7:latest"

Prerequsities

To deploy the images, you must have a running Kubernetes cluster and a have persistent volume available for use. Work with your Kubernetes administrator to obtain access to a cluster with a persistent volume.

Getting Started

Explore the following project subdirectories to perform specific development and deployment tasks:

• Operator - Contains scripts, YAML template files, and projects to deploy the SAS Event Stream Processing metering server and the ESP operator. Follow the README in this location to deploy a command line version of the SAS Event Stream Processing environment.

The following Docker images are deployed from this location:

• SAS Event Stream Processing metering server

• ESP operator

• Open source filebrowser to manage the persistent volume

• Single-User Clients - Contains scripts, YAML template files, and projects to deploy SAS Event Stream Processing graphics clients. Do not deploy the single-user clients until after you have deployed the Operator. You must run scripts from this directory in the same K8 namespace as that of the operator.

The following Docker images are deployed from this location:

• SAS Event Stream Processing Studio
• SAS Event Stream Processing Streamviewer
• SAS Event Stream Manager

Each of these subdirectories contain README files with more specific, detailed instructions.

Contributing

We welcome your contributions! Please read CONTRIBUTING.md for details on how to submit contributions to this project.

License

This project is licensed under the Apache 2.0 License.

Additional Resources

The SAS Event Stream Processing product support page contains:

• Current and past product documentation
• Instructional videos
• Examples
• Training courses
• Featured blogs
• Featured community topics