Skip to content

Commit 2286035

Browse files
thijsvanemmerikgithub-actions[bot]
thijsvanemmerik
and
github-actions[bot]
authored
docs: add contributor site decommissioning guide (#181)
* docs: add contributor site decommissioning guide * chore: auto-translate docs * docs: address review — scheduling, discovery commands, DZX guidance * docs: clarify DZX switch/link notice in decommission guide * chore: auto-translate docs --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 48c1984 commit 2286035

9 files changed

Lines changed: 1049 additions & 0 deletions

‎docs/contribute-decommission.es.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Guía de desmantelamiento de sitio para contribuidores
2+
3+
Esta guía describe cómo desmantelar un dispositivo DoubleZero (DZD) o dar de baja un sitio: cómo retirar sus dispositivos y enlaces de la red sin interrumpir a los usuarios conectados, y luego eliminarlos onchain.
4+
5+
El proceso se ejecuta en tres fases: limitar el dispositivo 31 días antes del día de desmantelamiento, notificar a los usuarios conectados durante un período de aviso para que puedan migrar, y luego drenar y eliminar los enlaces, interfaces y el dispositivo el día del desmantelamiento.
6+
7+
> ⚠️ **Coordine con DoubleZero primero:**
8+
> Siempre alinéese con el equipo de DoubleZero antes de desmantelar un dispositivo o sitio, y programe su fecha y hora de desmantelamiento con nosotros. Ejecutamos algunos pasos de nuestro lado alrededor de ese horario, por lo que necesitamos estar programados. Acuerde las fechas y el plan antes de limitar un dispositivo o drenar un enlace.
9+
10+
> ⚠️ **Switches y enlaces DZX:**
11+
> Si el dispositivo que está desmantelando es un switch DZX, o tiene algún enlace DZX, identifique a los contribuidores afectados lo antes posible y notifíqueles, ya que es posible que necesiten mover o reconstruir sus enlaces antes de su fecha. También cree un evento de mantenimiento en el [portal OPS](contribute-ops-management.md) para la fecha de desmantelamiento.
12+
13+
---
14+
15+
## Resumen
16+
17+
| Cuándo | Acción | Quién |
18+
|--------|--------|-------|
19+
| 31 días antes | Limitar el dispositivo para que nuevos usuarios no puedan conectarse (`--max-users 0`) | Contribuidor |
20+
| 14 días antes | Los usuarios conectados son notificados para migrar a otro dispositivo | Equipo de DoubleZero |
21+
| Período de aviso | Los usuarios se reconectan por su cuenta a otros DZDs | Usuarios |
22+
| Día de desmantelamiento | Drenar y eliminar los enlaces, interfaces y el dispositivo | Contribuidor |
23+
24+
Principios:
25+
26+
- **Detener nuevos usuarios temprano, migrar usuarios existentes gradualmente.** Limitar el dispositivo temprano significa que solo pierde usuarios a partir de ese momento. Los usuarios existentes siguen funcionando y migran según su propio calendario.
27+
- **Mantener todo activo durante el período de aviso.** No drene los enlaces ni el dispositivo hasta el día de desmantelamiento, para que los usuarios en proceso de migración mantengan el servicio normal.
28+
- **El orden de desmontaje es impuesto por el contrato.** No puede eliminar un enlace o dispositivo mientras esté activo, por lo que los pasos a continuación drenan primero y eliminan al final.
29+
30+
> ⚠️ **Aviso con poco tiempo:**
31+
> Si tiene menos de 31 días antes de la salida, comience inmediatamente. Limite el dispositivo ahora y acorte los períodos para ajustarse al tiempo disponible. El orden de los pasos no cambia.
32+
33+
---
34+
35+
## Fase 1 — Limitar el dispositivo (31 días antes)
36+
37+
Limite el dispositivo para que nuevos usuarios no puedan conectarse:
38+
39+
```bash
40+
doublezero device update --pubkey <DEVICE_PUBKEY> --max-users 0
41+
```
42+
43+
Los usuarios existentes no se ven afectados y siguen funcionando. Repita para cada dispositivo que se vaya a desmantelar en el sitio. Los enlaces y el dispositivo permanecen completamente activos, por lo que los usuarios conectados mantienen el servicio normal.
44+
45+
---
46+
47+
## Fase 2 — Período de aviso (14 días antes)
48+
49+
El equipo de DoubleZero notifica a los usuarios conectados, pidiéndoles que se reconecten a un DZD diferente antes de la fecha de desmantelamiento. Coordine con el equipo sobre quién contacta a qué usuarios.
50+
51+
No se drena nada durante este período, por lo que los usuarios mantienen el servicio normal. Los usuarios se reconectan a su propio ritmo. Monitoree el conteo de usuarios con:
52+
53+
```bash
54+
doublezero device list
55+
```
56+
57+
---
58+
59+
## Fase 3 — Día de desmantelamiento
60+
61+
Antes de comenzar, determine exactamente qué necesita ser eliminado: el dispositivo, los enlaces conectados a él y las interfaces a limpiar. Puede encontrar todo esto con:
62+
63+
```bash
64+
doublezero device list | grep <CONTRIBUTOR_CODE> # encontrar su dispositivo: su código y pubkey
65+
doublezero link list | grep <DEVICE_CODE> # encontrar los enlaces conectados al dispositivo
66+
doublezero device interface list <DEVICE_CODE> # listar las interfaces del dispositivo a eliminar
67+
```
68+
69+
Ejecute estos pasos en orden. Cada paso desbloquea el siguiente.
70+
71+
> ⚠️ **Antes de la eliminación final del dispositivo:**
72+
> Notifique a la Fundación DoubleZero antes de ejecutar el último paso. La Fundación elimina a cualquier usuario que no haya migrado a tiempo, lo cual de otro modo bloquearía la eliminación, y completa cualquier paso requerido del lado de la fundación.
73+
74+
### 1. Drenar los enlaces
75+
76+
Primero drenado suave, luego drenado fuerte. Consulte [Drenado de enlaces](contribute-operations.md#link-draining) para conocer qué hace cada estado.
77+
78+
```bash
79+
doublezero link update --pubkey <LINK_PUBKEY> --status soft-drained
80+
# una vez que el tráfico se haya movido:
81+
doublezero link update --pubkey <LINK_PUBKEY> --status hard-drained
82+
```
83+
84+
Repita para cada enlace en los dispositivos que se van a retirar.
85+
86+
### 2. Eliminar los enlaces
87+
88+
```bash
89+
doublezero link delete --pubkey <LINK_PUBKEY>
90+
```
91+
92+
Esto libera las interfaces que los enlaces estaban usando.
93+
94+
### 3. Eliminar las interfaces
95+
96+
```bash
97+
doublezero device interface delete <DEVICE_CODE> <INTERFACE_NAME>
98+
```
99+
100+
Repita para cada interfaz en el dispositivo.
101+
102+
### 4. Drenar el dispositivo
103+
104+
```bash
105+
doublezero device update --pubkey <DEVICE_PUBKEY> --status drained
106+
```
107+
108+
El drenado elimina el dispositivo del enrutamiento y cierra cualquier sesión de usuario restante. También mueve el dispositivo fuera de su estado activo para que pueda ser eliminado.
109+
110+
### 5. Eliminar el dispositivo
111+
112+
```bash
113+
doublezero device delete --pubkey <DEVICE_PUBKEY>
114+
```
115+
116+
El dispositivo solo puede ser eliminado una vez que ya no esté activo, no tenga enlaces que lo referencien y no le queden interfaces, lo cual los pasos anteriores se encargan de resolver.
117+
118+
---
119+
120+
## Cancelación o aplazamiento
121+
122+
Limitar y drenar son reversibles hasta que comience a eliminar:
123+
124+
```bash
125+
doublezero device update --pubkey <DEVICE_PUBKEY> --max-users <ORIGINAL_VALUE> # restaurar capacidad
126+
doublezero link update --pubkey <LINK_PUBKEY> --status soft-drained # desde hard-drained
127+
doublezero link update --pubkey <LINK_PUBKEY> --status activated # volver a activo
128+
doublezero device update --pubkey <DEVICE_PUBKEY> --status activated # revertir el drenado del dispositivo
129+
```
130+
131+
Eliminar los enlaces, interfaces o el dispositivo es permanente: cierra las cuentas onchain. Solo comience a eliminar una vez que la salida esté confirmada.

‎docs/contribute-decommission.fr.md‎

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,131 @@
1+
# Guide de désaffectation de site pour les contributeurs
2+
3+
Ce guide décrit comment désaffecter un DoubleZero Device (DZD) ou quitter un site : comment retirer vos appareils et liens du réseau sans perturber les utilisateurs connectés, puis les supprimer on-chain.
4+
5+
Le processus se déroule en trois étapes : plafonner l'appareil 31 jours avant le jour de la désaffectation, notifier les utilisateurs connectés pendant une fenêtre de préavis afin qu'ils puissent migrer, puis drainer et supprimer les liens, interfaces et l'appareil le jour de la désaffectation.
6+
7+
> ⚠️ **Coordonnez-vous d'abord avec DoubleZero :**
8+
> Alignez-vous toujours avec l'équipe DoubleZero avant de désaffecter un appareil ou un site, et planifiez votre date et heure de désaffectation avec nous. Nous effectuons quelques étapes de notre côté autour de ce créneau, il est donc nécessaire de nous inclure dans la planification. Convenez des dates et du plan avant de plafonner un appareil ou de drainer un lien.
9+
10+
> ⚠️ **Commutateurs et liens DZX :**
11+
> Si l'appareil que vous désaffectez est un commutateur DZX, ou possède des liens DZX, identifiez les contributeurs concernés le plus tôt possible et prévenez-les, car ils pourraient avoir besoin de déplacer ou reconstruire leurs liens avant votre date. Créez également un événement de maintenance dans le [portail OPS](contribute-ops-management.md) pour la date de désaffectation.
12+
13+
---
14+
15+
## Vue d'ensemble
16+
17+
| Quand | Action | Qui |
18+
|-------|--------|-----|
19+
| 31 jours avant | Plafonner l'appareil pour qu'aucun nouvel utilisateur ne puisse s'y connecter (`--max-users 0`) | Contributeur |
20+
| 14 jours avant | Les utilisateurs connectés sont notifiés de migrer vers un autre appareil | Équipe DoubleZero |
21+
| Fenêtre de préavis | Les utilisateurs se reconnectent eux-mêmes à d'autres DZD | Utilisateurs |
22+
| Jour de la désaffectation | Drainer et supprimer les liens, interfaces et l'appareil | Contributeur |
23+
24+
Principes :
25+
26+
- **Bloquer les nouveaux utilisateurs tôt, migrer les utilisateurs existants progressivement.** Plafonner l'appareil tôt signifie qu'il ne perd des utilisateurs qu'à partir de ce moment. Les utilisateurs existants continuent de fonctionner et migrent à leur propre rythme.
27+
- **Tout maintenir en service pendant la fenêtre de préavis.** Ne drainez pas les liens ni l'appareil avant le jour de la désaffectation, afin que les utilisateurs en cours de migration conservent un service normal.
28+
- **L'ordre de démontage est imposé par le contrat.** Vous ne pouvez pas supprimer un lien ou un appareil tant qu'il est actif, les étapes ci-dessous procèdent donc au drainage d'abord et à la suppression en dernier.
29+
30+
> ⚠️ **Préavis court :**
31+
> Si vous disposez de moins de 31 jours avant la sortie, commencez immédiatement. Plafonnez l'appareil maintenant et raccourcissez les fenêtres pour s'adapter au temps disponible. L'ordre des étapes ne change pas.
32+
33+
---
34+
35+
## Phase 1 — Plafonner l'appareil (31 jours avant)
36+
37+
Plafonnez l'appareil pour qu'aucun nouvel utilisateur ne puisse s'y connecter :
38+
39+
```bash
40+
doublezero device update --pubkey <DEVICE_PUBKEY> --max-users 0
41+
```
42+
43+
Les utilisateurs existants ne sont pas affectés et continuent de fonctionner. Répétez l'opération pour chaque appareil en cours de désaffectation sur le site. Les liens et l'appareil restent pleinement actifs, de sorte que les utilisateurs connectés conservent un service normal.
44+
45+
---
46+
47+
## Phase 2 — Fenêtre de préavis (14 jours avant)
48+
49+
L'équipe DoubleZero notifie les utilisateurs connectés, leur demandant de se reconnecter à un autre DZD avant la date de désaffectation. Coordonnez-vous avec l'équipe pour déterminer qui contacte quels utilisateurs.
50+
51+
Rien n'est drainé pendant cette fenêtre, les utilisateurs conservent donc un service normal. Les utilisateurs se reconnectent eux-mêmes à leur propre rythme. Surveillez le nombre d'utilisateurs avec :
52+
53+
```bash
54+
doublezero device list
55+
```
56+
57+
---
58+
59+
## Phase 3 — Jour de la désaffectation
60+
61+
Avant de commencer, identifiez précisément ce qui doit être retiré : l'appareil, les liens qui y sont connectés et les interfaces à nettoyer. Vous pouvez trouver toutes ces informations avec :
62+
63+
```bash
64+
doublezero device list | grep <CONTRIBUTOR_CODE> # trouver votre appareil : son code et sa pubkey
65+
doublezero link list | grep <DEVICE_CODE> # trouver les liens connectés à l'appareil
66+
doublezero device interface list <DEVICE_CODE> # lister les interfaces de l'appareil à supprimer
67+
```
68+
69+
Exécutez ces étapes dans l'ordre. Chaque étape déverrouille la suivante.
70+
71+
> ⚠️ **Avant la suppression finale de l'appareil :**
72+
> Prévenez la DoubleZero Foundation avant d'exécuter la dernière étape. La Foundation supprime les utilisateurs qui n'ont pas migré à temps, ce qui bloquerait sinon la suppression, et complète toutes les étapes requises de son côté.
73+
74+
### 1. Drainer les liens
75+
76+
Effectuez d'abord un drainage progressif (soft-drain), puis un drainage complet (hard-drain). Consultez [Drainage des liens](contribute-operations.md#link-draining) pour comprendre ce que fait chaque état.
77+
78+
```bash
79+
doublezero link update --pubkey <LINK_PUBKEY> --status soft-drained
80+
# une fois le trafic déplacé :
81+
doublezero link update --pubkey <LINK_PUBKEY> --status hard-drained
82+
```
83+
84+
Répétez pour chaque lien sur les appareils en cours de retrait.
85+
86+
### 2. Supprimer les liens
87+
88+
```bash
89+
doublezero link delete --pubkey <LINK_PUBKEY>
90+
```
91+
92+
Cela libère les interfaces que les liens utilisaient.
93+
94+
### 3. Supprimer les interfaces
95+
96+
```bash
97+
doublezero device interface delete <DEVICE_CODE> <INTERFACE_NAME>
98+
```
99+
100+
Répétez pour chaque interface de l'appareil.
101+
102+
### 4. Drainer l'appareil
103+
104+
```bash
105+
doublezero device update --pubkey <DEVICE_PUBKEY> --status drained
106+
```
107+
108+
Le drainage retire l'appareil du routage et ferme toutes les sessions utilisateur restantes. Il fait également sortir l'appareil de son état actif afin qu'il puisse être supprimé.
109+
110+
### 5. Supprimer l'appareil
111+
112+
```bash
113+
doublezero device delete --pubkey <DEVICE_PUBKEY>
114+
```
115+
116+
L'appareil ne peut être supprimé que lorsqu'il n'est plus actif, qu'aucun lien ne le référence et qu'il ne reste aucune interface, ce que les étapes précédentes gèrent.
117+
118+
---
119+
120+
## Annulation ou report
121+
122+
Le plafonnement et le drainage sont réversibles tant que vous n'avez pas commencé à supprimer :
123+
124+
```bash
125+
doublezero device update --pubkey <DEVICE_PUBKEY> --max-users <ORIGINAL_VALUE> # restaurer la capacité
126+
doublezero link update --pubkey <LINK_PUBKEY> --status soft-drained # depuis hard-drained
127+
doublezero link update --pubkey <LINK_PUBKEY> --status activated # retour à l'état actif
128+
doublezero device update --pubkey <DEVICE_PUBKEY> --status activated # annuler le drainage de l'appareil
129+
```
130+
131+
La suppression des liens, interfaces ou de l'appareil est permanente : elle ferme les comptes on-chain. Ne commencez à supprimer que lorsque la sortie est confirmée.

0 commit comments

Comments
 (0)