From 4f14264d2387a92b4def3eb6d278da0d5c249d52 Mon Sep 17 00:00:00 2001 From: Thomas Hii Date: Mon, 15 Jul 2024 07:35:19 +0800 Subject: [PATCH] Updated docker deployment --- .gitignore | 1 - LICENSE | 2 +- README.md | 22 ++++---- {docker => doc/deployment/docker}/README.md | 50 ++++++++++--------- .../docker}/docker-compose-mariadb.yml | 4 +- .../docker}/docker-compose-mongo.yml | 4 +- .../docker}/docker-compose-mysql.yml | 4 +- .../deployment/docker}/docker-compose-pg.yml | 4 +- .../docker}/docker-compose-redis.yml | 4 +- .../docker}/docker-compose-rethinkdb.yml | 4 +- doc/{ => testing/performance}/README.md | 2 + 11 files changed, 50 insertions(+), 51 deletions(-) rename {docker => doc/deployment/docker}/README.md (51%) rename {docker => doc/deployment/docker}/docker-compose-mariadb.yml (91%) rename {docker => doc/deployment/docker}/docker-compose-mongo.yml (96%) rename {docker => doc/deployment/docker}/docker-compose-mysql.yml (90%) rename {docker => doc/deployment/docker}/docker-compose-pg.yml (95%) rename {docker => doc/deployment/docker}/docker-compose-redis.yml (91%) rename {docker => doc/deployment/docker}/docker-compose-rethinkdb.yml (90%) rename doc/{ => testing/performance}/README.md (78%) diff --git a/.gitignore b/.gitignore index a7d791f0..7078bdf0 100644 --- a/.gitignore +++ b/.gitignore @@ -73,6 +73,5 @@ fabric.properties logs/ .DS_Store server_log.txt -ormapp/ backup/ diff --git a/LICENSE b/LICENSE index df5e0635..c35606db 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ BSD 3-Clause License -Copyright (c) 2021, dukefirehawk.com +Copyright (c) 2024, dukefirehawk.com All rights reserved. Redistribution and use in source and binary forms, with or without diff --git a/README.md b/README.md index 2df56455..1a6fae60 100644 --- a/README.md +++ b/README.md @@ -60,7 +60,7 @@ For more details, checkout [Project Status](https://github.com/dart-backend/ange ### Release 9.0.0 (Future) * Performance optimsation -* Update and enhance ORM to support macro +* Update ORM to support macro ### Release 8.0.0 (Current) @@ -164,24 +164,20 @@ Check out [Migrating to Angel3](https://angel3-docs.dukefirehawk.com/migration/a The performance benchmark can be found at -[TechEmpower Framework Benchmarks Round 21](https://www.techempower.com/benchmarks/#section=data-r21&test=composite) +[TechEmpower Framework Benchmarks Round 22](https://www.techempower.com/benchmarks/#section=data-r22&test=composite) -The test cases are build using standard `Angel3 ORM` template. The result are used for fine-tuning Angel3 framework. The following test cases will be added in the upcoming update to the benchmark. +The test cases are build using standard `Angel3 ORM` template for PostgreSQL and MySQL database. The result are used for fine-tuning Angel3 framework with respect to other frameworks. The following test cases will be added in the upcoming update to the benchmark. -1. Cache +1. Cache with Redis 2. Angel3 with MongoDB ## Examples and Documentation -Visit the [User Guide](https://angel3-docs.dukefirehawk.com/) for dozens of guides and resources, including video tutorials, to get up and running as quickly as possible with Angel3 framework. - -Examples and complete projects can be found [here](https://github.com/dart-backend/angel3-examples). - -You can also view the [Angel3 API](http://www.dartdocs.org/documentation/angel_framework/latest). +Please visit our [User Guide](https://angel3-docs.dukefirehawk.com/) and [Examples](https://github.com/dart-backend/angel3-examples) for more detailed information on the available features of Angel3 framework. ## Contributing -Interested in contributing to Angel3? See the contribution guide [here](CONTRIBUTING.md). +If you are interested in contributing to Angel3 framework please check out the [Contribution Guide](CONTRIBUTING.md). ### Development Setup @@ -208,7 +204,7 @@ Interested in contributing to Angel3? See the contribution guide [here](CONTRIBU ## Donation & Support -If you like this project and interested in supporting its development, you can make a donation using the following services. +If you like this project and interested in supporting its development work, you are welcome to make a donation via the following links. -* [![GitHub](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/dukefirehawk) -* [paypal](https://paypal.me/dukefirehawk?country.x=MY&locale.x=en_US) service +* [![GitHub Sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/dukefirehawk) +* [Paypal Donation](https://paypal.me/dukefirehawk?country.x=MY&locale.x=en_US) diff --git a/docker/README.md b/doc/deployment/docker/README.md similarity index 51% rename from docker/README.md rename to doc/deployment/docker/README.md index 0ffa60df..8ee0e05a 100644 --- a/docker/README.md +++ b/doc/deployment/docker/README.md @@ -1,18 +1,20 @@ -# Docker setup +# Runing Ancillary Docker Services + +The required ancillary services required by the framework can be run using the compose files provided in this folder. ## PostreSQL ### Starting the PostreSQL container ```bash - docker compose -f docker-compose-pg.yml up -d + docker compose -f docker-compose-pg.yml -p pg up -d ``` ### Stopping the PostreSQL container ```bash - docker compose -f docker-compose-pg.yml stop - docker compose -f docker-compose-pg.yml down + docker compose -f docker-compose-pg.yml -p pg stop + docker compose -f docker-compose-pg.yml -p pg down ``` ### Checking the PostreSQL container log @@ -41,20 +43,20 @@ ### Starting the MariaDB container ```bash - docker compose -f docker-compose-mariadb.yml up -d + docker compose -f docker-compose-mariadb.yml -p maria up -d ``` ### Stopping the MariaDB container ```bash - docker compose -f docker-compose-mariadb.yml stop - docker compose -f docker-compose-mariadb.yml down + docker compose -f docker-compose-mariadb.yml -p maria stop + docker compose -f docker-compose-mariadb.yml -p maria down ``` ### Checking the MariaDB container log ```bash - docker logs docker-mariadb-1 -f + docker logs maria-mariadb-1 -f ``` ## MySQL @@ -62,20 +64,20 @@ ### Starting the MySQL container ```bash - docker compose -f docker-compose-mysql.yml up -d + docker compose -f docker-compose-mysql.yml -p mysql up -d ``` ### Stopping the MySQL container ```bash - docker compose -f docker-compose-mysql.yml stop - docker compose -f docker-compose-mysql.yml down + docker compose -f docker-compose-mysql.yml -p mysql stop + docker compose -f docker-compose-mysql.yml -p mysql down ``` ### Checking the MySQL container log ```bash - docker logs docker-mysql-1 -f + docker logs mysql-mysql-1 -f ``` ## MongoDB @@ -83,20 +85,20 @@ ### Starting the MongoDB container ```bash - docker compose -f docker-compose-mongo.yml up -d + docker compose -f docker-compose-mongo.yml -p mongo up -d ``` ### Stopping the MongoDB container ```bash - docker compose -f docker-compose-mongo.yml stop - docker compose -f docker-compose-mongo.yml down + docker compose -f docker-compose-mongo.yml -p mongo stop + docker compose -f docker-compose-mongo.yml -p mongo down ``` ### Checking the MongoDB container log ```bash - docker logs docker-mongo-1 -f + docker logs mongo-mongo-1 -f ``` ## rethinkDB @@ -104,20 +106,20 @@ ### Starting the rethinkDB container ```bash - docker compose -f docker-compose-rethinkdb.yml up -d + docker compose -f docker-compose-rethinkdb.yml -p rethink up -d ``` ### Stopping the rethinkDB container ```bash - docker compose -f docker-compose-rethinkdb.yml stop - docker compose -f docker-compose-rethinkdb.yml down + docker compose -f docker-compose-rethinkdb.yml -p rethink stop + docker compose -f docker-compose-rethinkdb.yml -p rethink down ``` ### Checking the rethinkDB container log ```bash - docker logs docker-rethinkdb-1 -f + docker logs rethink-rethinkdb-1 -f ``` ## Redis @@ -125,18 +127,18 @@ ### Starting the Redis container ```bash - docker compose -f docker-compose-redis.yml up -d + docker compose -f docker-compose-redis.yml -p redis up -d ``` ### Stopping the Redis container ```bash - docker compose -f docker-compose-redis.yml stop - docker compose -f docker-compose-redis.yml down + docker compose -f docker-compose-redis.yml -p redis stop + docker compose -f docker-compose-redis.yml -p redis down ``` ### Checking the Redis container log ```bash - docker logs docker-redis-1 -f + docker logs redis-redis-1 -f ``` diff --git a/docker/docker-compose-mariadb.yml b/doc/deployment/docker/docker-compose-mariadb.yml similarity index 91% rename from docker/docker-compose-mariadb.yml rename to doc/deployment/docker/docker-compose-mariadb.yml index e7c9a473..96539955 100644 --- a/docker/docker-compose-mariadb.yml +++ b/doc/deployment/docker/docker-compose-mariadb.yml @@ -9,11 +9,11 @@ services: volumes: - "mariadb:/var/lib/mysql" networks: - - webnet + - appnet volumes: mariadb: driver: local networks: - webnet: + appnet: diff --git a/docker/docker-compose-mongo.yml b/doc/deployment/docker/docker-compose-mongo.yml similarity index 96% rename from docker/docker-compose-mongo.yml rename to doc/deployment/docker/docker-compose-mongo.yml index 00034fcd..6e876e66 100644 --- a/docker/docker-compose-mongo.yml +++ b/doc/deployment/docker/docker-compose-mongo.yml @@ -12,7 +12,7 @@ services: volumes: - "mongo:/data/db" networks: - - webnet + - appnet mongo-express: image: mongo-express @@ -34,4 +34,4 @@ volumes: driver: local networks: - webnet: + appnet: diff --git a/docker/docker-compose-mysql.yml b/doc/deployment/docker/docker-compose-mysql.yml similarity index 90% rename from docker/docker-compose-mysql.yml rename to doc/deployment/docker/docker-compose-mysql.yml index 6d9fe5c0..90c187f0 100644 --- a/docker/docker-compose-mysql.yml +++ b/doc/deployment/docker/docker-compose-mysql.yml @@ -9,11 +9,11 @@ services: volumes: - "mysql:/var/lib/mysql" networks: - - webnet + - appnet volumes: mysql: driver: local networks: - webnet: + appnet: diff --git a/docker/docker-compose-pg.yml b/doc/deployment/docker/docker-compose-pg.yml similarity index 95% rename from docker/docker-compose-pg.yml rename to doc/deployment/docker/docker-compose-pg.yml index e8f588ae..b0e21a6b 100644 --- a/docker/docker-compose-pg.yml +++ b/doc/deployment/docker/docker-compose-pg.yml @@ -21,11 +21,11 @@ services: - PGADMIN_DEFAULT_EMAIL=admin@mydomain.com - PGADMIN_DEFAULT_PASSWORD=Qwerty networks: - - webnet + - appnet volumes: db: driver: local networks: - webnet: + appnet: diff --git a/docker/docker-compose-redis.yml b/doc/deployment/docker/docker-compose-redis.yml similarity index 91% rename from docker/docker-compose-redis.yml rename to doc/deployment/docker/docker-compose-redis.yml index 59cb46b4..e977709c 100644 --- a/docker/docker-compose-redis.yml +++ b/doc/deployment/docker/docker-compose-redis.yml @@ -10,11 +10,11 @@ services: volumes: - "redis:/data" networks: - - webnet + - appnet volumes: redis: driver: local networks: - webnet: + appnet: diff --git a/docker/docker-compose-rethinkdb.yml b/doc/deployment/docker/docker-compose-rethinkdb.yml similarity index 90% rename from docker/docker-compose-rethinkdb.yml rename to doc/deployment/docker/docker-compose-rethinkdb.yml index bd2ca5ce..693133b5 100644 --- a/docker/docker-compose-rethinkdb.yml +++ b/doc/deployment/docker/docker-compose-rethinkdb.yml @@ -9,11 +9,11 @@ services: volumes: - "rethinkdb:/data" networks: - - webnet + - appnet volumes: rethinkdb: driver: local networks: - webnet: + appnet: diff --git a/doc/README.md b/doc/testing/performance/README.md similarity index 78% rename from doc/README.md rename to doc/testing/performance/README.md index f143af7e..178c63ca 100644 --- a/doc/README.md +++ b/doc/testing/performance/README.md @@ -1,5 +1,7 @@ # Performance Testing +The performance test can be run with the following tools. + ## WRT ```bash