aint/octopus repository overview

⁠Microservice Architecture Visualization Tool

Octopus is an open-source microservice architecture tool for visualizing dependency graph. It's simple and easy to use.

⁠Why

The microservice architecture has a lot of advantages but there are a lot disadvantages too. One of the main problem is that it can easily get out of control because of the quantity of the moving pieces. Especially if you just mindlessly jumped into the microservices hype.

Octopus aims to solve some of that issue by providing an overall dependency graph between microservices.

• you need it to paint the big picture. Don’t underestimate the value of seeing the big picture because you definitely need it even if you are not doing the architecture on daily basis
• you also need this to do some impact analysis

⁠Features

⁠Quick Start

docker pull aint/octopus:latest
docker run -it -p 5000:5000 aint/octopus:latest

Octopus server should now be running at http://localhost:5000⁠

Send some POST request with curl

curl -X POST \
  http://localhost:5000/ \
  -H 'Content-Type: application/json' \
  -d '{
    "eventType": "CREATE",
    "serviceName": "service-1",
    "serviceType": "svc",
    "serviceMetadata": "Java 8, Spring 5.0",
    "dependencies": {
        "SERVICES": [
            "service-2", "service-3",
        ],
        "DATABASES": [ "MySQL" ],
        "LAMBDAS": [],
        "THIRD_PARTY": []
    }
}'

Check out http://localhost:5000⁠ to see a result.

⁠Contributing

⁠Code of Conduct

I don't care about your feelings.

⁠Licence

Apache License 2.0