trustchain-oc1-orchestral
/
idhub-docker
Archived
10
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
idhub-docker/README.md

65 lines
2.6 KiB
Markdown
Raw Normal View History

README: capital title
2024-01-23 20:33:35 +00:00
# Docker deployment of IdHub and tools
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
## About the pilots that this repository deploys
idhub docker temp because of WIP on sso branches errors for musician and orchestra and final verification for devicehub only idhub is working
2023-10-31 10:00:08 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
- xo9b:
- motivation: one idhub connects to the other using OIDC4VP flow
- components: idhub1, idhub2
- setem:
- motivation: a user from org 1 connects to org 2 to get a discount code
- components: idhub1, idhub2
- lafede:
- motivatiion: a user gets a verifiable credential presentation from idhub, optionally could be signed also using EIDAS1
- components: idhub1
- pangea:
- motivation:
- a user from org 1 connects to org 1 services
- a user from org 1 connects to org 2 services
- components: idhub1, idhub2, goauthentik services, orchestra (with also nginx api rproxy), musician
- test: intended for software quality such as testing, CI/CD, etc.
idhub: better README.md
2023-11-03 09:16:42 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
## Installation
idhub: better README.md
2023-11-03 09:16:42 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
Considering debian stable distribution (Debian 12 bookworm)
idhub docker temp because of WIP on sso branches errors for musician and orchestra and final verification for devicehub only idhub is working
2023-10-31 10:00:08 +00:00
README: update docker install
2024-01-23 20:32:01 +00:00
- docker: [install using the convenience script](https://docs.docker.com/engine/install/debian/#install-using-the-convenience-script)
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
- make: some of the actions are declared in `Makefile`, you will need `sudo apt install make`.
- figlet: display large texts, better visibility when running all the pilots together `sudo apt install figlet`.
idhub docker temp because of WIP on sso branches errors for musician and orchestra and final verification for devicehub only idhub is working
2023-10-31 10:00:08 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
## Deployment
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
Execute `./build__all.sh` to run all the pilots, that includes building locally all the docker images and deploying its docker compose (each pilot has its `docker-compose__pilot-example.yml`).
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
Or run a specific pilot with `./build__pilot-example.sh`.
All the scripts are written in POSIX Shell. I hope they are easy enough and structured to be adapted to your needs.
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
## Development
You can use these docker images for developing the software. This repo is targeted on integrating, deploying and testing the IdHub tools. You can do the same with the other tools, the trick used is to override the docker's directory with a local directory. Example found on all pilots instances
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
README: specify lang for src blocks
2024-01-23 20:32:41 +00:00
```yaml
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
volumes:
- ./idhub1__pilot-example:/opt/idhub
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
```
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
If you are developing IdHub, all the instances generate a copy of the target repository such as `idhub1__pilot-example`, which you can modify there, and the changes will apply to the deployment
In the `.env` there are some variables intended to be used for debugging purposes
### Commands that you might like
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
if you want to enter a shell inside a new container:
README: specify lang for src blocks
2024-01-23 20:32:41 +00:00
```sh
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
docker run -it --entrypoint= ${target_docker_image} bash
```
if you want to enter a shell on already running container:
README: specify lang for src blocks
2024-01-23 20:32:41 +00:00
```sh
init with previous work this repo is a reinitialization with a change in the concept previous repo had git subtree of django-musician and django-orchestra, that was too static for our interest next approach is a script that pulls git repos, and that would be needed if you want to build everything, if not, just with the docker compose you would have enough for running the containers, hence, downloading the images from the docker registry
2023-10-10 08:07:46 +00:00
docker exec -it ${target_docker_image} bash
```
general README update maybe it needs a review
2024-01-23 20:30:22 +00:00
Where `target_docker_image` contains the ID of the container you want to run (see `docker ps` or `docker ps -a`)