https://github.com/oslabs-beta/orcastration

A GUI designed to easily visualize Docker Swarm Nodes allowing developers to fully understand their swarm, containers, and images at all times.
https://github.com/oslabs-beta/orcastration

chartjs css docker dockerswarm dockerswarm-monitoring express javascript jest node react tailwind

Last synced: about 2 months ago
JSON representation

A GUI designed to easily visualize Docker Swarm Nodes allowing developers to fully understand their swarm, containers, and images at all times.

• Host: GitHub
• URL: https://github.com/oslabs-beta/orcastration
• Owner: oslabs-beta
• License: mit
• Created: 2022-12-23T23:01:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-26T15:01:32.000Z (over 2 years ago)
• Last Synced: 2025-04-30T19:09:13.632Z (about 2 months ago)
• Topics: chartjs, css, docker, dockerswarm, dockerswarm-monitoring, express, javascript, jest, node, react, tailwind
• Language: JavaScript
• Homepage: https://orcastration.dev/
• Size: 438 KB
• Stars: 58
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    





  

    

  

  

  



Orcastration






    Orcastration is a Docker Swarm visualization tool, giving developers the power to view container metrics of their Docker Swarm with ease! A seamless and efficient GUI gives you insight to CPU usage, memory usage, NET I/O, and the health of each of your Docker swarm containers organized neatly by node and task. Say goodbye to clumsy and difficult to understand Docker CLI command outputs and say hello to Orcastration.






How it works

    


        Orcastration runs Docker CLI commands for you (out of sight and automatically) in order to retrieve Docker Swarm cluster information from the daemon. Data is then processed and graphs are generated in order to represent your various container metrics. Orcastration creates pie and line charts based on live-streamed data, so you can track your container's metrics in real-time. Orcastration also makes it easy to monitor the health and logs of your containers utilizing Docker Health Check. With the simple click of a button, get immediate feedback on the health status of your containers. 

    

How to use Orcastration




First:

git clone https://github.com/oslabs-beta/Orcastration.git


Clone this repository to your machine.




Next:




npm install

Install dependencies in order to ensure proper app functionality.




Then:



    Confirm that your Docker Swarm and Docker Desktop are running. Verify that you are running Orcastration on the same machine that is hosting the manager node. The application must be running on the manager node’s machine in order to have the necessary access to the swarm's cluster management functionality.  Please be aware that Orcastration runs on port 8080 and 3000, so be mindful that none of your containers share these ports! Also, understand that the Docker Health Check feature will only function for Docker containers configured with Docker healthcheck in the Dockerfile or the Docker Compose file.

    


    
Click here for more information on Docker Health Check. 






Next:



    Orcastration utilizes a MongoDB database in order to efficiently serve your data. In order to ensure proper functionality, create a MongoDB database (click here for more information on setup). Then, create an .env file in the root of the Orcastration codebase and set an environment variable of 

    


    
MONGO_URI

    to your newly created MongoDB URI. 

Click here for more information on environment variables.

    





Finally...

npm run dev



    Run Orcastration and view your Docker Swarm metrics! (Note: if Orcastration does not run or you encounter errors, try restarting Docker Desktop!)






Want to contribute?



    Submit a pull request or reach out to one of our team members directly (contact information listed below).






Encounter a bug?



    Let us know! Submit an issue with the following format and we'll address it as soon as possible. 

    


    


    
What is the bug?

    
How can you replicate the bug (please include specific steps)?

    
What is the severity of this bug: high (impacts core functionality), mid (slightly impacts functionality, but app still remains usable), or low (an annoyance)?





Contributors



  


    Danny Zheng

    

      

    

      

      

    

  

  


    Andrew Hogan

    

      

    

      

      

    

  

  


    Meimei Xiong

    

      

    

      

      

    

  

  


    Max Heubel

    

      

    

      

      

    

  

    


    Juliana Morrelli