allspark

README

AllSpark

AllSpark is a simple building block for quickly building web microservice deployments for demo purposes.

It supports at most one workload and arbitrary number of subsequent requests to other services that will be called on a single request.

Workload

The used workload can be set using the WORKLOAD environment variable.

Currently the following workloads are supported:

PI

Calculates PI to generate CPU and memory usage

Available options:

• PI_COUNT - how many goroutines to use

Echo

Simply echos back a set string

Available options:

• ECHO_STR - string to echo back

Subsequent requests

Subsequent request URLs can be set using the REQUESTS environment variable. Multiple URLs can be set and must be separated by space. A count must also be set for each URL using the following syntax: URL#count.

Apache Kafka

Allspark can be used as an Apache Kafka consumer or producer. A single instance can work as both at the same time.

KafkaServer

The Kafka server is a consumer that triggers REQUESTS when a message is consumed from the topic specified with the below option. Available options:

• KAFKASERVER_BOOTSTRAP_SERVER

  The kafka bootstrap server where the cluster can be reached. Required.

  e.g.

    name: KAFKASERVER_BOOTSTRAP_SERVER
    value: "kafka-all-broker.kafka.svc.cluster.local:29092"
  

• KAFKASERVER_TOPIC

  Starts a kafka consumer for the topic passed in as value.

  e.g.

    name: KAFKASERVER_CONSUMER
    value: "example-topic"
  

• KAFKASERVER_CONSUMER_GROUP

  Sets the consumer group id for the kafka consumer.

  If not set it gets defaulted to allspark-consumer-group.

  e.g.

    name: KAFKASERVER_CONSUMER_GROUP
    value: "example-group"
  

Requests

You can use the REQUESTS variable to set additional consumers and producers

e.g.

  name: REQUESTS
  value: kafka-consume://kafka-all-broker.kafka:29092/example-topic?consumerGroup=allspark-consumer-group kafka-produce://kafka-all-broker.kafka:29092/example-topic?message=example-message#1

Example deployment

apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: ratings-v1
  labels:
    app: ratings
    version: v1
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: ratings
        version: v1
    spec:
      containers:
      - name: ratings
        image: banzaicloud/allspark:0.0.2
        imagePullPolicy: Always
        ports:
        - containerPort: 9080
        env:
        - name: SERVER_LISTENADDRESS
          value: 0.0.0.0:9080
        - name: WORKLOAD
          value: Echo
        - name: ECHO_STR
          value: "ratings service response"
        - name: REQUESTS
          value: "http://analytics:8080/#1"
        - name: SQL_DSN
          value: "postgresql://username:password@postgres:5432/postgres?sslmode=allow"
        - name: SQL_QUERY
          value: "SELECT * FROM pg_tables"
        - name: SQL_QUERY_REPEAT_COUNT
          value: "2"
        - name: SQL_QUERY_REPEAT_COUNT_MAX
          value: "10"
---
apiVersion: v1
kind: Service
metadata:
  name: ratings
  labels:
    app: ratings
    service: ratings
spec:
  ports:
  - port: 9080
    name: http
  selector:
    app: ratings
---
apiVersion: extensions/v1beta1
kind: Deployment
metadata:
  name: analytics-v1
  labels:
    app: analytics
    version: v1
spec:
  replicas: 1
  template:
    metadata:
      labels:
        app: analytics
        version: v1
    spec:
      containers:
      - name: analytics
        image: banzaicloud/allspark:0.0.2
        imagePullPolicy: Always
        ports:
        - containerPort: 8080
        env:
        - name: WORKLOAD
          value: PI
        - name: PI_COUNT
          value: "20000"
---
apiVersion: v1
kind: Service
metadata:
  name: analytics
  labels:
    app: analytics
    service: analytics
spec:
  ports:
  - port: 8080
    name: http
  selector:
    app: analytics