Code Monkey home page Code Monkey logo

diagrams's Introduction

diagrams logo

Diagrams for Open Telekom Cloud

license pypi version python version

Diagram as Code.

Important

Due to the fact that the upstream project seems to be inactive and non-processing/non-responsive to new Issues or Pull Requests for more than 2 years, the artifacts supporting Open Telekom Cloud has been moved to their own package. Nevertheless, the repository retains its downstream status and any change that might come in the future either in the other providers artifacts or in the code itself, will be synced. Unless nothing changes, the package name in PyPi is from now on diagrams-otc.

Diagrams lets you draw the cloud system architecture in Python code. It was born for prototyping a new system architecture design without any design tools. You can also describe or visualize the existing system architecture as well. Diagrams currently supports main major providers including: AWS, Azure, GCP, Kubernetes, Alibaba Cloud, Oracle Cloud etc... It also supports On-Premise nodes, SaaS and major Programming frameworks and languages.

Diagram as Code also allows you to track the architecture diagram changes in any version control system.

Note

It does not control any actual cloud resources nor does it generate cloud formation or terraform code. It is just for drawing the cloud system architecture diagrams.

Providers

Open Telekom Cloud

in addition supports all the providers included in the original upstream:

aws provider azure provider gcp provider ibm provider kubernetes provider alibaba cloud provider oracle cloud provider openstack provider firebase provider digital ocean provider elastic provider outscale provider on premise provider generic provider programming provider saas provider c4 provider

Getting Started

It requires Python 3.7 or higher, check your Python version first.

It uses Graphviz to render the diagram, so you need to install Graphviz to use diagrams. After installing graphviz (or already have it), install the diagrams.

Tip

You can quickly install Graphviz either via pip: pip install graphviz (recommended) or via brew: brew install graphviz

Install the Diagrams for Open Telekom Cloud directly from Pypi choosing one of the following methods:

# using pip (pip3)
$ pip install diagrams-otc

# using pipenv
$ pipenv install diagrams-otc

# using poetry
$ poetry add diagrams-otc

and then you are ready to try your very first OTC diagram by executing the Python code below:

from diagrams import Diagram, Cluster
from diagrams.opentelekomcloud.computing import Ecs
from diagrams.opentelekomcloud.database import Rds
from diagrams.opentelekomcloud.network import Elb, Dns, Eip

with Diagram("Basic Web App", show=False):
    dns = Dns("dns")
    eip = Eip("eip")

    dns >> eip

    with Cluster("vpc"):
        elb = Elb("dns")

        with Cluster("app-subnet"):
            app = [Ecs("app1"),
            Ecs("app2")]

        with Cluster("db-subnet"):
            db_primary = Rds("primary")
            db_primary - [Rds("replica1"),
                        Rds("replica2")]

    eip >> elb >> app >> db_primary

save it in a python file, e.g. diagram.py and execute it with the following command:

python diagram.py

which will generate an diagram in PNG format:

Basic Web App

The list Open Telekom Cloud services currently supported can be found here.

Examples

Note

The rest of the documentation and examples refer to the original upstream site as is.

You can start with quick start. Check out guides for more details, and you can find all available nodes list in here.

Event Processing Stateful Architecture Advanced Web Service
event processing stateful architecture advanced web service with on-premise

You can find all the examples on the examples page.

Contributing

To contribute to Diagrams by adding a new provider or additional Open Telekom Cloud services, check out contribution guidelines.

Other languages

If you are familiar with Go, you can use go-diagrams as well.

diagrams's People

Contributors

mingrammer avatar gabriel-tessier avatar akyriako avatar dependabot[bot] avatar nlamirault avatar yu-iskw avatar guyzyl avatar leandrodamascena avatar bdsoha avatar slach avatar outscale-mgo avatar hagaishapira avatar meshuga avatar pyaillet avatar ryanmillerc avatar timgates42 avatar viicos avatar lrjball avatar rajat404 avatar avanier avatar zendern avatar chewrocca avatar lucianf avatar deogracia avatar fabriziofortino avatar ewinnington avatar cclauss avatar mandalae avatar lazzurs avatar rcheese avatar

Stargazers

 avatar Jim (Dimitrios) Andrakakis avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.