|
1 | 1 | # Contingut del Directori Docker |
2 | 2 |
|
3 | | -Aquest directori conté tots els fitxers creats per gestionar el desplegament de la Demo de Django-Aula i per la creació d'imatges de l'aplicació Django-Aula mitjançant contenidors Docker. |
4 | | - |
5 | | -El directori conté els fitxers de configuració pel desplegament ràpid de la Demo i els fitxers per construir-la, així com algun arxiu més que obre la porta per futurs desenvolupaments de l'aplicatiu sencer amb Docker. |
| 3 | +Aquest directori conté els fitxers necessaris per gestionar el desplegament d'una Demo de Django-Aula, tant per la versió normal com per la versió per desenvolupament, mitjançant contenidors Docker. |
6 | 4 |
|
| 5 | +Per informació més precisa, consulti la documentació detallada per la [Instal·lació de la demo de forma automatitzada amb Docker](../docs/USER_MANUAL/demo/install_demo_docker.md) |
7 | 6 | --- |
8 | 7 |
|
9 | 8 | ## 1. Requisit previ. Instal·lació de Docker CE i docker-compose en el sistema operatiu |
10 | 9 |
|
11 | 10 | Segons es descriu a les instruccions principals del repositori, hi ha dues maneres d'instal·lar Docker en el sistema operatiu, la manual i l'automatitzada. |
12 | 11 |
|
13 | | -| Nom de l'Arxiu | Descripció | Ús Principal | |
14 | | -| :--- | :--- | :--- | |
15 | | -| `install_docker.sh` | **Script d'instal·lació automatitzada de Docker.** Descarrega i configura tot allò que cal per instal·lar l'entorn Docker i docker-compose en el sistema. | Instal·lar Docker en el sistema operatiu. | |
16 | | - |
17 | | - |
18 | | -## 2. Arxius de Configuració de Desplegament Ràpid |
| 12 | +| Nom de l'Arxiu | Descripció | |
| 13 | +| :--- | :--- | |
| 14 | +| `install_docker.sh` | **Script d'instal·lació automatitzada de Docker.** Descarrega i configura tot allò que cal per instal·lar l'entorn Docker i docker-compose en el sistema. | |
19 | 15 |
|
20 | | -Aquests arxius s'utilitzen per a l'**Instal·lació de la Demo** amb Docker de forma automatitzada, tal com s'explica al document principal. Són la base per a un desplegament senzill i automatitzat típic amb Docker. |
21 | | - |
22 | | -| Nom de l'Arxiu | Descripció | Ús Principal | |
23 | | -| :--- | :--- | :--- | |
24 | | -| `install_quick_demo_docker.sh` | **Script d'instal·lació automatitzada.** Descarrega, col·loca els arxius de configuració a l'arrel del projecte, els reanomena i desplega els contenidors automàticament. | Desplegament actual de la Demo. | |
25 | | -| `docker-compose.demo.automatica.yml` | Fitxer de configuració de serveis (Web + DB) utilitzat per la Demo. | Serà l'arxiu `docker-compose.yml` que desplegarà la Demo. | |
26 | | -| `Makefile.demo.automatica` | Defineix les ordres de gestió simplificades (`serve`, `stop`, `logs` i `down`) per a la Demo. | Serà l'arxiu `Makefile` que facilitarà el desplegament de la Demo. | |
27 | | -| `env.demo.automatica` | Arxiu de variables d'entorn per la base de dades de PostgreSQL que farà servir la Demo. | Serà l'arxiu `.env` que llegirà l'arxiu `docker-compose.yml`. | |
28 | | -| `dades_demmo.sql` | És el fitxer SQL (`.sql`) amb les dades de demostració precarregades. | El contenidor de PostgreSQL llegeix aquest fitxer en iniciar-se i omple la base de dades de forma ràpida i automàtica. | |
29 | | - |
30 | | ---- |
31 | 16 |
|
32 | | -## 3. Fitxers de Construcció i Entorns de Desenvolupament |
| 17 | +## 2. Arxius necessaris pel desplegament de la Demo |
33 | 18 |
|
34 | | -Es troben ubicats al directori **build-dev** i són els que es fan servir per **crear noves imatges**, tant per la Demo com per qualsevol altre objectiu. |
| 19 | +Aquests arxius s'utilitzen per la **Instal·lació de la Demo** amb Docker de forma automatitzada, tal com s'explica al document principal. Són la base d'un desplegament senzill i automatitzat típic amb Docker. |
35 | 20 |
|
36 | | -| Nom de l'Arxiu | Descripció | Finalitat | |
37 | | -| :--- | :--- | :--- | |
38 | | -| `Dockerfile.demo.automatica` | Defineix com es va construir la imatge per a la Demo actualment desplegable de forma automatitzada . | Utilitzat per crear la imatge pujada al repositori d'imatges *Docker Hub*. | |
39 | | -| `docker-compose.demo.manual.yml` | És el fitxer de partida a partir del qual es va construir el *docker-compose.demo.automatica.yml*. | Ús per a desenvolupadors locals que volen accedir a *shells*, *migrations*, etc. | |
40 | | -| `docker-compose.dev.yml` | Configuració completa dels serveis per a **l'entorn de Desenvolupament** (DEV). (ara en desenvolupament) | Facilitar crear un entorn de desenvolupament de l'aplicació bassat en Docker i pensat per a desenvolupadors locals que volen accedir a *shells*, *migrations*, etc. | |
41 | | -| `Makefile.demo.manual` | És el fitxer de partida a partir del qual es va construir el *Makefile.demo.automatica*. Interacciona amb el fitxer *docker-compose.demo.yml*.| És l'arxiu que facilitarà la creació i desplegament de les noves Demos que es vulguin crear. | |
42 | | -| `Makefile.demo.complet` | Conté conjuntament les instruccions per treballar tant amb la versió manual com la versió *DEV*. | Serveix com a referència i com a base per a entorns de Producció/Desenvolupament. | |
43 | | -| `env.example` | Arxiu de variables d'entorn *sense personalitzar* per la base de dades de PostgreSQL que farà servir la Demo. | Base per crear el fitxer `.env` per crear una imatge de Django-Aula amb Docker. | |
44 | | -| `.dockerignore.demo` | Especifica els fitxers que s'han d'excloure del context de construcció de la imatge de la Demo. | Optimització i seguretat de la imatge Docker final. | |
| 21 | +| Nom de l'Arxiu | Descripció | |
| 22 | +| :--- | :--- | |
| 23 | +| `install_demo_docker.sh` | **Script d'instal·lació automatitzada.** Descarrega, col·loca els arxius de configuració a l'arrel del projecte, els reanomena i desplega els contenidors automàticament. | |
| 24 | +| `docker-compose.yml` | Fitxer de configuració de serveis (Web + DB) utilitzat per la Demo. | |
| 25 | +| `docker-compose.dev.yml` | Versió per a desenvolupadors de codi del fitxer de configuració de serveis (Web + DB) que crea la Demo. | |
| 26 | +| `Dockerfile` | Defineix les passes que es seguiran per construir la imatge de la Demo | |
| 27 | +| `Makefile` | Facilita el desplegament de la Demo mitjançant ordres de gestió simplificades, com ara `serve`, `stop`, `logs`, `down`, etc. | |
| 28 | +| `.env` | Arxiu de variables d'entorn per la base de dades de PostgreSQL que farà servir la Demo. | |
| 29 | +| `.dockerignore` | Declaració d'arxius que no son necessaris incloure dins el contenidor docker de la Demo | |
0 commit comments