Modifications pour le document Mettre en place un sous-domaine

Modifié par Gaetan RETEL le 2025/10/05 00:35

Depuis la version 3.20
modifié par Clément AUBIN
sur 2021/04/18 10:32
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 7.1
modifié par Gaetan RETEL
sur 2025/10/05 00:35
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Auteur du document
... ... @@ -1,1 +1,1 @@
1 -XWiki.aubincleme
1 +XWiki.retelgaeta
Contenu
... ... @@ -2,9 +2,9 @@
2 2  
3 3  {{toc/}}
4 4  
5 -=Idée générale=
5 += Idée générale =
6 6  
7 -Avant de suivre les étapes de mise en place, c’est intéressant de comprendre ce qu’on va faire ^^.
7 +Avant de suivre les étapes de mise en place, c’est intéressant de comprendre ce qu’on va faire ^^.^^
8 8  
9 9  Dans l'infra d'ATILLA, les connexions à un service web (members.atilla.org, learn.atilla.org, …) passent en grande majorité par Bill, qui acte comme d'un frontal web : c’est lui qui réceptionne les connexions HTTP(s) et qui les renvoie aux bons services internes par la suite. On dit également que Bill joue le rôle de //reverse-proxy//.
10 10  
... ... @@ -12,13 +12,14 @@
12 12  
13 13  [[image:reverse-proxy-arch.png]]
14 14  
15 -En pratique, Bill dispose d'un serveur Nginx, qui va avoir réceptionner toute requête HTTP(s) sur un des sites d'ATILLA et qui transfère cette requête à la VM qui héberge le service correspondant.
15 +En pratique, Bill dispose d'un serveur Nginx, qui va réceptionner toute requête HTTP(s) sur un des sites d'ATILLA et qui transfère cette requête à la VM qui héberge le service correspondant.
16 16  
17 -=Enregistrement du sous-domaine=
17 += Enregistrement du sous-domaine =
18 18  
19 19  La première chose à faire est de déclarer au monde que le domaine sur lequel vous souhaitez déployer votre service existe. Il n’y a pas de convention à proprement parler sur le choix du sous-domaine. Si vous déployez un service de gestion de tickets (par exemple, GLPI), le domaine auquel ce service pourra être accessible peut très bien être ##glpi.atilla.org## ou même ##tickets.atilla.org##.
20 20  
21 21  Pour déclarer ce domaine, rendez-vous sur la machine qui sert de DNS dans l’infra (aujourd’hui, il s’agit de Bill). Deux fichiers devront être édités :
22 +
22 22  * ##/etc/bind/internal/db.atilla.org## : les entrées DNS qui sont exposées à tous les utilisateurs au sein du réseau d’ATILLA et de l’EISTI
23 23  * ##/etc/bind/external/db.atilla.org## : les entrées DNS qui sont exposées à tous les utilisateurs venant de l’extérieur
24 24  
... ... @@ -28,6 +28,8 @@
28 28  monservice IN CNAME bill
29 29  {{/code}}
30 30  
32 +N'oubliez pas de mettre à jour les config sur le gitlab en faisant un push : [[https:~~/~~/gitlab.atilla.org/adminsys/dns-config>>https://gitlab.atilla.org/adminsys/dns-config]]
33 +
31 31  … puis redémarrez le serveur DNS :
32 32  
33 33  {{code language="none"}}
... ... @@ -42,7 +42,7 @@
42 42  Lorsqu’on fait une modification dans une configuration DNS, il y a toujours un temps dit de "propagation", pendant lequel l’entrée qui a été déclarée n’est pas tout de suite accessible par tout le monde. Cela peut prendre jusqu’à 24h pour qu’une entrée soit réellement accessible par tous. Cela est également vrai lorsqu’on modifie ou supprime une entrée.
43 43  {{/warning}}
44 44  
45 -=Mise en place des certificats SSL=
48 += Mise en place des certificats SSL =
46 46  
47 47  Maintenant qu’on a notre domaine, on va pouvoir récupérer des certificats SSL nous permettant de mettre en place le HTTPs sur ce domaine.
48 48  
... ... @@ -72,13 +72,13 @@
72 72  systemctl status nginx
73 73  {{/code}}
74 74  
75 -=Mise en place de la configuration Nginx=
78 += Mise en place de la configuration Nginx =
76 76  
77 77  Finalement, on va devoir mettre en place la configuration qui va tout lier ensemble, c’est elle qui va indiquer que, lorsqu’un utilisateur se connecte au service, on utilisera le certificat SSL qui a été généré plus haut, et on enverra les connexions à la machine voulue.
78 78  
79 -==Méthode manuelle==
82 +== Méthode manuelle ==
80 80  
81 -===Création de la configuration===
84 +=== Création de la configuration ===
82 82  
83 83  On va créer la configuration d’Nginx dans le dossier ##/etc/nginx/sites-available##. Par convention, le nom du fichier de configuration va correspondre au nom du domaine sur lequel on expose le service. Dans notre cas, il s’agira de ##monservice.atilla.org##.
84 84  
... ... @@ -86,31 +86,31 @@
86 86  
87 87  Voici à peu près ce à quoi doit ressembler la configuration. Attention : il est possible que cela change au fil du temps et que le contenu de ce tuto n’ait pas été mis à jour :).
88 88  
89 -{{code language="none"}}
92 +{{code language="nginx"}}
90 90  server {
91 - listen 80;
92 - server_name monservice.atilla.org;
93 - return 301 https://monservice.atilla.org$request_uri;
94 + listen 80;
95 + server_name monservice.atilla.org;
96 + return 301 https://monservice.atilla.org$request_uri;
94 94  }
95 95  
96 96  server {
97 - listen 443 ssl http2;
100 + listen 443 ssl http2;
98 98  
99 - server_name monservice.atilla.org;
102 + server_name monservice.atilla.org;
100 100  
101 - ssl on;
102 - ssl_certificate_key /etc/letsencrypt/live/monservice.atilla.org/privkey.pem;
103 - ssl_trusted_certificate /etc/letsencrypt/live/monservice.atilla.org/chain.pem;
104 - ssl_certificate /etc/letsencrypt/live/monservice.atilla.org/fullchain.pem;
104 + ssl on;
105 + ssl_certificate_key /etc/letsencrypt/live/monservice.atilla.org/privkey.pem;
106 + ssl_trusted_certificate /etc/letsencrypt/live/monservice.atilla.org/chain.pem;
107 + ssl_certificate /etc/letsencrypt/live/monservice.atilla.org/fullchain.pem;
105 105  
106 - access_log /var/log/nginx/monservice.atilla.org/access.log;
107 - error_log /var/log/nginx/monservice.atilla.org/error.log;
109 + access_log /var/log/nginx/monservice.atilla.org/access.log;
110 + error_log /var/log/nginx/monservice.atilla.org/error.log;
108 108  
109 - location / {
110 - proxy_set_header Host $host;
111 - proxy_set_header X-Forwarded-For $remote_addr;
112 - proxy_pass http://monservice-prod.prod.infra.atilla.org/;
113 - }
112 + location / {
113 + proxy_set_header Host $host;
114 + proxy_set_header X-Forwarded-For $remote_addr;
115 + proxy_pass http://monservice-prod.prod.infra.atilla.org/;
116 + }
114 114  }
115 115  {{/code}}
116 116  
... ... @@ -120,23 +120,86 @@
120 120  
121 121  {{code language="nginx"}}
122 122  server {
123 - listen 80;
124 - server_name monservice.atilla.org;
125 - return 301 https://monservice.atilla.org$request_uri;
126 + # On écoute sur le port 80 (le port utilisé par défaut avec HTTP)
127 + listen 80;
128 + # On répond aux requêtes qui pointent vers le domaine monservice.atilla.org
129 + server_name monservice.atilla.org;
130 + # On redirige chaque requête vers son équivalent HTTPs
131 + return 301 https://monservice.atilla.org$request_uri;
126 126  }
127 127  {{/code}}
128 128  
129 129  Le second bloc ##server## permet de définir comment va être géré le traffic HTTPs, c'est ici qu'on a la plupart de la configuration importante.
130 130  
137 +{{code language="nginx"}}
138 +server {
139 + # On écoute sur le port 443, qui est celui par défaut pour le HTTPs.
140 + # Les deux autres attributs ssl et http2 indiquent :
141 + # * Qu'on va chiffrer la connexion avec SSL (le principe du HTTPs)
142 + # * Qu'on supporte le protocole HTTP/2
143 + listen 443 ssl http2;
131 131  
145 + # Comme avant, on répond aux requêtes qui pointent vers le domaine monservice.atilla.org
146 + server_name monservice.atilla.org;
132 132  
148 + # On indique encore une fois qu'on va utiliser le SSL, et on fournit les fichiers qui
149 + # sont nécessaires pour authentifier le serveur et chiffrer la connexion.
150 + ssl on;
151 + ssl_certificate_key /etc/letsencrypt/live/monservice.atilla.org/privkey.pem;
152 + ssl_trusted_certificate /etc/letsencrypt/live/monservice.atilla.org/chain.pem;
153 + ssl_certificate /etc/letsencrypt/live/monservice.atilla.org/fullchain.pem;
133 133  
134 -===Création du dossier de logs===
155 + # On configure l'emplacement des logs
156 + access_log /var/log/nginx/monservice.atilla.org/access.log;
157 + error_log /var/log/nginx/monservice.atilla.org/error.log;
135 135  
136 -===Activation de la configuration Nginx===
159 + # C'est ici que la "magie" opère :)
160 + # La directive proxy_pass nous permet de rediriger tout le traffic vers la machine virtuelle qui correspond
161 + # Les directives proxy_set_header permettent d'ajouter des en-têtes spécifiques à destination de la machine virtuelle,
162 + # par exemple pour que celle-ci comprenne qu'elle se trouve derrière un frontal web.
163 + location / {
164 + proxy_set_header Host $host;
165 + proxy_set_header X-Forwarded-For $remote_addr;
166 + proxy_pass http://monservice-prod.prod.infra.atilla.org/;
167 + }
168 +}
169 +{{/code}}
137 137  
138 -==Méthode plus ou moins automatique==
171 +=== Création du dossier de logs ===
139 139  
173 +Comme vu dans la configuration précédente, on va stocker les logs Nginx dans ##/var/log/nginx/monservice.atilla.org##. Par défaut, ce dossier n'existe pas et il faut le créer (sinon, Nginx ne démarrera pas).
174 +
175 +{{code language="shell"}}
176 +mkdir /var/log/nginx/monservice.atilla.org
177 +{{/code}}
178 +
179 +=== Activation de la configuration Nginx ===
180 +
181 +Finalement, il faut s'assurer qu'Nginx prendra en compte notre fichier de configuration. Si vous regardez dans ##/etc/nginx##, vous verrez deux dossiers :
182 +
183 +* ##sites-available##: celui dans lequel la configuration a été créée
184 +* ##sites-enabled##: celui dans lequel la configuration doit être référencée pour être active
185 +
186 +Pour activer la configuration en question, rien de plus simple, on fait juste un lien symbolique dans ##sites-enabled## vers le fichier qui convient :
187 +
188 +{{code language="shell"}}
189 +ln -sf /etc/nginx/sites-available/monservice.atilla.org /etc/nginx/sites-enabled/atilla.org/
190 +{{/code}}
191 +
192 +Avant de terminer cette manip, on vérifie que tout est bon au niveau de la configuration, et que Nginx ne va pas planter au redémarrage :
193 +
194 +{{code language="shell"}}
195 +nginx -t
196 +{{/code}}
197 +
198 +Et finalement, on redémarre !
199 +
200 +{{code language="shell"}}
201 +systemctl restart nginx
202 +{{/code}}
203 +
204 +== Méthode plus ou moins automatique ==
205 +
140 140  On a un [[super projet sur GitLab>>https://gitlab.atilla.org/adminsys/nginx-config-generator]] qui permet d’effectuer les actions de la méthode manuelle de manière automatique. Ce projet est présent sur ##/root/nginx-config-generator## sur Bill, voici comment l’utiliser rapidement. En cas de besoin, référez vous au ##README.md## du projet.
141 141  
142 142  {{code language="shell"}}