Introduction

In the realm of DevOps, visualization of network architecture is a fundamental aspect that aids in understanding and communicating the system’s design, functionality, and workflow. This is where Draw.io (now known as diagrams.net) comes into play. A popular diagramming tool, Draw.io is flexible, integrates with several platforms, supports multiple formats, and can be self-hosted for enhanced control over your documentation infrastructure. In this article, we’ll explore how to use Draw.io for creating network diagrams and documentation, and we’ll also outline how to set it up using Docker Compose.

What is Draw.io?

Draw.io is an open-source diagramming tool that allows users to create a variety of diagrams including flowcharts, UML diagrams, mind maps, and particularly, network diagrams. Its intuitive interface and collaborative features make it an excellent choice for teams working in a DevOps environment, where documentation and real-time updates are crucial.

Features Highlight

• Integration: Seamlessly integrates with popular platforms like Google Drive, Dropbox, and GitHub.
• Collaborative: Offers real-time collaboration to enable multiple users to work on the same diagram.
• Flexibility: Users can create intricate diagrams with a vast array of customizable shapes and connectors.
• Open Source: Draw.io is free to use and can run on your own servers, ensuring your diagrams are private.

Creating Network Diagrams

Creating a network diagram is straightforward with Draw.io:

1. Access Draw.io: You can access Draw.io in your browser by visiting draw.io or by running it on your local server.

2. Choosing a Template: Upon launching, you can select from various templates or create a blank canvas. For network diagrams, look for network-specific templates to get started quickly.

3. Adding Shapes: Drag and drop network shapes such as routers, servers, firewalls, and more from the shapes sidebar. You can resize and customize them to represent your architecture accurately.

4. Connecting Entities: Use connectors to visualize the relationships and data flows between entities. They can be customized with arrows, colors, and labels for clarity.

5. Annotations: Add notes, labels, and more to make your diagram self-explanatory. This is vital for keeping your documentation clear.

6. Exporting Diagrams: Once completed, you can export your diagrams in various formats (PNG, SVG, PDF, or XML) for integration into documentation.

Running Draw.io Using Docker Compose

Self-hosting Draw.io allows you to maintain control over your data and facilitate collaboration among team members. Below are the steps to set it up using Docker Compose.

Prerequisites

Ensure Docker and Docker Compose are installed and running on your machine. You can use the following commands to check installation:

docker --version
docker-compose --version

Docker Compose Configuration

1. Create a directory for your Draw.io instance:

   mkdir drawio && cd drawio
   

2. Create a docker-compose.yml file:

   In your drawio directory, create a file named docker-compose.yml and add the following configuration:

   version: '3'
   services:
     drawio:
       image: jgraph/drawio
       ports:
         - "8080:80"
       volumes:
         - ./drawio-files:/drawio-files
       environment:
         - DRAWIO_USE_MERGE=true
   

   • This configuration defines a service named drawio that uses the official Draw.io image from jgraph.
   • It maps port 8080 on your host to port 80 of the container, allowing you to access Draw.io at http://localhost:8080.
   • It also creates a volume to persist your diagram files.

3. Start the Draw.io container:

   Run the following command to bring up your Draw.io service:

   docker-compose up -d
   

   The -d flag runs the containers in detached mode.

4. Access the Draw.io Interface:

   Open your web browser and navigate to http://localhost:8080 to access your self-hosted Draw.io instance.

5. Saving Your Work:

   An automatic file save option is available, or you can manually save your diagrams in the designated drawio-files volume.

Conclusion

Using Draw.io for drawing network diagrams and documentation not only boosts productivity but also enhances collaboration among team members in a DevOps environment. Its self-hosting capability through Docker ensures that your diagrams remain private and accessible. By following the outlined steps, teams can establish an effective documentation practice that supports agile development workflows and assists in conveying complex architecture in a simplified manner.

References

• Draw.io Official Documentation: https://www.diagrams.net/doc/
• Docker Documentation: https://docs.docker.com/
• Docker Compose Documentation: https://docs.docker.com/compose/

By leveraging these tools, DevOps engineers can create comprehensive and coherent network diagrams, crucial for understanding and maintaining complex systems.