VDC-Request-Monitor

README

DITAS - VDC Request Monitor

The VDC Request Monitor is one of the monitoring sidecars used to observe the behavior of VDCs within the DITAS project. The agent acts and ingress controller to the VDC and observes any incoming and outgoing HTTP/HTTPS traffic.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

To install the go lang tools go to: Go Getting Started

To run the monitor with Authorization enabled, you need to have an Identity Provider running. For our example Config we use a Keycloak instance. To run your own Keycloak server visit http://blog.keycloak.org/2015/10/getting-started-with-keycloak.html and follow the instructions. See also the DITAS Keycloak documentation.

Installing

For installation you have two options, building and running it on your local machine or using the docker approach.

For local testing and building for that you can follow the following steps:

compile

CGO_ENABLED=0 GOOS=linux go build -a --installsuffix cgo --ldflags="-w -s -X main.Build=$(git rev-parse --short HEAD)" -o request-monitor

to run locally:

./request-monitor

For the docker approach, you can use the provided dockerfile to build a running artifact as a Docker container.

build the docker container:

docker build -t ditas/request-monitor -f Dockerfile.artifact . 

Attach the docker container to a VDC or other microservice like component:

docker run -v ./monitor.json:/etc/ditas/monitor.json --pid=container:<APPID> -p <HTTP-port>:80 -p <HTTPS-port>:443 ditas/request-monitor

Here <APPID> must be the container ID of the application you want to observe. The <HTTP-port> and <HTTPS-port> can be set as desidered. Also, refer to the Configuration section for information about the monitor.json-config file.

Running the tests

Before testing run prepare.sh in the testing folder.

For testing you can use:

 go test ./...

Use -short if you do not have docker on your machine than some integration tests will be skipped.

For that make sure you have an elastic search running locally at the default port and some sort of local service that can process HTTP traffic, we recommend net-cat in listening mode nc -l 8080.

Configuration

To configure the agent, you can specify the following values in a JSON file:

ELasticsearch

• ElasticSearchURL => The URL that all aggregated data is sent to
• ElasticBasicAuth => boolean to indicate if authentication for the elastic is required
• ElasticUser => username for the elasticsearch
• ElasticPassword => password for the elasticsearch
• IgnoreElastic => boolean which disables the sending of data to the elastic search (recommended only for debugging)

General

• VDCName => the Name used to store the information under
• Endpoint => the address of the service that traffic is forwarded to
• Port => the port the monitor is running on
• SSLPort => the SSL port of the monitor
• InfrastructureID => Infrastructure ID to recognize on which structure the rm is running on

Tracing

• Opentracing => indicates if an open tracing header should be set on every incoming request and if the frames should be sent to Zipkin
• ZipkinEndpoint => the address of the Zipkin collector

Certificates

• UseACME => use lets encrypt to generate certificates for https
• UseSelfSigned => let the agent generate self-signed certificates or use the ones provided in the config directory (same as the location of the config file). The files the agent is looking for are cert.pem and key.pem.

Logging

• ForwardTraffic => allow the agent to forward all incoming and outgoing data to a secondary service for, e.g., auditing.
• ExchangeReporterURL => if the ForwardTraffic is enabled, send the data to this location.
• verbose => boolean to indicate if the agent should use verbose logging (recommended for debugging)

User Authentication

• UseIAM => boolean to indicate if the agent should check Authentication Headers
• KeyCloakURL => URL to get keys for JWT validation

Benchmarking

• ForwardBenchmark => boolean to indicate if agent should report data to the BenchmarkScheduler
• BMSURL => URL of the BenchmarkScheduler where the data should be reported to

Demo

• DemoMode => bool if demo mode should be activated
• DemoSecret => the preshared secret that is used to activate perform demo
• SimulateInfrastructure => bool if the DITAS infastructure should be simulated
• DANGERZONE => disable all authentication on the control plane also autoallow all login. This is the Danger Zone do not use in production ever!

An example file could look like this:

{
    "ElasticSearchURL":"http://127.0.0.1:9200",
    "ElasticBasicAuth": true,
    "ElasticUser": "user",
    "ElasticPassword": "123456",
    "IgnoreElastic": false,
    "VDCName":"tubvdc",
    "Endpoint":"http://127.0.0.1:8080",
    "Port": 80,
    "SSLPort":443,
    "InfrastructureID": "fog-1",
    "Opentracing":true, 
    "ZipkinEndpoint": http://localhost:9411,
    "UseACME": true,
    "UseSelfSigned":true,
    "ForwardTraffic":false,
    "verbose":false,
    "UseIAM": true,
    "KeyCloakURL": "http://127.0.0.1:8080/auth/realms/vdc_dummy/protocol/openid-connect/certs",
    "ForwardBenchmark": false,
    "BMSURL": "http://localhost:8081/sample",
    "DemoMode": false,
    "DemoSecret": "someSecretString",
    "SimulateInfrastructure": false,
    "DANGERZONE": false

}

Alternatively, users can use flags with the same name to configure the agent.

Built With

• viper
• oxy
• Zipkin
• OpenTracing
• Let's Encrypt
• ElasticSearch

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache 2.0 - see the LICENSE.md file for details.

Acknowledgments

This is being developed for the DITAS Project