Provide Architecture overview in README

This commit is contained in:
cytopia 2019-02-27 12:45:35 +01:00
parent 5343cabcdc
commit 7aaa6d3ea6
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
5 changed files with 40 additions and 9 deletions

View File

@ -5,7 +5,7 @@
![Devilbox](docs/img/banner.png)
**[Usage](#usage)** |
**[Available Container](#available-container)** |
**[Architecture](#architecture)** |
**[Community](#community)** |
**[Features](#feature-overview)** |
**[Intranet](#intranet-overview)** |
@ -56,16 +56,36 @@ Before updating the Devilbox ensure to always check for breaking changes until t
2. [Changelog](CHANGELOG.md)
3. [Updating](UPDATING.md)
## Available Container
The Devilbox ships the following pre-configured Docker container in any available version.
## Architecture
| Accel | Frontend | SQL | NoSQL | Queue & Search | ELK | Misc |
|---------|------------|------------|-----------|----------------|---------------|-----------|
| Varnish | Apache | MariaDB | Memcached | RabbitMQ | ElasticSearch | Bind |
| | Nginx | MySQL | MongoDB | Solr | Logstash | Blackfire |
| | PHP | PerconaDB | Redis | | Kibana | MailHog |
| | | PostgreSQL | | | | |
The Devilbox aims to be a swiss army knife for local development by providing you all the services
you would ever need. To get an idea about the architecture behind it and to also see what's available
have a look at the following diagrams and tables.
#### Smallest Stack
This is the smallest possible and fully functional stack you can run:
![Devilbox Stack](docs/img/devilbox-stack-smallest.svg)
#### Full Stack
To better understand what is actually possible have a look at the full example:
![Devilbox Stack](docs/img/devilbox-stack-full.svg)
#### Available Container
The following table lists all integrated and pre-configured Docker container shipped by the Devilbox.
Only the webserver and PHP container are mandatory, all others are optional and don't need to be started.
Each of them is also available in multiple different versions in order to reflect your exact desired environment.
| Accel | Frontend | SQL | NoSQL | Queue | Search | ELK | Utils |
|---------|------------|------------|-----------|----------|--------|---------------|-----------|
| HAProxy | Apache | MariaDB | Memcached | RabbitMQ | Solr | ElasticSearch | Bind |
| Varnish | Nginx | MySQL | MongoDB | | | Logstash | Blackfire |
| | PHP | PerconaDB | Redis | | | Kibana | MailHog |
| | | PostgreSQL | | | | | |
> **Documentation:**
> [Available Container](https://devilbox.readthedocs.io/en/latest/readings/available-container.html)
@ -342,6 +362,7 @@ Additionally to the default stack, there are a variety of other services that ca
<th>MailHog</th>
<th>RabbitMQ</th>
<th>Solr</th>
<th>HAProxy</th>
<th>Varnish</th>
</tr>
</thead>
@ -352,6 +373,7 @@ Additionally to the default stack, there are a variety of other services that ca
<td><a target="_blank" title="MailHog v1.0.0" href="https://github.com/mailhog/MailHog">v1.0.0</a></td>
<td><a target="_blank" title="RabbitMQ 3.6" href="https://github.com/rabbitmq/rabbitmq-server">3.6</a></td>
<td><a target="_blank" title="Solr 5" href="https://github.com/apache/lucene-solr">5</a></td>
<td><a target="_blank" title="HAProxy 1.X" href="https://github.com/devilbox/docker-haproxy">1.X</a></td>
<td><a target="_blank" title="Varnish 4" href="https://github.com/devilbox/docker-varnish">4</a></td>
</tr>
<tr>
@ -360,6 +382,7 @@ Additionally to the default stack, there are a variety of other services that ca
<td><a target="_blank" title="MailHog latest" href="https://github.com/mailhog/MailHog">latest</a></td>
<td><a target="_blank" title="RabbitMQ 3.7" href="https://github.com/rabbitmq/rabbitmq-server">3.7</a></td>
<td><a target="_blank" title="Solr 6" href="https://github.com/apache/lucene-solr">6</a></td>
<td></td>
<td><a target="_blank" title="Varnish 5" href="https://github.com/devilbox/docker-varnish">5</a></td>
</tr>
<tr>
@ -368,6 +391,7 @@ Additionally to the default stack, there are a variety of other services that ca
<td></td>
<td><a target="_blank" title="RabbitMQ latest" href="https://github.com/rabbitmq/rabbitmq-server">latest</a></td>
<td><a target="_blank" title="Solr 7" href="https://github.com/apache/lucene-solr">7</a></td>
<td></td>
<td><a target="_blank" title="Varnish 6" href="https://github.com/devilbox/docker-varnish">6</a></td>
</tr>
<tr>
@ -376,6 +400,7 @@ Additionally to the default stack, there are a variety of other services that ca
<td></td>
<td></td>
<td><a target="_blank" title="Solr latest" href="https://github.com/apache/lucene-solr">latest</a></td>
<td></td>
<td><a target="_blank" title="Varnish latest" href="https://github.com/devilbox/docker-varnish">latest</a></td>
</tr>
</tbody>

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 2.4 MiB

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 252 KiB

View File

@ -0,0 +1 @@
<mxfile modified="2019-02-22T12:58:52.172Z" host="www.draw.io" agent="Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/72.0.3626.53 Safari/537.36" etag="ZvmySbrHPPbnlbQEPd8v" version="10.2.6" type="device"><diagram id="OTD98s_6kQtwCJCfU0HE" name="Page-1">3VpRd6I4FP41PpYDIQg+qtX2nO3Ocbed2ZknD0KEnEHCQqi6v34TCAiEKnbE2ulDJffCxXzfzZfcxIE+3eweYjvy/yQuCgZAdXcD/X4AALBM9p8b9rlBM4zc4MXYFaaD4Rn/h4RRFdYUuyip3UgJCSiO6kaHhCFyaM1mxzHZ1m9bk6D+1sj2kGR4duxAtv6DXeoL69CAB8cjwp5fvFobjnLPxi7uFl1JfNsl24pJnw30aUwIza82uykKOHgFMPlz8ze85TeLUUi7PICWw6+zP548OgundP/30iO+eqfnUV7tIBU9Fl+W7gsIYpKGLuJBtIE+2fqYoufIdrh3yzhnNp9uAuFe4yCYkoDE2bP62nKQ4zB7QmPyE1U8K8uAhso8cjdEz15RTNGuYhLdekBkg2i8Z7cIL9QFxPsi60R7W6FMFTa/yhYQ2WiLNPHK2Acg2YXA8gxctX5xdW1krVtxHToWWq0vgysYjW4OV310GlmPQRt173+pHvaqiKAexUVXLcWoIaNDQ0LGagEGqr3hMrxwxsn4nSDkdFp9HDjmaXCYPEf8Em+yKWGSfY6TKJ9VuFLZRWONdxzFCe8yZnPFk71CwYIkmGISMv+KUEo2lRvGAfa4g5KoiMxaPqV8FhvzzoG544aKnVJfVRz2LJivAuKxj9DD4e4uCtKkbDAHUaLQ64ck4R02MtyU8hsMZQoLWw8UWhKFXzgaEo+sf7SeyXWNDEmIGoIqTLZgyWFgoriFvg12Xf6a1qFzGFzts9qliNFBg5mRxAxsGVygt8FVvO22FBmMrI9WZPBBilwScsuKDG9fkRGjhiHo+EKRt9EdS0vK0QfzNAqI7XJRBqrGxHGusnE4txl5PnqPQp9BmvAajYwvFbuq0WaLEpi9kWpIpI4zQD65SJ/Pja7emEib8vR5dZGGsF6m6UAuJyzjmipkdigmepHoko4blmirw7x+PYleM+UV20MaaEh2qdh8zcw0AyVKaLMwSohoLtCGpmnWkuvTnITBPl1qEJoWUFVTAxrc4pEzWS6+PDD34nGRy3fy6p0p4WeQWkj4KY1oW2JDxbB647xt32IYUEFAjfzhvykpHHdJRg2jQdVgtDs42ZXHP78rP4pA7JvlsXLPJ58bzicdftTMQMOv30Z/zeNvu3SkzZ6ms/Uj6bJRxdZBY76VygdpQJyfLz4OG7tTjcHJnpjjoPCiHabfOazKiC3K8/aPrA11XbTvdwL3rLGvNBYoxqyrnM/cFrJu5+FUFRSGIh4sDIeAWWtfbTVDvjnnJSSNHXSM/vw+asceOpYmYpsVubXd5qNib7RkQWGLUWBT/Frfo25LDfGGBcHZ4C1qe6gphqlBNttm/836tGxYilVxj+rhc0xExEPySS9pbsrqeuN75qBJgbIsLiF5f2J3qL5+NbHfzJsb4bnkrmRWfSeXqno8UN9cdtjcLJYi6wDtBKuTCsFOYCcJzrfM7ZjK5jfnmwFbzWd/jXz4DBkAmsQ1l4tdM0A/FajnDIAdDqr6rl/YAry57W/IJXcbmwD2NHvDDiqXwyJyV5hVGabjsL8fvI+CRu+QMeWRLB/brp345fLv1OozaFQv0pLzzPKGpDTAIXtLcYyttq1nC43b7Dx+2q6Q9Ro7SEmQk8aY7hU+iS2jmFAWIyu2GseG5nwyhqCTjh1Pt7PKVq2lptdGign6Yl6eLR5fXhbPEv23UWlUuLAaw7TljP9XeSm8dTmHkoxdtQiBHXaDr6DudW03Wyqztu3UCxx1t4PSoTR7A5TjIF9Ey68KRcfTgt9Py9PwiJrfj6HKVsaymkt7bl0zpPsvRKryDtuUQgF6X8kgnzJwef+N1f3sH+7UC3p5jXohcWfNw8/X8pX+4UeA+ux/</diagram></mxfile>