From 451cbdeffc7f251e71668f25c235e47a1e6ac488 Mon Sep 17 00:00:00 2001 From: Alfredo Oliviero Date: Wed, 30 Oct 2024 12:15:37 +0100 Subject: [PATCH] readme --- CHANGELOG.md | 10 ++ FUNDING.md | 28 ++++++ LICENSE.md | 270 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 200 +++++++++++++++++++++++++++++--------- 4 files changed, 463 insertions(+), 45 deletions(-) create mode 100644 CHANGELOG.md create mode 100644 FUNDING.md create mode 100644 LICENSE.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..18899ca --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,10 @@ + +# Changelog for Dockerized Keycloak + +All notable changes to this project will be documented in this file. +This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [v1.0.0] + +- first version + \ No newline at end of file diff --git a/FUNDING.md b/FUNDING.md new file mode 100644 index 0000000..80092f2 --- /dev/null +++ b/FUNDING.md @@ -0,0 +1,28 @@ +# Acknowledgments + +The projects leading to this software have received funding from a series of European Union programmes including: + +* the Sixth Framework Programme for Research and Technological Development + * [DILIGENT](https://cordis.europa.eu/project/id/004260) (grant no. 004260) + +* the Seventh Framework Programme for research, technological development and demonstration + * [D4Science](https://cordis.europa.eu/project/id/212488) (grant no. 212488) + * [D4Science-II](https://cordis.europa.eu/project/id/239019) (grant no.239019) + * [ENVRI](https://cordis.europa.eu/project/id/283465) (grant no. 283465) + * [iMarine](https://cordis.europa.eu/project/id/283644) (grant no. 283644) + * [EUBrazilOpenBio](https://cordis.europa.eu/project/id/288754) (grant no. 288754) + +* the H2020 research and innovation programme + * [SoBigData](https://cordis.europa.eu/project/id/654024) (grant no. 654024) + * [PARTHENOS](https://cordis.europa.eu/project/id/654119) (grant no. 654119) + * [EGI-Engage](https://cordis.europa.eu/project/id/654142) (grant no. 654142) + * [ENVRI PLUS](https://cordis.europa.eu/project/id/654182) (grant no. 654182) + * [BlueBRIDGE](https://cordis.europa.eu/project/id/675680) (grant no. 675680) + * [PerformFISH](https://cordis.europa.eu/project/id/727610) (grant no. 727610) + * [AGINFRA PLUS](https://cordis.europa.eu/project/id/731001) (grant no. 731001) + * [DESIRA](https://cordis.europa.eu/project/id/818194) (grant no. 818194) + * [ARIADNEplus](https://cordis.europa.eu/project/id/823914) (grant no. 823914) + * [RISIS 2](https://cordis.europa.eu/project/id/824091) (grant no. 824091) + * [EOSC-Pillar](https://cordis.europa.eu/project/id/857650) (grant no. 857650) + * [Blue Cloud](https://cordis.europa.eu/project/id/862409) (grant no. 862409) + * [SoBigData-PlusPlus](https://cordis.europa.eu/project/id/871042) (grant no. 871042) diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..0dd93ce --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,270 @@ +# European Union Public Licence V. 1.1 + +EUPL © the European Community 2007 + +This European Union Public Licence (the “EUPL”) applies to the Work or Software +(as defined below) which is provided under the terms of this Licence. Any use of +the Work, other than as authorised under this Licence is prohibited (to the +extent such use is covered by a right of the copyright holder of the Work). + +The Original Work is provided under the terms of this Licence when the Licensor +(as defined below) has placed the following notice immediately following the +copyright notice for the Original Work: + +Licensed under the EUPL V.1.1 + +or has expressed by any other mean his willingness to license under the EUPL. + +## 1. Definitions + +In this Licence, the following terms have the following meaning: + +* The Licence: this Licence. + +* The Original Work or the Software: the software distributed and/or + communicated by the Licensor under this Licence, available as Source Code and + also as Executable Code as the case may be. + +* Derivative Works: the works or software that could be created by the Licensee, + based upon the Original Work or modifications thereof. This Licence does not + define the extent of modification or dependence on the Original Work required + in order to classify a work as a Derivative Work; this extent is determined by + copyright law applicable in the country mentioned in Article 15. + +* The Work: the Original Work and/or its Derivative Works. + +* The Source Code: the human-readable form of the Work which is the most + convenient for people to study and modify. + +* The Executable Code: any code which has generally been compiled and which is + meant to be interpreted by a computer as a program. + +* The Licensor: the natural or legal person that distributes and/or communicates + the Work under the Licence. + +* Contributor(s): any natural or legal person who modifies the Work under the + Licence, or otherwise contributes to the creation of a Derivative Work. + +* The Licensee or “You”: any natural or legal person who makes any usage of the + Software under the terms of the Licence. + +* Distribution and/or Communication: any act of selling, giving, lending, + renting, distributing, communicating, transmitting, or otherwise making + available, on-line or off-line, copies of the Work or providing access to its + essential functionalities at the disposal of any other natural or legal + person. + +## 2. Scope of the rights granted by the Licence + +The Licensor hereby grants You a world-wide, royalty-free, non-exclusive, +sub-licensable licence to do the following, for the duration of copyright vested +in the Original Work: + +* use the Work in any circumstance and for all usage, reproduce the Work, modify +* the Original Work, and make Derivative Works based upon the Work, communicate +* to the public, including the right to make available or display the Work or +* copies thereof to the public and perform publicly, as the case may be, the +* Work, distribute the Work or copies thereof, lend and rent the Work or copies +* thereof, sub-license rights in the Work or copies thereof. + +Those rights can be exercised on any media, supports and formats, whether now +known or later invented, as far as the applicable law permits so. + +In the countries where moral rights apply, the Licensor waives his right to +exercise his moral right to the extent allowed by law in order to make effective +the licence of the economic rights here above listed. + +The Licensor grants to the Licensee royalty-free, non exclusive usage rights to +any patents held by the Licensor, to the extent necessary to make use of the +rights granted on the Work under this Licence. + +## 3. Communication of the Source Code + +The Licensor may provide the Work either in its Source Code form, or as +Executable Code. If the Work is provided as Executable Code, the Licensor +provides in addition a machine-readable copy of the Source Code of the Work +along with each copy of the Work that the Licensor distributes or indicates, in +a notice following the copyright notice attached to the Work, a repository where +the Source Code is easily and freely accessible for as long as the Licensor +continues to distribute and/or communicate the Work. + +## 4. Limitations on copyright + +Nothing in this Licence is intended to deprive the Licensee of the benefits from +any exception or limitation to the exclusive rights of the rights owners in the +Original Work or Software, of the exhaustion of those rights or of other +applicable limitations thereto. + +## 5. Obligations of the Licensee + +The grant of the rights mentioned above is subject to some restrictions and +obligations imposed on the Licensee. Those obligations are the following: + +Attribution right: the Licensee shall keep intact all copyright, patent or +trademarks notices and all notices that refer to the Licence and to the +disclaimer of warranties. The Licensee must include a copy of such notices and a +copy of the Licence with every copy of the Work he/she distributes and/or +communicates. The Licensee must cause any Derivative Work to carry prominent +notices stating that the Work has been modified and the date of modification. + +Copyleft clause: If the Licensee distributes and/or communicates copies of the +Original Works or Derivative Works based upon the Original Work, this +Distribution and/or Communication will be done under the terms of this Licence +or of a later version of this Licence unless the Original Work is expressly +distributed only under this version of the Licence. The Licensee (becoming +Licensor) cannot offer or impose any additional terms or conditions on the Work +or Derivative Work that alter or restrict the terms of the Licence. + +Compatibility clause: If the Licensee Distributes and/or Communicates Derivative +Works or copies thereof based upon both the Original Work and another work +licensed under a Compatible Licence, this Distribution and/or Communication can +be done under the terms of this Compatible Licence. For the sake of this clause, +“Compatible Licence” refers to the licences listed in the appendix attached to +this Licence. Should the Licensee’s obligations under the Compatible Licence +conflict with his/her obligations under this Licence, the obligations of the +Compatible Licence shall prevail. + +Provision of Source Code: When distributing and/or communicating copies of the +Work, the Licensee will provide a machine-readable copy of the Source Code or +indicate a repository where this Source will be easily and freely available for +as long as the Licensee continues to distribute and/or communicate the Work. + +Legal Protection: This Licence does not grant permission to use the trade names, +trademarks, service marks, or names of the Licensor, except as required for +reasonable and customary use in describing the origin of the Work and +reproducing the content of the copyright notice. + +## 6. Chain of Authorship + +The original Licensor warrants that the copyright in the Original Work granted +hereunder is owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each Contributor warrants that the copyright in the modifications he/she brings +to the Work are owned by him/her or licensed to him/her and that he/she has the +power and authority to grant the Licence. + +Each time You accept the Licence, the original Licensor and subsequent +Contributors grant You a licence to their contributions to the Work, under the +terms of this Licence. + +## 7. Disclaimer of Warranty + +The Work is a work in progress, which is continuously improved by numerous +contributors. It is not a finished work and may therefore contain defects or +“bugs” inherent to this type of software development. + +For the above reason, the Work is provided under the Licence on an “as is” basis +and without warranties of any kind concerning the Work, including without +limitation merchantability, fitness for a particular purpose, absence of defects +or errors, accuracy, non-infringement of intellectual property rights other than +copyright as stated in Article 6 of this Licence. + +This disclaimer of warranty is an essential part of the Licence and a condition +for the grant of any rights to the Work. + +## 8. Disclaimer of Liability + +Except in the cases of wilful misconduct or damages directly caused to natural +persons, the Licensor will in no event be liable for any direct or indirect, +material or moral, damages of any kind, arising out of the Licence or of the use +of the Work, including without limitation, damages for loss of goodwill, work +stoppage, computer failure or malfunction, loss of data or any commercial +damage, even if the Licensor has been advised of the possibility of such +damage. However, the Licensor will be liable under statutory product liability +laws as far such laws apply to the Work. + +## 9. Additional agreements + +While distributing the Original Work or Derivative Works, You may choose to +conclude an additional agreement to offer, and charge a fee for, acceptance of +support, warranty, indemnity, or other liability obligations and/or services +consistent with this Licence. However, in accepting such obligations, You may +act only on your own behalf and on your sole responsibility, not on behalf of +the original Licensor or any other Contributor, and only if You agree to +indemnify, defend, and hold each Contributor harmless for any liability incurred +by, or claims asserted against such Contributor by the fact You have accepted +any such warranty or additional liability. + +## 10. Acceptance of the Licence + +The provisions of this Licence can be accepted by clicking on an icon “I agree” +placed under the bottom of a window displaying the text of this Licence or by +affirming consent in any other similar way, in accordance with the rules of +applicable law. Clicking on that icon indicates your clear and irrevocable +acceptance of this Licence and all of its terms and conditions. + +Similarly, you irrevocably accept this Licence and all of its terms and +conditions by exercising any rights granted to You by Article 2 of this Licence, +such as the use of the Work, the creation by You of a Derivative Work or the +Distribution and/or Communication by You of the Work or copies thereof. + +## 11. Information to the public + +In case of any Distribution and/or Communication of the Work by means of +electronic communication by You (for example, by offering to download the Work +from a remote location) the distribution channel or media (for example, a +website) must at least provide to the public the information requested by the +applicable law regarding the Licensor, the Licence and the way it may be +accessible, concluded, stored and reproduced by the Licensee. + +## 12. Termination of the Licence + +The Licence and the rights granted hereunder will terminate automatically upon +any breach by the Licensee of the terms of the Licence. + +Such a termination will not terminate the licences of any person who has +received the Work from the Licensee under the Licence, provided such persons +remain in full compliance with the Licence. + +## 13. Miscellaneous + +Without prejudice of Article 9 above, the Licence represents the complete +agreement between the Parties as to the Work licensed hereunder. + +If any provision of the Licence is invalid or unenforceable under applicable +law, this will not affect the validity or enforceability of the Licence as a +whole. Such provision will be construed and/or reformed so as necessary to make +it valid and enforceable. + +The European Commission may publish other linguistic versions and/or new +versions of this Licence, so far this is required and reasonable, without +reducing the scope of the rights granted by the Licence. New versions of the +Licence will be published with a unique version number. + +All linguistic versions of this Licence, approved by the European Commission, +have identical value. Parties can take advantage of the linguistic version of +their choice. + +## 14. Jurisdiction + +Any litigation resulting from the interpretation of this License, arising +between the European Commission, as a Licensor, and any Licensee, will be +subject to the jurisdiction of the Court of Justice of the European Communities, +as laid down in article 238 of the Treaty establishing the European Community. + +Any litigation arising between Parties, other than the European Commission, and +resulting from the interpretation of this License, will be subject to the +exclusive jurisdiction of the competent court where the Licensor resides or +conducts its primary business. + +## 15. Applicable Law + +This Licence shall be governed by the law of the European Union country where +the Licensor resides or has his registered office. + +This licence shall be governed by the Belgian law if: + +* a litigation arises between the European Commission, as a Licensor, and any +* Licensee; the Licensor, other than the European Commission, has no residence +* or registered office inside a European Union country. + +## Appendix + +“Compatible Licences” according to article 5 EUPL are: + +* GNU General Public License (GNU GPL) v. 2 +* Open Software License (OSL) v. 2.1, v. 3.0 +* Common Public License v. 1.0 +* Eclipse Public License v. 1.0 +* Cecill v. 2.0 diff --git a/README.md b/README.md index b40943b..554c802 100644 --- a/README.md +++ b/README.md @@ -1,76 +1,186 @@ -# Dockerizing D4SCIENCE +# gCube System - Dockerized D4Science -## subprojects: +## Version + +version `v1.0.0` + +## Structure of the project + +This project provides a containerized environment for two primary services: `socialservice` and `liferay`, each supported by its specific infrastructure. The configuration allows the two infrastructures to be launched independently or together, and services can be started individually if desired. + +## Built With + +Docker + +## Documentation + +### GIT + +the first time you check-out a repo you need to use --init +`git submodule update --init --recursive` + +the other times +`git pull --recurse-submodules` + +### Services + +* **socialservice**: Located in `socialservice/`, this includes configurations and Docker setups for deploying a custom social networking service. It depends on Cassandra and Keycloak to handle database storage and identity management, respectively. * [cassandra](./cassandra/README.md) * [socialservice](./socialservice/README.md) -the first time you check-out a repo you need to use --init -`git submodule update --init --recursive` +docker commands: -the other times +`docker compose up cassandra1 cassandra2 cassandra3 socialservice --build --force-recreate -d` +`docker compose stop cassandra1 cassandra2 cassandra3 socialservice` -`git pull --recurse-submodules` +* **liferay**: The `liferay/` directory contains all configurations and Dockerfiles required to deploy the Liferay content management platform, along with its supporting infrastructure like PostgreSQL. +* [postgres](./postgres/README.md) +* [keycloak](./keycloak/README.md) +* [liferay](./liferay/README.md) +docker commands: -### cassandra +`docker compose up postgres keycloak liferay --build --force-recreate -d` +`docker compose stop postgres keycloak liferay` -[cassandra](./cassandra/README.md) is the dockerization of the cassandra infrastructure -it contains the script for dumping the devel environment, and the [Dockerfile](./cassandra/Dockerfile) and [Docker compose](./cassandra/compose.yaml) files to build and start the composed instance with the dumped schema and data - -### socialservice -[socialservice](./socialservice/README.md) is the dockerization of the socialservice infrastructure -it contains the script for dumping the devel environment, and the [Dockerfile](./socialservice/Dockerfile) and [Docker compose](./socialservice/compose.yaml) files to build and start the composed instance with the dumped schema and data - - -## DOCKER instructions +### Docker compose instructions you can start the 2 services individually entering in the folder and starting the docker compose instance, or start the common compose in the base folder. -start common composer: -`docker compose up --build` +```bash +docker compose -f compose.yml up -d # Start +docker compose -f compose.yml build # Build +docker compose -f compose.yml stop # Stop +docker compose -f compose.yml down # Destroy +docker compose -f compose.yml ps # Check Status +``` -force recreate docker image +start common composer: +`docker compose up -d` + +force recreate docker image: `docker compose build --no-cache` -check status: -`docker exec -it cassandra1 nodetool status` -`docker exec -it cassandra2 nodetool status` -`docker exec -it cassandra3 nodetool status` -`docker exec -it social nodetool status` +you can force the build and/or reload: +`docker compose up --build --force-reloads -d` -## LIFERAY -aggiunto a /etc/host l'entry: +check status: -127.0.0.1 keycloak -127.0.0.1 liferay - -keycloak server: http://keycloak:9999 - -liferay server: -* http://liferay:80 -* http://next.dev.d4science.org:80 - -start composer: -`docker compose up --build` - -check keycloak status: * postgres: `docker inspect --format='{{json .State.Health}}' lr_docker-postgres-1` * keycloak: `docker inspect --format='{{json .State.Health}}' lr_docker-keycloak-1` * liferay: `docker inspect --format='{{json .State.Health}}' lr_docker-liferay-1` -run a single service: -* postgres: `docker compose up postgres --build` -* keycloak: `docker compose up keycloak --build` -* liferay: `docker compose up liferay --build` +* socialservice: `docker inspect --format='{{json .State.Health}}' lr_docker-socialservice` -open bash on server +* cassandara1: `docker inspect --format='{{json .State.Health}}' cassandra1` +* cassandara2: `docker inspect --format='{{json .State.Health}}' cassandra2` +* cassandara3: `docker inspect --format='{{json .State.Health}}' cassandra3` + +open bash in instance: * postgres: `docker exec -it lr_docker-postgres-1 /bin/sh` * keycloak: `docker exec -it lr_docker-keycloak-1 /bin/sh` * liferay: `docker exec -it lr_docker-liferay-1 /bin/sh` +* socialservice: `docker exec -it lr_docker socialservice /bin/sh` + +* cassandra1: `docker exec -it lr_docker cassandra1 /bin/sh` +* cassandra2: `docker exec -it lr_docker cassandra2 /bin/sh` +* cassandra3: `docker exec -it lr_docker cassandra3 /bin/sh` + +#### All services + +`docker compose up --build *d` +`docker compose stop` + +#### Social Service + +`docker compose up cassandra1 cassandra2 cassandra3 socialservice --build *d` +`docker compose stop cassandra1 cassandra2 cassandra3 socialservice` + +### Liferay service + +`docker compose up postgres keycloak liferay --build *d` +`docker compose stop postgres keycloak liferay` + +### Single components + +#### cassandra + +[cassandra](./cassandra/README.md) is the dockerization of the cassandra infrastructure +it contains the script for dumping the devel environment, and the [Dockerfile](./cassandra/Dockerfile) and [Docker compose](./cassandra/compose.yaml) files to build and start the composed instance with the dumped schema and data + +`docker compose up cassandra1 cassandra2 cassandra3 --build *d` +`docker compose stop cassandra1 cassandra2 cassandra3` + +check status: + +* cassandara1 + * `docker inspect --format='{{json .State.Health}}' cassandra1` + * `docker exec -it cassandra1 nodetool status` + +* cassandara2 + * `docker inspect --format='{{json .State.Health}}' cassandra2` + * `docker exec -it cassandra1 nodetool status` + +* cassandara3 + * `docker inspect --format='{{json .State.Health}}' cassandra3` + * `docker exec -it cassandra1 nodetool status` + +#### socialservice + +[socialservice](./socialservice/README.md) is the dockerization of the socialservice infrastructure +it contains the script for dumping the devel environment, and the [Dockerfile](./socialservice/Dockerfile) and [Docker compose](./socialservice/compose.yaml) files to build and start the composed instance with the dumped schema and data + +#### Keycloak + +[keycloack](./keycloack/README.md) is the dockerization of the keycloack authentication services. it contains the [Dockerfile](./socialservice/Dockerfile) and [Docker compose](./socialservice/compose.yaml) files to build and start the composed instance with the d4science.json data + +### Liferay + +to exec the liferay instance you need to to your host file (`/etc/host`) the entries: + +```txt +127.0.0.1 keycloak +127.0.0.1 liferay +``` + +keycloak server: http://keycloak:9999 + +liferay server: + +* http://liferay:80 +* http://next.dev.d4science.org:80 + +open bash on server + check db connection: -docker exec -it lr_docker-liferay-1 bash -c 'PGPASSWORD=pass_db psql -h lr_docker-postgres-1 -U infra_bundle_dev -d liferay_db' +`docker exec -it lr_docker-liferay-1 bash -c 'PGPASSWORD=pass_db psql -h lr_docker-postgres-1 -U infra_bundle_dev -d liferay_db'` + +## Change log + +See [Releases](https://code-repo.d4science.org/gCubeSystem/${project.artifactId}/releases). + +## Authors + +* **Alfredo Oliviero** ([ORCID]( https://orcid.org/0009-0007-3191-1025)) - [ISTI-CNR Infrascience Group](https://www.isti.cnr.it/People/A.Oliviero) + +## Maintainers + +* **Alfredo Oliviero** ([ORCID]( https://orcid.org/0009-0007-3191-1025)) - [ISTI-CNR Infrascience Group](https://www.isti.cnr.it/People/A.Oliviero) + +## License + +This project is licensed under the EUPL V.1.1 License - see the [LICENSE.md](LICENSE.md) file for details. + +## About the gCube Framework + +This software is part of the [gCubeFramework](https://www.gcube-system.org/ "gCubeFramework"): an +open-source software toolkit used for building and operating Hybrid Data +Infrastructures enabling the dynamic deployment of Virtual Research Environments +by favouring the realisation of reuse oriented policies. + +The projects leading to this software have received funding from a series of European Union programmes see [FUNDING.md](FUNDING.md)