From 46db8b7c07b86b4c5f890a4000bcb539800aa92f Mon Sep 17 00:00:00 2001 From: Thijs van Emmerik Date: Wed, 8 Jul 2026 07:41:54 +0000 Subject: [PATCH 1/5] docs: add contributor site decommissioning guide --- docs/contribute-decommission.md | 120 ++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 121 insertions(+) create mode 100644 docs/contribute-decommission.md diff --git a/docs/contribute-decommission.md b/docs/contribute-decommission.md new file mode 100644 index 0000000..9609a35 --- /dev/null +++ b/docs/contribute-decommission.md @@ -0,0 +1,120 @@ +# Site Decommissioning Guide for Contributors + +This guide describes how to decommission a DoubleZero Device (DZD) or exit a site: how to remove your devices and links from the network without disrupting connected users, then delete them onchain. + +The process runs in three stages: cap the device 31 days before decommission day, notify connected users during a notice window so they can move, then drain and delete the links, interfaces, and device on decommission day. + +> ⚠️ **Coordinate with DoubleZero first:** +> Always align with the DoubleZero team before decommissioning a device or site. Agree on the dates and plan before you cap a device or drain a link, so user migration and the required foundation-side steps can be coordinated. + +--- + +## Overview + +| When | Action | Who | +|------|--------|-----| +| 31 days before | Cap the device so no new users can attach (`--max-users 0`) | Contributor | +| 14 days before | Connected users are notified to move to another device | DoubleZero team | +| Notice window | Users reconnect themselves to other DZDs | Users | +| Decommission day | Drain and delete the links, interfaces, and device | Contributor | + +Principles: + +- **Stop new users early, move existing users gradually.** Capping the device early means it only loses users from that point on. Existing users keep working and migrate on their own schedule. +- **Keep everything live during the notice window.** Do not drain the links or the device until decommission day, so migrating users keep normal service. +- **The teardown order is enforced by the contract.** You cannot delete a link or device while it is active, so the steps below drain first and delete last. + +> ⚠️ **Short notice:** +> If you have less than 31 days before the exit, start immediately. Cap the device now and shorten the windows to fit the available time. The step order does not change. + +--- + +## Phase 1 — Cap the device (31 days before) + +Cap the device so no new users can attach: + +```bash +doublezero device update --pubkey --max-users 0 +``` + +Existing users are untouched and keep working. Repeat for every device being decommissioned at the site. The links and the device stay fully active, so connected users keep normal service. + +--- + +## Phase 2 — Notice window (14 days before) + +The DoubleZero team notifies the connected users, asking them to reconnect to a different DZD before the decommission date. Coordinate with the team on who reaches out to which users. + +Nothing is drained during this window, so users keep normal service. Users reconnect themselves at their own pace. Monitor the user count with: + +```bash +doublezero device list +``` + +--- + +## Phase 3 — Decommission day + +Run these steps in order. Each step unlocks the next. + +> ⚠️ **Before the final device deletion:** +> Notify the DoubleZero Foundation before running the last step. The Foundation removes any users who did not migrate in time, which would otherwise block the deletion, and completes any required foundation-side steps. + +### 1. Drain the links + +Soft-drain first, then hard-drain. See [Link Draining](contribute-operations.md#link-draining) for what each state does. + +```bash +doublezero link update --pubkey --status soft-drained +# once traffic has moved off: +doublezero link update --pubkey --status hard-drained +``` + +Repeat for every link on the devices being removed. + +### 2. Delete the links + +```bash +doublezero link delete --pubkey +``` + +This frees the interfaces the links were using. + +### 3. Delete the interfaces + +```bash +doublezero device interface delete +``` + +Repeat for each interface on the device. + +### 4. Drain the device + +```bash +doublezero device update --pubkey --status drained +``` + +Draining removes the device from routing and closes any remaining user sessions. It also moves the device out of its active state so it can be deleted. + +### 5. Delete the device + +```bash +doublezero device delete --pubkey +``` + +The device can only be deleted once it is no longer active, has no links referencing it, and has no interfaces left, which the previous steps handle. + +--- + +## Cancelling or postponing + +Capping and draining are reversible until you begin deleting: + +```bash +doublezero device update --pubkey --max-users # restore capacity +doublezero link update --pubkey --status soft-drained # from hard-drained +doublezero link update --pubkey --status activated # back to active +doublezero device update --pubkey --status activated # un-drain the device +``` + +Deleting the links, interfaces, or device is permanent: it closes the onchain accounts. Only start deleting once the exit is confirmed. diff --git a/mkdocs.yml b/mkdocs.yml index 5c8c602..7564b56 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -81,6 +81,7 @@ nav: - Operations: contribute-operations.md - OPS Management: contribute-ops-management.md - Geolocation: contribute-geolocation.md + - Decommissioning: contribute-decommission.md - Architecture: architecture.md - Glossary: glossary.md markdown_extensions: From 4644db2927a50b7012f529d4d7d8b2fa992d0579 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 8 Jul 2026 07:50:57 +0000 Subject: [PATCH 2/5] chore: auto-translate docs --- docs/contribute-decommission.es.md | 120 +++++++++++++++++++++++++++++ docs/contribute-decommission.fr.md | 120 +++++++++++++++++++++++++++++ docs/contribute-decommission.it.md | 120 +++++++++++++++++++++++++++++ docs/contribute-decommission.ja.md | 120 +++++++++++++++++++++++++++++ docs/contribute-decommission.ko.md | 120 +++++++++++++++++++++++++++++ docs/contribute-decommission.pt.md | 120 +++++++++++++++++++++++++++++ docs/contribute-decommission.zh.md | 120 +++++++++++++++++++++++++++++ 7 files changed, 840 insertions(+) create mode 100644 docs/contribute-decommission.es.md create mode 100644 docs/contribute-decommission.fr.md create mode 100644 docs/contribute-decommission.it.md create mode 100644 docs/contribute-decommission.ja.md create mode 100644 docs/contribute-decommission.ko.md create mode 100644 docs/contribute-decommission.pt.md create mode 100644 docs/contribute-decommission.zh.md diff --git a/docs/contribute-decommission.es.md b/docs/contribute-decommission.es.md new file mode 100644 index 0000000..094eb2f --- /dev/null +++ b/docs/contribute-decommission.es.md @@ -0,0 +1,120 @@ +# Guía de desmantelamiento de sitio para Contribuidores + +Esta guía describe cómo desmantelar un Dispositivo DoubleZero (DZD) o dar de baja un sitio: cómo retirar tus dispositivos y enlaces de la red sin interrumpir a los usuarios conectados, y luego eliminarlos onchain. + +El proceso se ejecuta en tres etapas: 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. + +> ⚠️ **Coordina con DoubleZero primero:** +> Siempre alinéate con el equipo de DoubleZero antes de desmantelar un dispositivo o sitio. Acuerda las fechas y el plan antes de limitar un dispositivo o drenar un enlace, para que la migración de usuarios y los pasos requeridos por parte de la fundación puedan coordinarse. + +--- + +## Descripción general + +| Cuándo | Acción | Quién | +|--------|--------|-------| +| 31 días antes | Limitar el dispositivo para que no se puedan conectar nuevos usuarios (`--max-users 0`) | Contribuidor | +| 14 días antes | Los usuarios conectados son notificados para migrar a otro dispositivo | Equipo de DoubleZero | +| Período de aviso | Los usuarios se reconectan por su cuenta a otros DZDs | Usuarios | +| Día de desmantelamiento | Drenar y eliminar los enlaces, interfaces y el dispositivo | Contribuidor | + +Principios: + +- **Detener nuevos usuarios temprano, mover usuarios existentes gradualmente.** Limitar el dispositivo temprano significa que solo pierde usuarios a partir de ese momento. Los usuarios existentes siguen funcionando y migran a su propio ritmo. +- **Mantener todo activo durante el período de aviso.** No drenes los enlaces ni el dispositivo hasta el día de desmantelamiento, para que los usuarios en proceso de migración mantengan el servicio normal. +- **El orden de desmontaje es impuesto por el contrato.** No puedes eliminar un enlace o dispositivo mientras está activo, por lo que los pasos a continuación drenan primero y eliminan al final. + +> ⚠️ **Aviso con poca antelación:** +> Si tienes menos de 31 días antes de la salida, comienza inmediatamente. Limita el dispositivo ahora y acorta los períodos para ajustarte al tiempo disponible. El orden de los pasos no cambia. + +--- + +## Fase 1 — Limitar el dispositivo (31 días antes) + +Limita el dispositivo para que no se puedan conectar nuevos usuarios: + +```bash +doublezero device update --pubkey --max-users 0 +``` + +Los usuarios existentes no se ven afectados y siguen funcionando. Repite para cada dispositivo que se esté desmantelando en el sitio. Los enlaces y el dispositivo permanecen completamente activos, por lo que los usuarios conectados mantienen el servicio normal. + +--- + +## Fase 2 — Período de aviso (14 días antes) + +El equipo de DoubleZero notifica a los usuarios conectados, pidiéndoles que se reconecten a un DZD diferente antes de la fecha de desmantelamiento. Coordina con el equipo sobre quién contacta a qué usuarios. + +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. Monitorea el conteo de usuarios con: + +```bash +doublezero device list +``` + +--- + +## Fase 3 — Día de desmantelamiento + +Ejecuta estos pasos en orden. Cada paso desbloquea el siguiente. + +> ⚠️ **Antes de la eliminación final del dispositivo:** +> Notifica a la Fundación DoubleZero antes de ejecutar el último paso. La Fundación elimina a los usuarios que no migraron a tiempo, lo cual de otro modo bloquearía la eliminación, y completa los pasos requeridos por parte de la fundación. + +### 1. Drenar los enlaces + +Primero drenado suave, luego drenado fuerte. Consulta [Drenado de enlaces](contribute-operations.md#link-draining) para conocer qué hace cada estado. + +```bash +doublezero link update --pubkey --status soft-drained +# una vez que el tráfico se haya movido: +doublezero link update --pubkey --status hard-drained +``` + +Repite para cada enlace en los dispositivos que se están retirando. + +### 2. Eliminar los enlaces + +```bash +doublezero link delete --pubkey +``` + +Esto libera las interfaces que los enlaces estaban utilizando. + +### 3. Eliminar las interfaces + +```bash +doublezero device interface delete +``` + +Repite para cada interfaz en el dispositivo. + +### 4. Drenar el dispositivo + +```bash +doublezero device update --pubkey --status drained +``` + +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. + +### 5. Eliminar el dispositivo + +```bash +doublezero device delete --pubkey +``` + +El dispositivo solo puede eliminarse 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 gestionar. + +--- + +## Cancelar o posponer + +Limitar y drenar son reversibles hasta que comiences a eliminar: + +```bash +doublezero device update --pubkey --max-users # restaurar capacidad +doublezero link update --pubkey --status soft-drained # desde hard-drained +doublezero link update --pubkey --status activated # volver a activo +doublezero device update --pubkey --status activated # revertir el drenado del dispositivo +``` + +Eliminar los enlaces, interfaces o el dispositivo es permanente: cierra las cuentas onchain. Solo comienza a eliminar una vez que la salida esté confirmada. \ No newline at end of file diff --git a/docs/contribute-decommission.fr.md b/docs/contribute-decommission.fr.md new file mode 100644 index 0000000..0b2ca07 --- /dev/null +++ b/docs/contribute-decommission.fr.md @@ -0,0 +1,120 @@ +# Guide de mise hors service d'un site pour les contributeurs + +Ce guide décrit comment mettre hors service 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 onchain. + +Le processus se déroule en trois étapes : plafonner l'appareil 31 jours avant le jour de la mise hors service, notifier les utilisateurs connectés pendant une période de préavis afin qu'ils puissent migrer, puis drainer et supprimer les liens, interfaces et l'appareil le jour de la mise hors service. + +> ⚠️ **Coordonnez-vous d'abord avec DoubleZero :** +> Alignez-vous toujours avec l'équipe DoubleZero avant de mettre hors service un appareil ou un site. Convenez des dates et du plan avant de plafonner un appareil ou de drainer un lien, afin que la migration des utilisateurs et les étapes requises côté fondation puissent être coordonnées. + +--- + +## Vue d'ensemble + +| Quand | Action | Qui | +|-------|--------|-----| +| 31 jours avant | Plafonner l'appareil pour qu'aucun nouvel utilisateur ne puisse s'y connecter (`--max-users 0`) | Contributeur | +| 14 jours avant | Les utilisateurs connectés sont notifiés de migrer vers un autre appareil | Équipe DoubleZero | +| Période de préavis | Les utilisateurs se reconnectent eux-mêmes à d'autres DZD | Utilisateurs | +| Jour de la mise hors service | Drainer et supprimer les liens, interfaces et l'appareil | Contributeur | + +Principes : + +- **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. +- **Tout maintenir en service pendant la période de préavis.** Ne drainez pas les liens ni l'appareil avant le jour de la mise hors service, afin que les utilisateurs en cours de migration conservent un service normal. +- **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 drainent donc en premier et suppriment en dernier. + +> ⚠️ **Préavis court :** +> Si vous disposez de moins de 31 jours avant la sortie, commencez immédiatement. Plafonnez l'appareil maintenant et raccourcissez les délais pour les adapter au temps disponible. L'ordre des étapes ne change pas. + +--- + +## Phase 1 — Plafonner l'appareil (31 jours avant) + +Plafonnez l'appareil pour qu'aucun nouvel utilisateur ne puisse s'y connecter : + +```bash +doublezero device update --pubkey --max-users 0 +``` + +Les utilisateurs existants ne sont pas affectés et continuent de fonctionner. Répétez pour chaque appareil mis hors service sur le site. Les liens et l'appareil restent pleinement actifs, de sorte que les utilisateurs connectés conservent un service normal. + +--- + +## Phase 2 — Période de préavis (14 jours avant) + +L'équipe DoubleZero notifie les utilisateurs connectés, leur demandant de se reconnecter à un autre DZD avant la date de mise hors service. Coordonnez-vous avec l'équipe pour déterminer qui contacte quels utilisateurs. + +Rien n'est drainé pendant cette période, les utilisateurs conservent donc un service normal. Les utilisateurs se reconnectent eux-mêmes à leur propre rythme. Surveillez le nombre d'utilisateurs avec : + +```bash +doublezero device list +``` + +--- + +## Phase 3 — Jour de la mise hors service + +Exécutez ces étapes dans l'ordre. Chaque étape déverrouille la suivante. + +> ⚠️ **Avant la suppression finale de l'appareil :** +> Notifiez la DoubleZero Foundation avant d'exécuter la dernière étape. La Foundation supprime tous les utilisateurs qui n'ont pas migré à temps, ce qui bloquerait autrement la suppression, et effectue toutes les étapes requises côté fondation. + +### 1. Drainer les liens + +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. + +```bash +doublezero link update --pubkey --status soft-drained +# une fois le trafic déplacé : +doublezero link update --pubkey --status hard-drained +``` + +Répétez pour chaque lien sur les appareils en cours de retrait. + +### 2. Supprimer les liens + +```bash +doublezero link delete --pubkey +``` + +Cela libère les interfaces que les liens utilisaient. + +### 3. Supprimer les interfaces + +```bash +doublezero device interface delete +``` + +Répétez pour chaque interface de l'appareil. + +### 4. Drainer l'appareil + +```bash +doublezero device update --pubkey --status drained +``` + +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é. + +### 5. Supprimer l'appareil + +```bash +doublezero device delete --pubkey +``` + +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. + +--- + +## Annulation ou report + +Le plafonnement et le drainage sont réversibles tant que vous n'avez pas commencé à supprimer : + +```bash +doublezero device update --pubkey --max-users # restaurer la capacité +doublezero link update --pubkey --status soft-drained # depuis hard-drained +doublezero link update --pubkey --status activated # retour à l'état actif +doublezero device update --pubkey --status activated # annuler le drainage de l'appareil +``` + +La suppression des liens, interfaces ou de l'appareil est permanente : elle ferme les comptes onchain. Ne commencez à supprimer que lorsque la sortie est confirmée. \ No newline at end of file diff --git a/docs/contribute-decommission.it.md b/docs/contribute-decommission.it.md new file mode 100644 index 0000000..b3bd7c4 --- /dev/null +++ b/docs/contribute-decommission.it.md @@ -0,0 +1,120 @@ +# Guida alla Dismissione di un Sito per i Contributor + +Questa guida descrive come dismettere un DoubleZero Device (DZD) o uscire da un sito: come rimuovere i propri dispositivi e link dalla rete senza creare disservizi agli utenti connessi, per poi eliminarli onchain. + +Il processo si articola in tre fasi: limitare il dispositivo 31 giorni prima del giorno della dismissione, notificare gli utenti connessi durante una finestra di preavviso affinché possano migrare, quindi drenare ed eliminare i link, le interfacce e il dispositivo nel giorno della dismissione. + +> ⚠️ **Coordinati prima con DoubleZero:** +> Allineati sempre con il team di DoubleZero prima di dismettere un dispositivo o un sito. Concorda le date e il piano prima di limitare un dispositivo o drenare un link, in modo da coordinare la migrazione degli utenti e le operazioni necessarie da parte della fondazione. + +--- + +## Panoramica + +| Quando | Azione | Chi | +|--------|--------|-----| +| 31 giorni prima | Limitare il dispositivo affinché nessun nuovo utente possa connettersi (`--max-users 0`) | Contributor | +| 14 giorni prima | Gli utenti connessi vengono notificati di migrare verso un altro dispositivo | Team DoubleZero | +| Finestra di preavviso | Gli utenti si riconnettono autonomamente ad altri DZD | Utenti | +| Giorno della dismissione | Drenare ed eliminare i link, le interfacce e il dispositivo | Contributor | + +Principi: + +- **Bloccare i nuovi utenti in anticipo, migrare quelli esistenti gradualmente.** Limitare il dispositivo in anticipo significa che da quel momento in poi perderà solo utenti. Gli utenti esistenti continuano a funzionare e migrano secondo i propri tempi. +- **Mantenere tutto operativo durante la finestra di preavviso.** Non drenare i link né il dispositivo fino al giorno della dismissione, affinché gli utenti in fase di migrazione mantengano il servizio regolare. +- **L'ordine di smantellamento è imposto dal contratto.** Non è possibile eliminare un link o un dispositivo mentre è attivo, pertanto i passaggi seguenti prevedono prima il drenaggio e poi l'eliminazione. + +> ⚠️ **Preavviso breve:** +> Se hai meno di 31 giorni prima dell'uscita, inizia immediatamente. Limita il dispositivo subito e riduci le finestre temporali per adattarle al tempo disponibile. L'ordine dei passaggi non cambia. + +--- + +## Fase 1 — Limitare il dispositivo (31 giorni prima) + +Limita il dispositivo affinché nessun nuovo utente possa connettersi: + +```bash +doublezero device update --pubkey --max-users 0 +``` + +Gli utenti esistenti non vengono toccati e continuano a funzionare. Ripeti per ogni dispositivo in dismissione presso il sito. I link e il dispositivo restano pienamente attivi, così gli utenti connessi mantengono il servizio regolare. + +--- + +## Fase 2 — Finestra di preavviso (14 giorni prima) + +Il team di DoubleZero notifica gli utenti connessi, chiedendo loro di riconnettersi a un DZD diverso prima della data di dismissione. Coordinati con il team su chi contatta quali utenti. + +Nulla viene drenato durante questa finestra, quindi gli utenti mantengono il servizio regolare. Gli utenti si riconnettono autonomamente secondo i propri tempi. Monitora il numero di utenti con: + +```bash +doublezero device list +``` + +--- + +## Fase 3 — Giorno della dismissione + +Esegui questi passaggi in ordine. Ogni passaggio sblocca il successivo. + +> ⚠️ **Prima dell'eliminazione finale del dispositivo:** +> Notifica la DoubleZero Foundation prima di eseguire l'ultimo passaggio. La Foundation rimuove gli utenti che non hanno migrato in tempo, i quali altrimenti bloccherebbero l'eliminazione, e completa tutte le operazioni necessarie da parte della fondazione. + +### 1. Drenare i link + +Prima il soft-drain, poi l'hard-drain. Consulta [Link Draining](contribute-operations.md#link-draining) per capire cosa fa ciascuno stato. + +```bash +doublezero link update --pubkey --status soft-drained +# una volta che il traffico è stato spostato: +doublezero link update --pubkey --status hard-drained +``` + +Ripeti per ogni link sui dispositivi in fase di rimozione. + +### 2. Eliminare i link + +```bash +doublezero link delete --pubkey +``` + +Questo libera le interfacce che i link stavano utilizzando. + +### 3. Eliminare le interfacce + +```bash +doublezero device interface delete +``` + +Ripeti per ogni interfaccia sul dispositivo. + +### 4. Drenare il dispositivo + +```bash +doublezero device update --pubkey --status drained +``` + +Il drenaggio rimuove il dispositivo dal routing e chiude tutte le sessioni utente rimanenti. Inoltre, sposta il dispositivo fuori dal suo stato attivo in modo che possa essere eliminato. + +### 5. Eliminare il dispositivo + +```bash +doublezero device delete --pubkey +``` + +Il dispositivo può essere eliminato solo quando non è più attivo, non ha link che lo referenziano e non ha più interfacce rimaste, condizioni gestite dai passaggi precedenti. + +--- + +## Annullamento o posticipo + +La limitazione e il drenaggio sono reversibili finché non si inizia a eliminare: + +```bash +doublezero device update --pubkey --max-users # ripristina la capacità +doublezero link update --pubkey --status soft-drained # da hard-drained +doublezero link update --pubkey --status activated # ritorno ad attivo +doublezero device update --pubkey --status activated # annulla il drenaggio del dispositivo +``` + +L'eliminazione dei link, delle interfacce o del dispositivo è permanente: chiude gli account onchain. Inizia a eliminare solo quando l'uscita è confermata. \ No newline at end of file diff --git a/docs/contribute-decommission.ja.md b/docs/contribute-decommission.ja.md new file mode 100644 index 0000000..6eb83cd --- /dev/null +++ b/docs/contribute-decommission.ja.md @@ -0,0 +1,120 @@ +# サイト廃止ガイド（コントリビューター向け） + +本ガイドでは、DoubleZero Device（DZD）の廃止またはサイトからの撤退方法について説明します。接続中のユーザーに影響を与えることなく、デバイスとリンクをネットワークから削除し、オンチェーンで削除する手順を解説します。 + +プロセスは3つの段階で進行します。廃止日の31日前にデバイスの上限を設定し、通知期間中に接続ユーザーに移行を通知して移動の猶予を与え、廃止日にリンク、インターフェース、デバイスのドレインと削除を実施します。 + +> ⚠️ **まずDoubleZeroと調整してください：** +> デバイスやサイトを廃止する前に、必ずDoubleZeroチームと事前に調整してください。デバイスの上限設定やリンクのドレインを行う前に、日程と計画について合意し、ユーザー移行およびファウンデーション側で必要な手順を調整できるようにしてください。 + +--- + +## 概要 + +| タイミング | アクション | 担当者 | +|------|--------|-----| +| 31日前 | 新規ユーザーが接続できないようデバイスの上限を設定（`--max-users 0`） | コントリビューター | +| 14日前 | 接続中のユーザーに別のデバイスへの移行を通知 | DoubleZeroチーム | +| 通知期間 | ユーザーが自ら他のDZDに再接続 | ユーザー | +| 廃止日 | リンク、インターフェース、デバイスのドレインと削除 | コントリビューター | + +原則： + +- **新規ユーザーを早期に停止し、既存ユーザーは段階的に移行。** デバイスの上限を早期に設定することで、その時点以降はユーザーが減少するのみとなります。既存ユーザーは引き続き利用可能で、各自のスケジュールで移行します。 +- **通知期間中はすべてを稼働状態に保つ。** 廃止日までリンクやデバイスのドレインは行わないでください。移行中のユーザーが通常通りサービスを利用できるようにするためです。 +- **解体の順序はコントラクトにより強制されます。** アクティブ状態のリンクやデバイスは削除できないため、以下の手順ではまずドレインを行い、最後に削除します。 + +> ⚠️ **緊急の場合：** +> 撤退まで31日未満の場合は、直ちに開始してください。今すぐデバイスの上限を設定し、利用可能な期間に合わせてウィンドウを短縮してください。手順の順序は変わりません。 + +--- + +## フェーズ1 — デバイスの上限設定（31日前） + +新規ユーザーが接続できないようデバイスの上限を設定します： + +```bash +doublezero device update --pubkey --max-users 0 +``` + +既存ユーザーには影響がなく、引き続き利用できます。サイトで廃止対象となるすべてのデバイスに対して繰り返し実行してください。リンクとデバイスは完全にアクティブな状態を維持するため、接続中のユーザーは通常通りサービスを利用できます。 + +--- + +## フェーズ2 — 通知期間（14日前） + +DoubleZeroチームが接続中のユーザーに通知し、廃止日までに別のDZDに再接続するよう依頼します。どのユーザーに誰が連絡するかについて、チームと調整してください。 + +この期間中はドレインを行わないため、ユーザーは通常通りサービスを利用できます。ユーザーは各自のペースで再接続します。以下のコマンドでユーザー数を監視してください： + +```bash +doublezero device list +``` + +--- + +## フェーズ3 — 廃止日 + +以下の手順を順番に実行してください。各手順が次の手順を解除します。 + +> ⚠️ **最終的なデバイス削除の前に：** +> 最後の手順を実行する前にDoubleZero Foundationに通知してください。Foundationは期限内に移行しなかったユーザーを削除します（これを行わないと削除がブロックされます）。また、ファウンデーション側で必要な手順も完了します。 + +### 1. リンクのドレイン + +まずソフトドレイン、次にハードドレインを実行します。各状態の詳細については[Link Draining](contribute-operations.md#link-draining)を参照してください。 + +```bash +doublezero link update --pubkey --status soft-drained +# トラフィックが移動したら： +doublezero link update --pubkey --status hard-drained +``` + +削除対象のデバイス上のすべてのリンクに対して繰り返し実行してください。 + +### 2. リンクの削除 + +```bash +doublezero link delete --pubkey +``` + +これにより、リンクが使用していたインターフェースが解放されます。 + +### 3. インターフェースの削除 + +```bash +doublezero device interface delete +``` + +デバイス上の各インターフェースに対して繰り返し実行してください。 + +### 4. デバイスのドレイン + +```bash +doublezero device update --pubkey --status drained +``` + +ドレインにより、デバイスがルーティングから除外され、残存するユーザーセッションがすべて終了します。また、デバイスをアクティブ状態から移行させ、削除可能な状態にします。 + +### 5. デバイスの削除 + +```bash +doublezero device delete --pubkey +``` + +デバイスの削除は、アクティブ状態でなくなり、参照しているリンクがなく、インターフェースが残っていない場合にのみ可能です。これらは前の手順で処理されています。 + +--- + +## キャンセルまたは延期 + +上限設定とドレインは、削除を開始するまで元に戻すことができます： + +```bash +doublezero device update --pubkey --max-users # 容量を復元 +doublezero link update --pubkey --status soft-drained # ハードドレインから戻す +doublezero link update --pubkey --status activated # アクティブに戻す +doublezero device update --pubkey --status activated # デバイスのドレインを解除 +``` + +リンク、インターフェース、またはデバイスの削除は永続的であり、オンチェーンアカウントが閉鎖されます。撤退が確定してから削除を開始してください。 \ No newline at end of file diff --git a/docs/contribute-decommission.ko.md b/docs/contribute-decommission.ko.md new file mode 100644 index 0000000..cdcde59 --- /dev/null +++ b/docs/contribute-decommission.ko.md @@ -0,0 +1,120 @@ +# 사이트 해제 가이드 (기여자용) + +이 가이드는 DoubleZero Device(DZD)를 해제하거나 사이트를 종료하는 방법을 설명합니다. 연결된 사용자에게 지장을 주지 않으면서 네트워크에서 장치와 링크를 제거한 후 온체인에서 삭제하는 절차입니다. + +프로세스는 세 단계로 진행됩니다: 해제일 31일 전에 장치를 제한하고, 공지 기간 동안 연결된 사용자에게 이전을 알린 후, 해제일에 링크, 인터페이스, 장치를 드레인하고 삭제합니다. + +> ⚠️ **먼저 DoubleZero와 조율하세요:** +> 장치나 사이트를 해제하기 전에 항상 DoubleZero 팀과 사전 조율하세요. 장치를 제한하거나 링크를 드레인하기 전에 날짜와 계획에 합의하여, 사용자 이전과 재단 측에서 필요한 단계를 조율할 수 있도록 하세요. + +--- + +## 개요 + +| 시점 | 조치 | 담당 | +|------|------|------| +| 31일 전 | 신규 사용자가 연결할 수 없도록 장치 제한 (`--max-users 0`) | 기여자 | +| 14일 전 | 연결된 사용자에게 다른 장치로 이전하도록 알림 | DoubleZero 팀 | +| 공지 기간 | 사용자가 직접 다른 DZD로 재연결 | 사용자 | +| 해제일 | 링크, 인터페이스, 장치를 드레인하고 삭제 | 기여자 | + +원칙: + +- **신규 사용자는 조기에 차단하고, 기존 사용자는 점진적으로 이전합니다.** 장치를 조기에 제한하면 해당 시점부터 신규 사용자만 차단됩니다. 기존 사용자는 계속 서비스를 이용하며 자신의 일정에 맞춰 이전합니다. +- **공지 기간 동안 모든 것을 가동 상태로 유지합니다.** 이전 중인 사용자가 정상적인 서비스를 유지할 수 있도록 해제일까지 링크나 장치를 드레인하지 마세요. +- **해체 순서는 컨트랙트에 의해 강제됩니다.** 활성 상태인 링크나 장치는 삭제할 수 없으므로, 아래 단계에서는 먼저 드레인한 후 마지막에 삭제합니다. + +> ⚠️ **촉박한 일정:** +> 종료까지 31일 미만인 경우 즉시 시작하세요. 지금 장치를 제한하고 가용 시간에 맞춰 기간을 단축하세요. 단계 순서는 변경되지 않습니다. + +--- + +## 1단계 — 장치 제한 (31일 전) + +신규 사용자가 연결할 수 없도록 장치를 제한합니다: + +```bash +doublezero device update --pubkey --max-users 0 +``` + +기존 사용자는 영향을 받지 않으며 계속 정상적으로 사용할 수 있습니다. 사이트에서 해제할 모든 장치에 대해 반복하세요. 링크와 장치는 완전히 활성 상태를 유지하므로 연결된 사용자는 정상적인 서비스를 계속 이용합니다. + +--- + +## 2단계 — 공지 기간 (14일 전) + +DoubleZero 팀이 연결된 사용자에게 해제일 전에 다른 DZD로 재연결하도록 알립니다. 어떤 사용자에게 누가 연락할지 팀과 조율하세요. + +이 기간 동안에는 드레인하지 않으므로 사용자는 정상적인 서비스를 유지합니다. 사용자는 자신의 속도에 맞춰 재연결합니다. 다음 명령으로 사용자 수를 모니터링하세요: + +```bash +doublezero device list +``` + +--- + +## 3단계 — 해제일 + +아래 단계를 순서대로 실행하세요. 각 단계가 다음 단계를 해제합니다. + +> ⚠️ **최종 장치 삭제 전:** +> 마지막 단계를 실행하기 전에 DoubleZero Foundation에 알리세요. Foundation은 제때 이전하지 않은 사용자를 제거하여(그렇지 않으면 삭제가 차단됨) 재단 측에서 필요한 단계를 완료합니다. + +### 1. 링크 드레인 + +소프트 드레인을 먼저 수행한 후 하드 드레인을 수행합니다. 각 상태의 의미는 [Link Draining](contribute-operations.md#link-draining)을 참조하세요. + +```bash +doublezero link update --pubkey --status soft-drained +# 트래픽이 이동된 후: +doublezero link update --pubkey --status hard-drained +``` + +제거할 장치의 모든 링크에 대해 반복하세요. + +### 2. 링크 삭제 + +```bash +doublezero link delete --pubkey +``` + +링크가 사용하던 인터페이스가 해제됩니다. + +### 3. 인터페이스 삭제 + +```bash +doublezero device interface delete +``` + +장치의 각 인터페이스에 대해 반복하세요. + +### 4. 장치 드레인 + +```bash +doublezero device update --pubkey --status drained +``` + +드레인하면 장치가 라우팅에서 제거되고 남아 있는 모든 사용자 세션이 종료됩니다. 또한 장치를 활성 상태에서 이동시켜 삭제할 수 있도록 합니다. + +### 5. 장치 삭제 + +```bash +doublezero device delete --pubkey +``` + +장치는 더 이상 활성 상태가 아니고, 참조하는 링크가 없으며, 남아 있는 인터페이스가 없어야만 삭제할 수 있습니다. 이전 단계에서 이 조건을 처리합니다. + +--- + +## 취소 또는 연기 + +제한과 드레인은 삭제를 시작하기 전까지 되돌릴 수 있습니다: + +```bash +doublezero device update --pubkey --max-users # 용량 복원 +doublezero link update --pubkey --status soft-drained # 하드 드레인에서 복원 +doublezero link update --pubkey --status activated # 활성 상태로 복원 +doublezero device update --pubkey --status activated # 장치 드레인 해제 +``` + +링크, 인터페이스 또는 장치의 삭제는 영구적입니다: 온체인 계정이 폐쇄됩니다. 종료가 확정된 후에만 삭제를 시작하세요. \ No newline at end of file diff --git a/docs/contribute-decommission.pt.md b/docs/contribute-decommission.pt.md new file mode 100644 index 0000000..7ae66fb --- /dev/null +++ b/docs/contribute-decommission.pt.md @@ -0,0 +1,120 @@ +# Guia de Descomissionamento de Site para Contribuidores + +Este guia descreve como descomissionar um Dispositivo DoubleZero (DZD) ou encerrar um site: como remover seus dispositivos e links da rede sem interromper os usuários conectados, e depois excluí-los onchain. + +O processo ocorre em três etapas: limitar o dispositivo 31 dias antes do dia do descomissionamento, notificar os usuários conectados durante uma janela de aviso para que possam migrar, e então drenar e excluir os links, interfaces e dispositivo no dia do descomissionamento. + +> ⚠️ **Coordene com a DoubleZero primeiro:** +> Sempre alinhe com a equipe da DoubleZero antes de descomissionar um dispositivo ou site. Concorde com as datas e o plano antes de limitar um dispositivo ou drenar um link, para que a migração dos usuários e as etapas necessárias do lado da fundação possam ser coordenadas. + +--- + +## Visão Geral + +| Quando | Ação | Quem | +|--------|------|------| +| 31 dias antes | Limitar o dispositivo para que novos usuários não possam se conectar (`--max-users 0`) | Contribuidor | +| 14 dias antes | Usuários conectados são notificados para migrar para outro dispositivo | Equipe DoubleZero | +| Janela de aviso | Usuários se reconectam a outros DZDs | Usuários | +| Dia do descomissionamento | Drenar e excluir os links, interfaces e dispositivo | Contribuidor | + +Princípios: + +- **Pare novos usuários cedo, migre usuários existentes gradualmente.** Limitar o dispositivo cedo significa que ele apenas perde usuários a partir desse ponto. Usuários existentes continuam funcionando e migram no seu próprio ritmo. +- **Mantenha tudo ativo durante a janela de aviso.** Não drene os links ou o dispositivo até o dia do descomissionamento, para que os usuários em migração mantenham o serviço normal. +- **A ordem de desmontagem é imposta pelo contrato.** Você não pode excluir um link ou dispositivo enquanto estiver ativo, então as etapas abaixo drenam primeiro e excluem por último. + +> ⚠️ **Aviso com pouca antecedência:** +> Se você tiver menos de 31 dias antes da saída, comece imediatamente. Limite o dispositivo agora e encurte as janelas para caber no tempo disponível. A ordem das etapas não muda. + +--- + +## Fase 1 — Limitar o dispositivo (31 dias antes) + +Limite o dispositivo para que novos usuários não possam se conectar: + +```bash +doublezero device update --pubkey --max-users 0 +``` + +Usuários existentes não são afetados e continuam funcionando. Repita para cada dispositivo sendo descomissionado no site. Os links e o dispositivo permanecem totalmente ativos, para que os usuários conectados mantenham o serviço normal. + +--- + +## Fase 2 — Janela de aviso (14 dias antes) + +A equipe DoubleZero notifica os usuários conectados, pedindo que se reconectem a um DZD diferente antes da data de descomissionamento. Coordene com a equipe sobre quem entra em contato com quais usuários. + +Nada é drenado durante esta janela, para que os usuários mantenham o serviço normal. Os usuários se reconectam no seu próprio ritmo. Monitore a contagem de usuários com: + +```bash +doublezero device list +``` + +--- + +## Fase 3 — Dia do descomissionamento + +Execute estas etapas em ordem. Cada etapa desbloqueia a próxima. + +> ⚠️ **Antes da exclusão final do dispositivo:** +> Notifique a Fundação DoubleZero antes de executar a última etapa. A Fundação remove quaisquer usuários que não migraram a tempo, o que de outra forma bloquearia a exclusão, e conclui quaisquer etapas necessárias do lado da fundação. + +### 1. Drenar os links + +Faça a drenagem suave primeiro, depois a drenagem forçada. Veja [Drenagem de Links](contribute-operations.md#link-draining) para saber o que cada estado faz. + +```bash +doublezero link update --pubkey --status soft-drained +# quando o tráfego tiver sido movido: +doublezero link update --pubkey --status hard-drained +``` + +Repita para cada link nos dispositivos sendo removidos. + +### 2. Excluir os links + +```bash +doublezero link delete --pubkey +``` + +Isso libera as interfaces que os links estavam utilizando. + +### 3. Excluir as interfaces + +```bash +doublezero device interface delete +``` + +Repita para cada interface no dispositivo. + +### 4. Drenar o dispositivo + +```bash +doublezero device update --pubkey --status drained +``` + +A drenagem remove o dispositivo do roteamento e encerra quaisquer sessões de usuário restantes. Também move o dispositivo para fora do seu estado ativo para que possa ser excluído. + +### 5. Excluir o dispositivo + +```bash +doublezero device delete --pubkey +``` + +O dispositivo só pode ser excluído quando não estiver mais ativo, não tiver links referenciando-o e não tiver interfaces restantes, o que as etapas anteriores tratam. + +--- + +## Cancelando ou adiando + +Limitar e drenar são reversíveis até que você comece a excluir: + +```bash +doublezero device update --pubkey --max-users # restaurar capacidade +doublezero link update --pubkey --status soft-drained # a partir de hard-drained +doublezero link update --pubkey --status activated # de volta ao ativo +doublezero device update --pubkey --status activated # reverter drenagem do dispositivo +``` + +Excluir os links, interfaces ou dispositivo é permanente: fecha as contas onchain. Só comece a excluir quando a saída estiver confirmada. \ No newline at end of file diff --git a/docs/contribute-decommission.zh.md b/docs/contribute-decommission.zh.md new file mode 100644 index 0000000..85f616a --- /dev/null +++ b/docs/contribute-decommission.zh.md @@ -0,0 +1,120 @@ +# 站点退役指南（贡献者） + +本指南介绍如何退役 DoubleZero 设备（DZD）或退出站点：如何在不影响已连接用户的情况下从网络中移除您的设备和链路，然后在链上删除它们。 + +整个流程分为三个阶段：在退役日前 31 天对设备设置上限，在通知窗口期间通知已连接的用户以便他们迁移，然后在退役当天排空并删除链路、接口和设备。 + +> ⚠️ **请先与 DoubleZero 协调：** +> 在退役设备或站点之前，务必与 DoubleZero 团队保持一致。在对设备设置上限或排空链路之前，请先商定日期和计划，以便协调用户迁移以及基金会侧所需的步骤。 + +--- + +## 概述 + +| 时间 | 操作 | 负责方 | +|------|------|--------| +| 31 天前 | 对设备设置上限，使新用户无法接入（`--max-users 0`） | 贡献者 | +| 14 天前 | 通知已连接用户迁移至其他设备 | DoubleZero 团队 | +| 通知窗口期 | 用户自行重新连接到其他 DZD | 用户 | +| 退役当天 | 排空并删除链路、接口和设备 | 贡献者 | + +原则： + +- **尽早停止新用户接入，逐步迁移现有用户。** 提前对设备设置上限意味着从该时刻起只会流失用户。现有用户继续正常工作，按照自己的节奏进行迁移。 +- **在通知窗口期内保持所有服务正常运行。** 在退役当天之前不要排空链路或设备，以确保迁移中的用户保持正常服务。 +- **拆除顺序由合约强制执行。** 链路或设备在活跃状态下无法删除，因此以下步骤先排空再删除。 + +> ⚠️ **时间紧迫的情况：** +> 如果距离退出不足 31 天，请立即开始。现在就对设备设置上限，并根据可用时间压缩各窗口期。步骤顺序不变。 + +--- + +## 阶段 1 — 对设备设置上限（31 天前） + +对设备设置上限，使新用户无法接入： + +```bash +doublezero device update --pubkey --max-users 0 +``` + +现有用户不受影响，继续正常工作。对站点中每个待退役的设备重复此操作。链路和设备保持完全活跃，已连接用户继续享受正常服务。 + +--- + +## 阶段 2 — 通知窗口期（14 天前） + +DoubleZero 团队通知已连接的用户，要求他们在退役日期之前重新连接到其他 DZD。请与团队协调由谁联系哪些用户。 + +此窗口期内不进行任何排空操作，用户继续享受正常服务。用户按照自己的节奏进行重新连接。使用以下命令监控用户数量： + +```bash +doublezero device list +``` + +--- + +## 阶段 3 — 退役当天 + +按顺序执行以下步骤。每个步骤解锁下一个步骤。 + +> ⚠️ **在最终删除设备之前：** +> 在执行最后一步之前，请通知 DoubleZero Foundation。基金会会移除未及时迁移的用户（否则这些用户会阻止删除操作），并完成基金会侧所需的步骤。 + +### 1. 排空链路 + +先软排空，再硬排空。请参阅[链路排空](contribute-operations.md#link-draining)了解每种状态的作用。 + +```bash +doublezero link update --pubkey --status soft-drained +# 流量迁移完成后： +doublezero link update --pubkey --status hard-drained +``` + +对待移除设备上的每条链路重复此操作。 + +### 2. 删除链路 + +```bash +doublezero link delete --pubkey +``` + +这将释放链路之前使用的接口。 + +### 3. 删除接口 + +```bash +doublezero device interface delete +``` + +对设备上的每个接口重复此操作。 + +### 4. 排空设备 + +```bash +doublezero device update --pubkey --status drained +``` + +排空操作会将设备从路由中移除并关闭所有剩余的用户会话。同时将设备从活跃状态移出，使其可以被删除。 + +### 5. 删除设备 + +```bash +doublezero device delete --pubkey +``` + +设备只有在不再处于活跃状态、没有链路引用它、且没有剩余接口的情况下才能被删除，前面的步骤已处理了这些前提条件。 + +--- + +## 取消或推迟 + +在开始删除之前，设置上限和排空操作都是可逆的： + +```bash +doublezero device update --pubkey --max-users # 恢复容量 +doublezero link update --pubkey --status soft-drained # 从硬排空恢复 +doublezero link update --pubkey --status activated # 恢复为活跃状态 +doublezero device update --pubkey --status activated # 取消设备排空 +``` + +删除链路、接口或设备是永久性操作：它会关闭链上账户。请在确认退出后再开始删除。 \ No newline at end of file From 7d4998b6ff89d71f96ce7804561d426bc86e56cc Mon Sep 17 00:00:00 2001 From: Thijs van Emmerik Date: Thu, 9 Jul 2026 08:43:28 +0000 Subject: [PATCH 3/5] =?UTF-8?q?docs:=20address=20review=20=E2=80=94=20sche?= =?UTF-8?q?duling,=20discovery=20commands,=20DZX=20guidance?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/contribute-decommission.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/contribute-decommission.md b/docs/contribute-decommission.md index 9609a35..403db41 100644 --- a/docs/contribute-decommission.md +++ b/docs/contribute-decommission.md @@ -5,7 +5,10 @@ This guide describes how to decommission a DoubleZero Device (DZD) or exit a sit The process runs in three stages: cap the device 31 days before decommission day, notify connected users during a notice window so they can move, then drain and delete the links, interfaces, and device on decommission day. > ⚠️ **Coordinate with DoubleZero first:** -> Always align with the DoubleZero team before decommissioning a device or site. Agree on the dates and plan before you cap a device or drain a link, so user migration and the required foundation-side steps can be coordinated. +> Always align with the DoubleZero team before decommissioning a device or site, and schedule your decommission date and time with us. We run a few steps on our side around that slot, so we need to be scheduled in. Agree on the dates and plan before you cap a device or drain a link. + +> ⚠️ **DZX and cross-contributor links:** +> If the device is a DZX or carries links to other contributors, identify those contributors as early as possible and give them notice, since they may need to move or rebuild their links before your date. Also create a maintenance event in the [OPS portal](contribute-ops-management.md) for the decommission date. --- @@ -55,6 +58,14 @@ doublezero device list ## Phase 3 — Decommission day +Before you start, work out exactly what needs to be removed: the device, the links connected to it, and the interfaces to clean up. You can find all of this with: + +```bash +doublezero device list | grep # find your device: its code and pubkey +doublezero link list | grep # find the links connected to the device +doublezero device interface list # list the interfaces on the device to remove +``` + Run these steps in order. Each step unlocks the next. > ⚠️ **Before the final device deletion:** From 0b8d1810c20c8a3de7d946d8791cd5f2b4ba2539 Mon Sep 17 00:00:00 2001 From: Thijs van Emmerik Date: Thu, 9 Jul 2026 16:30:20 +0000 Subject: [PATCH 4/5] docs: clarify DZX switch/link notice in decommission guide --- docs/contribute-decommission.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contribute-decommission.md b/docs/contribute-decommission.md index 403db41..ab3646a 100644 --- a/docs/contribute-decommission.md +++ b/docs/contribute-decommission.md @@ -7,8 +7,8 @@ The process runs in three stages: cap the device 31 days before decommission day > ⚠️ **Coordinate with DoubleZero first:** > Always align with the DoubleZero team before decommissioning a device or site, and schedule your decommission date and time with us. We run a few steps on our side around that slot, so we need to be scheduled in. Agree on the dates and plan before you cap a device or drain a link. -> ⚠️ **DZX and cross-contributor links:** -> If the device is a DZX or carries links to other contributors, identify those contributors as early as possible and give them notice, since they may need to move or rebuild their links before your date. Also create a maintenance event in the [OPS portal](contribute-ops-management.md) for the decommission date. +> ⚠️ **DZX switches and links:** +> If the device you are decommissioning is a DZX switch, or has any DZX links, identify the affected contributors as early as possible and give them notice, since they may need to move or rebuild their links before your date. Also create a maintenance event in the [OPS portal](contribute-ops-management.md) for the decommission date. --- From 621a7d9bc9bc11245c43cc65f36272fa9f32bae1 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 9 Jul 2026 16:34:57 +0000 Subject: [PATCH 5/5] chore: auto-translate docs --- docs/contribute-decommission.es.md | 63 ++++++++++++++----------- docs/contribute-decommission.fr.md | 43 ++++++++++------- docs/contribute-decommission.it.md | 75 +++++++++++++++++------------- docs/contribute-decommission.ja.md | 61 ++++++++++++++---------- docs/contribute-decommission.ko.md | 59 +++++++++++++---------- docs/contribute-decommission.pt.md | 49 +++++++++++-------- docs/contribute-decommission.zh.md | 67 +++++++++++++++----------- 7 files changed, 247 insertions(+), 170 deletions(-) diff --git a/docs/contribute-decommission.es.md b/docs/contribute-decommission.es.md index 094eb2f..a60896d 100644 --- a/docs/contribute-decommission.es.md +++ b/docs/contribute-decommission.es.md @@ -1,51 +1,54 @@ -# Guía de desmantelamiento de sitio para Contribuidores +# Guía de desmantelamiento de sitio para contribuidores -Esta guía describe cómo desmantelar un Dispositivo DoubleZero (DZD) o dar de baja un sitio: cómo retirar tus dispositivos y enlaces de la red sin interrumpir a los usuarios conectados, y luego eliminarlos onchain. +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. -El proceso se ejecuta en tres etapas: 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. +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. -> ⚠️ **Coordina con DoubleZero primero:** -> Siempre alinéate con el equipo de DoubleZero antes de desmantelar un dispositivo o sitio. Acuerda las fechas y el plan antes de limitar un dispositivo o drenar un enlace, para que la migración de usuarios y los pasos requeridos por parte de la fundación puedan coordinarse. +> ⚠️ **Coordine con DoubleZero primero:** +> 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. + +> ⚠️ **Switches y enlaces DZX:** +> 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. --- -## Descripción general +## Resumen | Cuándo | Acción | Quién | |--------|--------|-------| -| 31 días antes | Limitar el dispositivo para que no se puedan conectar nuevos usuarios (`--max-users 0`) | Contribuidor | +| 31 días antes | Limitar el dispositivo para que nuevos usuarios no puedan conectarse (`--max-users 0`) | Contribuidor | | 14 días antes | Los usuarios conectados son notificados para migrar a otro dispositivo | Equipo de DoubleZero | | Período de aviso | Los usuarios se reconectan por su cuenta a otros DZDs | Usuarios | | Día de desmantelamiento | Drenar y eliminar los enlaces, interfaces y el dispositivo | Contribuidor | Principios: -- **Detener nuevos usuarios temprano, mover usuarios existentes gradualmente.** Limitar el dispositivo temprano significa que solo pierde usuarios a partir de ese momento. Los usuarios existentes siguen funcionando y migran a su propio ritmo. -- **Mantener todo activo durante el período de aviso.** No drenes los enlaces ni el dispositivo hasta el día de desmantelamiento, para que los usuarios en proceso de migración mantengan el servicio normal. -- **El orden de desmontaje es impuesto por el contrato.** No puedes eliminar un enlace o dispositivo mientras está activo, por lo que los pasos a continuación drenan primero y eliminan al final. +- **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. +- **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. +- **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. -> ⚠️ **Aviso con poca antelación:** -> Si tienes menos de 31 días antes de la salida, comienza inmediatamente. Limita el dispositivo ahora y acorta los períodos para ajustarte al tiempo disponible. El orden de los pasos no cambia. +> ⚠️ **Aviso con poco tiempo:** +> 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. --- ## Fase 1 — Limitar el dispositivo (31 días antes) -Limita el dispositivo para que no se puedan conectar nuevos usuarios: +Limite el dispositivo para que nuevos usuarios no puedan conectarse: ```bash doublezero device update --pubkey --max-users 0 ``` -Los usuarios existentes no se ven afectados y siguen funcionando. Repite para cada dispositivo que se esté desmantelando en el sitio. Los enlaces y el dispositivo permanecen completamente activos, por lo que los usuarios conectados mantienen el servicio normal. +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. --- ## Fase 2 — Período de aviso (14 días antes) -El equipo de DoubleZero notifica a los usuarios conectados, pidiéndoles que se reconecten a un DZD diferente antes de la fecha de desmantelamiento. Coordina con el equipo sobre quién contacta a qué usuarios. +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. -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. Monitorea el conteo de usuarios con: +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: ```bash doublezero device list @@ -55,14 +58,22 @@ doublezero device list ## Fase 3 — Día de desmantelamiento -Ejecuta estos pasos en orden. Cada paso desbloquea el siguiente. +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: + +```bash +doublezero device list | grep # encontrar su dispositivo: su código y pubkey +doublezero link list | grep # encontrar los enlaces conectados al dispositivo +doublezero device interface list # listar las interfaces del dispositivo a eliminar +``` + +Ejecute estos pasos en orden. Cada paso desbloquea el siguiente. > ⚠️ **Antes de la eliminación final del dispositivo:** -> Notifica a la Fundación DoubleZero antes de ejecutar el último paso. La Fundación elimina a los usuarios que no migraron a tiempo, lo cual de otro modo bloquearía la eliminación, y completa los pasos requeridos por parte de la fundación. +> 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. ### 1. Drenar los enlaces -Primero drenado suave, luego drenado fuerte. Consulta [Drenado de enlaces](contribute-operations.md#link-draining) para conocer qué hace cada estado. +Primero drenado suave, luego drenado fuerte. Consulte [Drenado de enlaces](contribute-operations.md#link-draining) para conocer qué hace cada estado. ```bash doublezero link update --pubkey --status soft-drained @@ -70,7 +81,7 @@ doublezero link update --pubkey --status soft-drained doublezero link update --pubkey --status hard-drained ``` -Repite para cada enlace en los dispositivos que se están retirando. +Repita para cada enlace en los dispositivos que se van a retirar. ### 2. Eliminar los enlaces @@ -78,7 +89,7 @@ Repite para cada enlace en los dispositivos que se están retirando. doublezero link delete --pubkey ``` -Esto libera las interfaces que los enlaces estaban utilizando. +Esto libera las interfaces que los enlaces estaban usando. ### 3. Eliminar las interfaces @@ -86,7 +97,7 @@ Esto libera las interfaces que los enlaces estaban utilizando. doublezero device interface delete ``` -Repite para cada interfaz en el dispositivo. +Repita para cada interfaz en el dispositivo. ### 4. Drenar el dispositivo @@ -102,13 +113,13 @@ El drenado elimina el dispositivo del enrutamiento y cierra cualquier sesión de doublezero device delete --pubkey ``` -El dispositivo solo puede eliminarse 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 gestionar. +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. --- -## Cancelar o posponer +## Cancelación o aplazamiento -Limitar y drenar son reversibles hasta que comiences a eliminar: +Limitar y drenar son reversibles hasta que comience a eliminar: ```bash doublezero device update --pubkey --max-users # restaurar capacidad @@ -117,4 +128,4 @@ doublezero link update --pubkey --status activated doublezero device update --pubkey --status activated # revertir el drenado del dispositivo ``` -Eliminar los enlaces, interfaces o el dispositivo es permanente: cierra las cuentas onchain. Solo comienza a eliminar una vez que la salida esté confirmada. \ No newline at end of file +Eliminar los enlaces, interfaces o el dispositivo es permanente: cierra las cuentas onchain. Solo comience a eliminar una vez que la salida esté confirmada. \ No newline at end of file diff --git a/docs/contribute-decommission.fr.md b/docs/contribute-decommission.fr.md index 0b2ca07..3bb430c 100644 --- a/docs/contribute-decommission.fr.md +++ b/docs/contribute-decommission.fr.md @@ -1,11 +1,14 @@ -# Guide de mise hors service d'un site pour les contributeurs +# Guide de désaffectation de site pour les contributeurs -Ce guide décrit comment mettre hors service 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 onchain. +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. -Le processus se déroule en trois étapes : plafonner l'appareil 31 jours avant le jour de la mise hors service, notifier les utilisateurs connectés pendant une période de préavis afin qu'ils puissent migrer, puis drainer et supprimer les liens, interfaces et l'appareil le jour de la mise hors service. +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. > ⚠️ **Coordonnez-vous d'abord avec DoubleZero :** -> Alignez-vous toujours avec l'équipe DoubleZero avant de mettre hors service un appareil ou un site. Convenez des dates et du plan avant de plafonner un appareil ou de drainer un lien, afin que la migration des utilisateurs et les étapes requises côté fondation puissent être coordonnées. +> 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. + +> ⚠️ **Commutateurs et liens DZX :** +> 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. --- @@ -15,17 +18,17 @@ Le processus se déroule en trois étapes : plafonner l'appareil 31 jours avant |-------|--------|-----| | 31 jours avant | Plafonner l'appareil pour qu'aucun nouvel utilisateur ne puisse s'y connecter (`--max-users 0`) | Contributeur | | 14 jours avant | Les utilisateurs connectés sont notifiés de migrer vers un autre appareil | Équipe DoubleZero | -| Période de préavis | Les utilisateurs se reconnectent eux-mêmes à d'autres DZD | Utilisateurs | -| Jour de la mise hors service | Drainer et supprimer les liens, interfaces et l'appareil | Contributeur | +| Fenêtre de préavis | Les utilisateurs se reconnectent eux-mêmes à d'autres DZD | Utilisateurs | +| Jour de la désaffectation | Drainer et supprimer les liens, interfaces et l'appareil | Contributeur | Principes : - **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. -- **Tout maintenir en service pendant la période de préavis.** Ne drainez pas les liens ni l'appareil avant le jour de la mise hors service, afin que les utilisateurs en cours de migration conservent un service normal. -- **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 drainent donc en premier et suppriment en dernier. +- **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. +- **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. > ⚠️ **Préavis court :** -> Si vous disposez de moins de 31 jours avant la sortie, commencez immédiatement. Plafonnez l'appareil maintenant et raccourcissez les délais pour les adapter au temps disponible. L'ordre des étapes ne change pas. +> 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. --- @@ -37,15 +40,15 @@ Plafonnez l'appareil pour qu'aucun nouvel utilisateur ne puisse s'y connecter : doublezero device update --pubkey --max-users 0 ``` -Les utilisateurs existants ne sont pas affectés et continuent de fonctionner. Répétez pour chaque appareil mis hors service sur le site. Les liens et l'appareil restent pleinement actifs, de sorte que les utilisateurs connectés conservent un service normal. +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. --- -## Phase 2 — Période de préavis (14 jours avant) +## Phase 2 — Fenêtre de préavis (14 jours avant) -L'équipe DoubleZero notifie les utilisateurs connectés, leur demandant de se reconnecter à un autre DZD avant la date de mise hors service. Coordonnez-vous avec l'équipe pour déterminer qui contacte quels utilisateurs. +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. -Rien n'est drainé pendant cette période, les utilisateurs conservent donc un service normal. Les utilisateurs se reconnectent eux-mêmes à leur propre rythme. Surveillez le nombre d'utilisateurs avec : +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 : ```bash doublezero device list @@ -53,12 +56,20 @@ doublezero device list --- -## Phase 3 — Jour de la mise hors service +## Phase 3 — Jour de la désaffectation + +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 : + +```bash +doublezero device list | grep # trouver votre appareil : son code et sa pubkey +doublezero link list | grep # trouver les liens connectés à l'appareil +doublezero device interface list # lister les interfaces de l'appareil à supprimer +``` Exécutez ces étapes dans l'ordre. Chaque étape déverrouille la suivante. > ⚠️ **Avant la suppression finale de l'appareil :** -> Notifiez la DoubleZero Foundation avant d'exécuter la dernière étape. La Foundation supprime tous les utilisateurs qui n'ont pas migré à temps, ce qui bloquerait autrement la suppression, et effectue toutes les étapes requises côté fondation. +> 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é. ### 1. Drainer les liens @@ -117,4 +128,4 @@ doublezero link update --pubkey --status activated doublezero device update --pubkey --status activated # annuler le drainage de l'appareil ``` -La suppression des liens, interfaces ou de l'appareil est permanente : elle ferme les comptes onchain. Ne commencez à supprimer que lorsque la sortie est confirmée. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/contribute-decommission.it.md b/docs/contribute-decommission.it.md index b3bd7c4..579feca 100644 --- a/docs/contribute-decommission.it.md +++ b/docs/contribute-decommission.it.md @@ -1,11 +1,14 @@ -# Guida alla Dismissione di un Sito per i Contributor +# Guida alla Dismissione di un Sito per i Contributori Questa guida descrive come dismettere un DoubleZero Device (DZD) o uscire da un sito: come rimuovere i propri dispositivi e link dalla rete senza creare disservizi agli utenti connessi, per poi eliminarli onchain. -Il processo si articola in tre fasi: limitare il dispositivo 31 giorni prima del giorno della dismissione, notificare gli utenti connessi durante una finestra di preavviso affinché possano migrare, quindi drenare ed eliminare i link, le interfacce e il dispositivo nel giorno della dismissione. +Il processo si articola in tre fasi: limitare il dispositivo 31 giorni prima del giorno di dismissione, notificare gli utenti connessi durante una finestra di preavviso affinché possano spostarsi, quindi svuotare ed eliminare link, interfacce e dispositivo nel giorno della dismissione. -> ⚠️ **Coordinati prima con DoubleZero:** -> Allineati sempre con il team di DoubleZero prima di dismettere un dispositivo o un sito. Concorda le date e il piano prima di limitare un dispositivo o drenare un link, in modo da coordinare la migrazione degli utenti e le operazioni necessarie da parte della fondazione. +> ⚠️ **Coordinarsi prima con DoubleZero:** +> Allinearsi sempre con il team DoubleZero prima di dismettere un dispositivo o un sito, e concordare con noi la data e l'ora della dismissione. Dalla nostra parte eseguiamo alcuni passaggi in corrispondenza di quella finestra temporale, quindi è necessario essere pianificati. Concordare date e piano prima di limitare un dispositivo o svuotare un link. + +> ⚠️ **Switch e link DZX:** +> Se il dispositivo che si sta dismettendo è uno switch DZX, o ha link DZX, identificare i contributori coinvolti il prima possibile e avvisarli, poiché potrebbero dover spostare o ricostruire i propri link prima della data prevista. Creare inoltre un evento di manutenzione nel [portale OPS](contribute-ops-management.md) per la data di dismissione. --- @@ -13,39 +16,39 @@ Il processo si articola in tre fasi: limitare il dispositivo 31 giorni prima del | Quando | Azione | Chi | |--------|--------|-----| -| 31 giorni prima | Limitare il dispositivo affinché nessun nuovo utente possa connettersi (`--max-users 0`) | Contributor | -| 14 giorni prima | Gli utenti connessi vengono notificati di migrare verso un altro dispositivo | Team DoubleZero | +| 31 giorni prima | Limitare il dispositivo in modo che nessun nuovo utente possa connettersi (`--max-users 0`) | Contributore | +| 14 giorni prima | Gli utenti connessi vengono notificati di spostarsi su un altro dispositivo | Team DoubleZero | | Finestra di preavviso | Gli utenti si riconnettono autonomamente ad altri DZD | Utenti | -| Giorno della dismissione | Drenare ed eliminare i link, le interfacce e il dispositivo | Contributor | +| Giorno di dismissione | Svuotare ed eliminare link, interfacce e dispositivo | Contributore | Principi: -- **Bloccare i nuovi utenti in anticipo, migrare quelli esistenti gradualmente.** Limitare il dispositivo in anticipo significa che da quel momento in poi perderà solo utenti. Gli utenti esistenti continuano a funzionare e migrano secondo i propri tempi. -- **Mantenere tutto operativo durante la finestra di preavviso.** Non drenare i link né il dispositivo fino al giorno della dismissione, affinché gli utenti in fase di migrazione mantengano il servizio regolare. -- **L'ordine di smantellamento è imposto dal contratto.** Non è possibile eliminare un link o un dispositivo mentre è attivo, pertanto i passaggi seguenti prevedono prima il drenaggio e poi l'eliminazione. +- **Bloccare presto i nuovi utenti, spostare gradualmente quelli esistenti.** Limitare il dispositivo in anticipo significa che da quel momento in poi perderà solo utenti. Gli utenti esistenti continuano a funzionare e migrano secondo i propri tempi. +- **Mantenere tutto operativo durante la finestra di preavviso.** Non svuotare i link né il dispositivo fino al giorno della dismissione, affinché gli utenti in fase di migrazione mantengano un servizio regolare. +- **L'ordine di rimozione è imposto dal contratto.** Non è possibile eliminare un link o un dispositivo mentre è attivo, pertanto i passaggi seguenti prevedono prima lo svuotamento e poi l'eliminazione. > ⚠️ **Preavviso breve:** -> Se hai meno di 31 giorni prima dell'uscita, inizia immediatamente. Limita il dispositivo subito e riduci le finestre temporali per adattarle al tempo disponibile. L'ordine dei passaggi non cambia. +> Se si hanno meno di 31 giorni prima dell'uscita, iniziare immediatamente. Limitare il dispositivo subito e ridurre le finestre temporali per adattarle al tempo disponibile. L'ordine dei passaggi non cambia. --- -## Fase 1 — Limitare il dispositivo (31 giorni prima) +## Fase 1 — Limitazione del dispositivo (31 giorni prima) -Limita il dispositivo affinché nessun nuovo utente possa connettersi: +Limitare il dispositivo in modo che nessun nuovo utente possa connettersi: ```bash doublezero device update --pubkey --max-users 0 ``` -Gli utenti esistenti non vengono toccati e continuano a funzionare. Ripeti per ogni dispositivo in dismissione presso il sito. I link e il dispositivo restano pienamente attivi, così gli utenti connessi mantengono il servizio regolare. +Gli utenti esistenti non vengono toccati e continuano a funzionare. Ripetere per ogni dispositivo in fase di dismissione nel sito. I link e il dispositivo restano pienamente attivi, quindi gli utenti connessi mantengono un servizio regolare. --- ## Fase 2 — Finestra di preavviso (14 giorni prima) -Il team di DoubleZero notifica gli utenti connessi, chiedendo loro di riconnettersi a un DZD diverso prima della data di dismissione. Coordinati con il team su chi contatta quali utenti. +Il team DoubleZero notifica gli utenti connessi, chiedendo loro di riconnettersi a un DZD diverso prima della data di dismissione. Coordinarsi con il team su chi contatta quali utenti. -Nulla viene drenato durante questa finestra, quindi gli utenti mantengono il servizio regolare. Gli utenti si riconnettono autonomamente secondo i propri tempi. Monitora il numero di utenti con: +Nulla viene svuotato durante questa finestra, quindi gli utenti mantengono un servizio regolare. Gli utenti si riconnettono autonomamente secondo i propri tempi. Monitorare il numero di utenti con: ```bash doublezero device list @@ -53,24 +56,32 @@ doublezero device list --- -## Fase 3 — Giorno della dismissione +## Fase 3 — Giorno di dismissione + +Prima di iniziare, determinare esattamente cosa deve essere rimosso: il dispositivo, i link ad esso collegati e le interfacce da ripulire. È possibile trovare tutte queste informazioni con: + +```bash +doublezero device list | grep # trovare il proprio dispositivo: codice e pubkey +doublezero link list | grep # trovare i link collegati al dispositivo +doublezero device interface list # elencare le interfacce sul dispositivo da rimuovere +``` -Esegui questi passaggi in ordine. Ogni passaggio sblocca il successivo. +Eseguire questi passaggi nell'ordine indicato. Ogni passaggio sblocca il successivo. > ⚠️ **Prima dell'eliminazione finale del dispositivo:** -> Notifica la DoubleZero Foundation prima di eseguire l'ultimo passaggio. La Foundation rimuove gli utenti che non hanno migrato in tempo, i quali altrimenti bloccherebbero l'eliminazione, e completa tutte le operazioni necessarie da parte della fondazione. +> Notificare la DoubleZero Foundation prima di eseguire l'ultimo passaggio. La Foundation rimuove gli utenti che non hanno effettuato la migrazione in tempo, cosa che altrimenti bloccherebbe l'eliminazione, e completa eventuali passaggi richiesti lato foundation. -### 1. Drenare i link +### 1. Svuotare i link -Prima il soft-drain, poi l'hard-drain. Consulta [Link Draining](contribute-operations.md#link-draining) per capire cosa fa ciascuno stato. +Prima soft-drain, poi hard-drain. Consultare [Link Draining](contribute-operations.md#link-draining) per capire cosa comporta ciascuno stato. ```bash doublezero link update --pubkey --status soft-drained -# una volta che il traffico è stato spostato: +# una volta che il traffico si è spostato: doublezero link update --pubkey --status hard-drained ``` -Ripeti per ogni link sui dispositivi in fase di rimozione. +Ripetere per ogni link sui dispositivi in fase di rimozione. ### 2. Eliminare i link @@ -78,7 +89,7 @@ Ripeti per ogni link sui dispositivi in fase di rimozione. doublezero link delete --pubkey ``` -Questo libera le interfacce che i link stavano utilizzando. +Questo libera le interfacce utilizzate dai link. ### 3. Eliminare le interfacce @@ -86,15 +97,15 @@ Questo libera le interfacce che i link stavano utilizzando. doublezero device interface delete ``` -Ripeti per ogni interfaccia sul dispositivo. +Ripetere per ogni interfaccia sul dispositivo. -### 4. Drenare il dispositivo +### 4. Svuotare il dispositivo ```bash doublezero device update --pubkey --status drained ``` -Il drenaggio rimuove il dispositivo dal routing e chiude tutte le sessioni utente rimanenti. Inoltre, sposta il dispositivo fuori dal suo stato attivo in modo che possa essere eliminato. +Lo svuotamento rimuove il dispositivo dal routing e chiude eventuali sessioni utente rimanenti. Inoltre sposta il dispositivo fuori dal suo stato attivo, rendendone possibile l'eliminazione. ### 5. Eliminare il dispositivo @@ -108,13 +119,13 @@ Il dispositivo può essere eliminato solo quando non è più attivo, non ha link ## Annullamento o posticipo -La limitazione e il drenaggio sono reversibili finché non si inizia a eliminare: +La limitazione e lo svuotamento sono reversibili fino a quando non si inizia a eliminare: ```bash -doublezero device update --pubkey --max-users # ripristina la capacità +doublezero device update --pubkey --max-users # ripristinare la capacità doublezero link update --pubkey --status soft-drained # da hard-drained -doublezero link update --pubkey --status activated # ritorno ad attivo -doublezero device update --pubkey --status activated # annulla il drenaggio del dispositivo +doublezero link update --pubkey --status activated # tornare attivo +doublezero device update --pubkey --status activated # annullare lo svuotamento del dispositivo ``` -L'eliminazione dei link, delle interfacce o del dispositivo è permanente: chiude gli account onchain. Inizia a eliminare solo quando l'uscita è confermata. \ No newline at end of file +L'eliminazione di link, interfacce o dispositivo è permanente: chiude gli account onchain. Iniziare a eliminare solo quando l'uscita è confermata. \ No newline at end of file diff --git a/docs/contribute-decommission.ja.md b/docs/contribute-decommission.ja.md index 6eb83cd..668a35f 100644 --- a/docs/contribute-decommission.ja.md +++ b/docs/contribute-decommission.ja.md @@ -1,11 +1,14 @@ # サイト廃止ガイド（コントリビューター向け） -本ガイドでは、DoubleZero Device（DZD）の廃止またはサイトからの撤退方法について説明します。接続中のユーザーに影響を与えることなく、デバイスとリンクをネットワークから削除し、オンチェーンで削除する手順を解説します。 +このガイドでは、DoubleZero Device（DZD）の廃止またはサイトからの撤退方法について説明します。接続中のユーザーに影響を与えずにデバイスとリンクをネットワークから取り外し、オンチェーンで削除する手順を解説します。 -プロセスは3つの段階で進行します。廃止日の31日前にデバイスの上限を設定し、通知期間中に接続ユーザーに移行を通知して移動の猶予を与え、廃止日にリンク、インターフェース、デバイスのドレインと削除を実施します。 +プロセスは3つの段階で進みます。廃止日の31日前にデバイスに上限を設定し、通知期間中に接続ユーザーへ移行を案内し、廃止当日にリンク、インターフェース、デバイスをドレインして削除します。 > ⚠️ **まずDoubleZeroと調整してください：** -> デバイスやサイトを廃止する前に、必ずDoubleZeroチームと事前に調整してください。デバイスの上限設定やリンクのドレインを行う前に、日程と計画について合意し、ユーザー移行およびファウンデーション側で必要な手順を調整できるようにしてください。 +> デバイスやサイトを廃止する前に、必ずDoubleZeroチームと連携し、廃止の日時をスケジュールしてください。その時間帯に合わせて当社側でもいくつかの手順を実行する必要があるため、事前のスケジュール調整が必要です。デバイスへの上限設定やリンクのドレインを行う前に、日程と計画を合意してください。 + +> ⚠️ **DZXスイッチとリンク：** +> 廃止対象のデバイスがDZXスイッチである場合、またはDZXリンクがある場合は、影響を受けるコントリビューターをできるだけ早く特定し、通知してください。廃止日までにリンクの移行や再構築が必要になる場合があります。また、[OPSポータル](contribute-ops-management.md)で廃止日のメンテナンスイベントを作成してください。 --- @@ -13,39 +16,39 @@ | タイミング | アクション | 担当者 | |------|--------|-----| -| 31日前 | 新規ユーザーが接続できないようデバイスの上限を設定（`--max-users 0`） | コントリビューター | -| 14日前 | 接続中のユーザーに別のデバイスへの移行を通知 | DoubleZeroチーム | -| 通知期間 | ユーザーが自ら他のDZDに再接続 | ユーザー | -| 廃止日 | リンク、インターフェース、デバイスのドレインと削除 | コントリビューター | +| 31日前 | 新しいユーザーが接続できないようデバイスに上限を設定する（`--max-users 0`） | コントリビューター | +| 14日前 | 接続ユーザーに他のデバイスへの移行を通知する | DoubleZeroチーム | +| 通知期間 | ユーザーが自ら他のDZDに再接続する | ユーザー | +| 廃止当日 | リンク、インターフェース、デバイスをドレインして削除する | コントリビューター | 原則： -- **新規ユーザーを早期に停止し、既存ユーザーは段階的に移行。** デバイスの上限を早期に設定することで、その時点以降はユーザーが減少するのみとなります。既存ユーザーは引き続き利用可能で、各自のスケジュールで移行します。 -- **通知期間中はすべてを稼働状態に保つ。** 廃止日までリンクやデバイスのドレインは行わないでください。移行中のユーザーが通常通りサービスを利用できるようにするためです。 -- **解体の順序はコントラクトにより強制されます。** アクティブ状態のリンクやデバイスは削除できないため、以下の手順ではまずドレインを行い、最後に削除します。 +- **新規ユーザーは早期に停止し、既存ユーザーは段階的に移行する。** デバイスに早めに上限を設定することで、その時点以降はユーザーが減少するのみとなります。既存ユーザーは引き続き利用でき、自身のスケジュールで移行します。 +- **通知期間中はすべてを稼働状態に保つ。** 移行中のユーザーが通常のサービスを受け続けられるよう、廃止当日までリンクやデバイスのドレインは行わないでください。 +- **削除順序はコントラクトによって強制される。** アクティブ状態のリンクやデバイスは削除できないため、以下の手順ではまずドレインし、最後に削除を行います。 -> ⚠️ **緊急の場合：** -> 撤退まで31日未満の場合は、直ちに開始してください。今すぐデバイスの上限を設定し、利用可能な期間に合わせてウィンドウを短縮してください。手順の順序は変わりません。 +> ⚠️ **短期通知の場合：** +> 撤退まで31日未満の場合は、直ちに開始してください。今すぐデバイスに上限を設定し、利用可能な期間に合わせて各期間を短縮してください。手順の順序は変わりません。 --- ## フェーズ1 — デバイスの上限設定（31日前） -新規ユーザーが接続できないようデバイスの上限を設定します： +新しいユーザーが接続できないようデバイスに上限を設定します： ```bash doublezero device update --pubkey --max-users 0 ``` -既存ユーザーには影響がなく、引き続き利用できます。サイトで廃止対象となるすべてのデバイスに対して繰り返し実行してください。リンクとデバイスは完全にアクティブな状態を維持するため、接続中のユーザーは通常通りサービスを利用できます。 +既存ユーザーは影響を受けず、引き続き利用できます。サイトで廃止するすべてのデバイスについてこの操作を繰り返してください。リンクとデバイスは完全にアクティブなままなので、接続ユーザーは通常のサービスを受け続けられます。 --- ## フェーズ2 — 通知期間（14日前） -DoubleZeroチームが接続中のユーザーに通知し、廃止日までに別のDZDに再接続するよう依頼します。どのユーザーに誰が連絡するかについて、チームと調整してください。 +DoubleZeroチームが接続ユーザーに通知し、廃止日前に別のDZDへ再接続するよう依頼します。どのユーザーに誰が連絡するかについて、チームと調整してください。 -この期間中はドレインを行わないため、ユーザーは通常通りサービスを利用できます。ユーザーは各自のペースで再接続します。以下のコマンドでユーザー数を監視してください： +この期間中はドレインを行わないため、ユーザーは通常のサービスを受け続けられます。ユーザーは自身のペースで再接続します。以下のコマンドでユーザー数を監視してください： ```bash doublezero device list @@ -53,16 +56,24 @@ doublezero device list --- -## フェーズ3 — 廃止日 +## フェーズ3 — 廃止当日 + +開始前に、除去が必要なものを正確に把握してください。デバイス、それに接続されたリンク、クリーンアップすべきインターフェースです。以下のコマンドですべて確認できます： + +```bash +doublezero device list | grep # デバイスを検索：コードと公開鍵 +doublezero link list | grep # デバイスに接続されたリンクを検索 +doublezero device interface list # 除去するデバイス上のインターフェースを一覧表示 +``` -以下の手順を順番に実行してください。各手順が次の手順を解除します。 +以下の手順を順番に実行してください。各手順が次の手順を可能にします。 > ⚠️ **最終的なデバイス削除の前に：** -> 最後の手順を実行する前にDoubleZero Foundationに通知してください。Foundationは期限内に移行しなかったユーザーを削除します（これを行わないと削除がブロックされます）。また、ファウンデーション側で必要な手順も完了します。 +> 最後の手順を実行する前に、DoubleZero Foundationに通知してください。Foundationは、期限内に移行しなかったユーザーを削除します（移行されていないユーザーがいると削除がブロックされます）。また、Foundation側で必要な手順を完了します。 ### 1. リンクのドレイン -まずソフトドレイン、次にハードドレインを実行します。各状態の詳細については[Link Draining](contribute-operations.md#link-draining)を参照してください。 +まずソフトドレイン、次にハードドレインを行います。各状態の詳細は[リンクのドレイン](contribute-operations.md#link-draining)を参照してください。 ```bash doublezero link update --pubkey --status soft-drained @@ -70,7 +81,7 @@ doublezero link update --pubkey --status soft-drained doublezero link update --pubkey --status hard-drained ``` -削除対象のデバイス上のすべてのリンクに対して繰り返し実行してください。 +除去するデバイス上のすべてのリンクについて繰り返してください。 ### 2. リンクの削除 @@ -86,7 +97,7 @@ doublezero link delete --pubkey doublezero device interface delete ``` -デバイス上の各インターフェースに対して繰り返し実行してください。 +デバイス上の各インターフェースについて繰り返してください。 ### 4. デバイスのドレイン @@ -94,7 +105,7 @@ doublezero device interface delete doublezero device update --pubkey --status drained ``` -ドレインにより、デバイスがルーティングから除外され、残存するユーザーセッションがすべて終了します。また、デバイスをアクティブ状態から移行させ、削除可能な状態にします。 +ドレインにより、デバイスがルーティングから除外され、残りのユーザーセッションが閉じられます。また、デバイスがアクティブ状態から移行され、削除可能になります。 ### 5. デバイスの削除 @@ -102,7 +113,7 @@ doublezero device update --pubkey --status drained doublezero device delete --pubkey ``` -デバイスの削除は、アクティブ状態でなくなり、参照しているリンクがなく、インターフェースが残っていない場合にのみ可能です。これらは前の手順で処理されています。 +デバイスは、アクティブでなくなり、参照しているリンクがなく、インターフェースが残っていない場合にのみ削除できます。これらは前の手順で処理されています。 --- @@ -117,4 +128,4 @@ doublezero link update --pubkey --status activated doublezero device update --pubkey --status activated # デバイスのドレインを解除 ``` -リンク、インターフェース、またはデバイスの削除は永続的であり、オンチェーンアカウントが閉鎖されます。撤退が確定してから削除を開始してください。 \ No newline at end of file +リンク、インターフェース、またはデバイスの削除は永続的であり、オンチェーンアカウントが閉じられます。撤退が確定してから削除を開始してください。 \ No newline at end of file diff --git a/docs/contribute-decommission.ko.md b/docs/contribute-decommission.ko.md index cdcde59..43c5ab0 100644 --- a/docs/contribute-decommission.ko.md +++ b/docs/contribute-decommission.ko.md @@ -1,51 +1,54 @@ # 사이트 해제 가이드 (기여자용) -이 가이드는 DoubleZero Device(DZD)를 해제하거나 사이트를 종료하는 방법을 설명합니다. 연결된 사용자에게 지장을 주지 않으면서 네트워크에서 장치와 링크를 제거한 후 온체인에서 삭제하는 절차입니다. +이 가이드는 DoubleZero Device(DZD) 해제 또는 사이트 탈퇴 방법을 설명합니다. 연결된 사용자에게 지장을 주지 않으면서 네트워크에서 장치와 링크를 제거한 후 온체인에서 삭제하는 방법을 다룹니다. -프로세스는 세 단계로 진행됩니다: 해제일 31일 전에 장치를 제한하고, 공지 기간 동안 연결된 사용자에게 이전을 알린 후, 해제일에 링크, 인터페이스, 장치를 드레인하고 삭제합니다. +프로세스는 세 단계로 진행됩니다. 해제일 31일 전에 장치를 제한하고, 고지 기간 동안 연결된 사용자에게 이전을 알린 후, 해제일에 링크, 인터페이스, 장치를 드레인 및 삭제합니다. > ⚠️ **먼저 DoubleZero와 조율하세요:** -> 장치나 사이트를 해제하기 전에 항상 DoubleZero 팀과 사전 조율하세요. 장치를 제한하거나 링크를 드레인하기 전에 날짜와 계획에 합의하여, 사용자 이전과 재단 측에서 필요한 단계를 조율할 수 있도록 하세요. +> 장치나 사이트를 해제하기 전에 반드시 DoubleZero 팀과 사전 조율하고, 해제 날짜와 시간을 함께 정하세요. 해당 시간대에 맞춰 저희 측에서도 몇 가지 단계를 진행해야 하므로 사전 일정 조율이 필요합니다. 장치를 제한하거나 링크를 드레인하기 전에 날짜와 계획을 합의하세요. + +> ⚠️ **DZX 스위치 및 링크:** +> 해제하려는 장치가 DZX 스위치이거나 DZX 링크가 있는 경우, 영향을 받는 기여자를 최대한 빨리 파악하고 사전에 알려주세요. 해당 기여자들이 해제일 전에 링크를 이전하거나 재구성해야 할 수 있습니다. 또한 해제일에 대한 유지보수 이벤트를 [OPS 포털](contribute-ops-management.md)에 생성하세요. --- ## 개요 -| 시점 | 조치 | 담당 | +| 시기 | 조치 | 담당 | |------|------|------| -| 31일 전 | 신규 사용자가 연결할 수 없도록 장치 제한 (`--max-users 0`) | 기여자 | +| 31일 전 | 새로운 사용자가 연결할 수 없도록 장치 제한 (`--max-users 0`) | 기여자 | | 14일 전 | 연결된 사용자에게 다른 장치로 이전하도록 알림 | DoubleZero 팀 | -| 공지 기간 | 사용자가 직접 다른 DZD로 재연결 | 사용자 | -| 해제일 | 링크, 인터페이스, 장치를 드레인하고 삭제 | 기여자 | +| 고지 기간 | 사용자가 스스로 다른 DZD에 재연결 | 사용자 | +| 해제일 | 링크, 인터페이스, 장치를 드레인 및 삭제 | 기여자 | 원칙: -- **신규 사용자는 조기에 차단하고, 기존 사용자는 점진적으로 이전합니다.** 장치를 조기에 제한하면 해당 시점부터 신규 사용자만 차단됩니다. 기존 사용자는 계속 서비스를 이용하며 자신의 일정에 맞춰 이전합니다. -- **공지 기간 동안 모든 것을 가동 상태로 유지합니다.** 이전 중인 사용자가 정상적인 서비스를 유지할 수 있도록 해제일까지 링크나 장치를 드레인하지 마세요. -- **해체 순서는 컨트랙트에 의해 강제됩니다.** 활성 상태인 링크나 장치는 삭제할 수 없으므로, 아래 단계에서는 먼저 드레인한 후 마지막에 삭제합니다. +- **신규 사용자는 조기에 차단하고, 기존 사용자는 점진적으로 이전합니다.** 장치를 일찍 제한하면 해당 시점부터 신규 사용자만 차단됩니다. 기존 사용자는 계속 정상적으로 이용하며 자신의 일정에 맞춰 이전합니다. +- **고지 기간 동안에는 모든 것을 활성 상태로 유지합니다.** 이전 중인 사용자가 정상적인 서비스를 받을 수 있도록 해제일까지 링크나 장치를 드레인하지 마세요. +- **해체 순서는 컨트랙트에 의해 강제됩니다.** 활성 상태인 링크나 장치는 삭제할 수 없으므로 아래 단계에서 먼저 드레인한 후 마지막에 삭제합니다. -> ⚠️ **촉박한 일정:** -> 종료까지 31일 미만인 경우 즉시 시작하세요. 지금 장치를 제한하고 가용 시간에 맞춰 기간을 단축하세요. 단계 순서는 변경되지 않습니다. +> ⚠️ **긴급한 경우:** +> 탈퇴까지 31일이 남지 않은 경우 즉시 시작하세요. 지금 바로 장치를 제한하고 가용 시간에 맞춰 기간을 단축하세요. 단계 순서는 변경되지 않습니다. --- ## 1단계 — 장치 제한 (31일 전) -신규 사용자가 연결할 수 없도록 장치를 제한합니다: +새로운 사용자가 연결할 수 없도록 장치를 제한합니다: ```bash doublezero device update --pubkey --max-users 0 ``` -기존 사용자는 영향을 받지 않으며 계속 정상적으로 사용할 수 있습니다. 사이트에서 해제할 모든 장치에 대해 반복하세요. 링크와 장치는 완전히 활성 상태를 유지하므로 연결된 사용자는 정상적인 서비스를 계속 이용합니다. +기존 사용자는 영향을 받지 않으며 계속 정상적으로 이용합니다. 사이트에서 해제할 모든 장치에 대해 반복하세요. 링크와 장치는 완전히 활성 상태를 유지하므로 연결된 사용자는 정상적인 서비스를 받습니다. --- -## 2단계 — 공지 기간 (14일 전) +## 2단계 — 고지 기간 (14일 전) DoubleZero 팀이 연결된 사용자에게 해제일 전에 다른 DZD로 재연결하도록 알립니다. 어떤 사용자에게 누가 연락할지 팀과 조율하세요. -이 기간 동안에는 드레인하지 않으므로 사용자는 정상적인 서비스를 유지합니다. 사용자는 자신의 속도에 맞춰 재연결합니다. 다음 명령으로 사용자 수를 모니터링하세요: +이 기간 동안에는 드레인이 이루어지지 않으므로 사용자는 정상적인 서비스를 받습니다. 사용자는 자신의 속도에 맞춰 재연결합니다. 다음 명령으로 사용자 수를 모니터링하세요: ```bash doublezero device list @@ -55,14 +58,22 @@ doublezero device list ## 3단계 — 해제일 -아래 단계를 순서대로 실행하세요. 각 단계가 다음 단계를 해제합니다. +시작하기 전에 제거해야 할 항목을 정확히 파악하세요: 장치, 연결된 링크, 정리할 인터페이스. 다음 명령으로 모두 확인할 수 있습니다: + +```bash +doublezero device list | grep # 장치 찾기: 코드 및 공개키 +doublezero link list | grep # 장치에 연결된 링크 찾기 +doublezero device interface list # 제거할 장치의 인터페이스 목록 조회 +``` + +아래 단계를 순서대로 실행하세요. 각 단계가 다음 단계를 가능하게 합니다. > ⚠️ **최종 장치 삭제 전:** -> 마지막 단계를 실행하기 전에 DoubleZero Foundation에 알리세요. Foundation은 제때 이전하지 않은 사용자를 제거하여(그렇지 않으면 삭제가 차단됨) 재단 측에서 필요한 단계를 완료합니다. +> 마지막 단계를 실행하기 전에 DoubleZero Foundation에 알리세요. Foundation이 제때 이전하지 못한 사용자를 제거하며, 이를 하지 않으면 삭제가 차단됩니다. 또한 Foundation 측에서 필요한 단계를 완료합니다. ### 1. 링크 드레인 -소프트 드레인을 먼저 수행한 후 하드 드레인을 수행합니다. 각 상태의 의미는 [Link Draining](contribute-operations.md#link-draining)을 참조하세요. +소프트 드레인을 먼저 수행한 후 하드 드레인합니다. 각 상태가 무엇을 하는지에 대해서는 [링크 드레인](contribute-operations.md#link-draining)을 참조하세요. ```bash doublezero link update --pubkey --status soft-drained @@ -78,7 +89,7 @@ doublezero link update --pubkey --status hard-drained doublezero link delete --pubkey ``` -링크가 사용하던 인터페이스가 해제됩니다. +이렇게 하면 링크가 사용하던 인터페이스가 해제됩니다. ### 3. 인터페이스 삭제 @@ -94,7 +105,7 @@ doublezero device interface delete doublezero device update --pubkey --status drained ``` -드레인하면 장치가 라우팅에서 제거되고 남아 있는 모든 사용자 세션이 종료됩니다. 또한 장치를 활성 상태에서 이동시켜 삭제할 수 있도록 합니다. +드레인은 라우팅에서 장치를 제거하고 남아 있는 사용자 세션을 종료합니다. 또한 장치를 활성 상태에서 이동시켜 삭제할 수 있게 합니다. ### 5. 장치 삭제 @@ -102,7 +113,7 @@ doublezero device update --pubkey --status drained doublezero device delete --pubkey ``` -장치는 더 이상 활성 상태가 아니고, 참조하는 링크가 없으며, 남아 있는 인터페이스가 없어야만 삭제할 수 있습니다. 이전 단계에서 이 조건을 처리합니다. +장치는 더 이상 활성 상태가 아니고, 참조하는 링크가 없으며, 남아 있는 인터페이스가 없어야만 삭제할 수 있습니다. 이전 단계들이 이를 처리합니다. --- @@ -112,9 +123,9 @@ doublezero device delete --pubkey ```bash doublezero device update --pubkey --max-users # 용량 복원 -doublezero link update --pubkey --status soft-drained # 하드 드레인에서 복원 +doublezero link update --pubkey --status soft-drained # 하드 드레인에서 변경 doublezero link update --pubkey --status activated # 활성 상태로 복원 doublezero device update --pubkey --status activated # 장치 드레인 해제 ``` -링크, 인터페이스 또는 장치의 삭제는 영구적입니다: 온체인 계정이 폐쇄됩니다. 종료가 확정된 후에만 삭제를 시작하세요. \ No newline at end of file +링크, 인터페이스, 장치의 삭제는 영구적입니다. 온체인 계정이 닫힙니다. 탈퇴가 확정된 후에만 삭제를 시작하세요. \ No newline at end of file diff --git a/docs/contribute-decommission.pt.md b/docs/contribute-decommission.pt.md index 7ae66fb..2f69cc6 100644 --- a/docs/contribute-decommission.pt.md +++ b/docs/contribute-decommission.pt.md @@ -1,11 +1,14 @@ # Guia de Descomissionamento de Site para Contribuidores -Este guia descreve como descomissionar um Dispositivo DoubleZero (DZD) ou encerrar um site: como remover seus dispositivos e links da rede sem interromper os usuários conectados, e depois excluí-los onchain. +Este guia descreve como descomissionar um Dispositivo DoubleZero (DZD) ou sair de um site: como remover seus dispositivos e links da rede sem interromper os usuários conectados e, em seguida, excluí-los onchain. -O processo ocorre em três etapas: limitar o dispositivo 31 dias antes do dia do descomissionamento, notificar os usuários conectados durante uma janela de aviso para que possam migrar, e então drenar e excluir os links, interfaces e dispositivo no dia do descomissionamento. +O processo é executado em três estágios: limitar o dispositivo 31 dias antes do dia do descomissionamento, notificar os usuários conectados durante uma janela de aviso para que possam migrar e, então, drenar e excluir os links, interfaces e dispositivo no dia do descomissionamento. > ⚠️ **Coordene com a DoubleZero primeiro:** -> Sempre alinhe com a equipe da DoubleZero antes de descomissionar um dispositivo ou site. Concorde com as datas e o plano antes de limitar um dispositivo ou drenar um link, para que a migração dos usuários e as etapas necessárias do lado da fundação possam ser coordenadas. +> Sempre alinhe com a equipe da DoubleZero antes de descomissionar um dispositivo ou site, e agende sua data e horário de descomissionamento conosco. Executamos algumas etapas do nosso lado nesse período, então precisamos estar agendados. Combine as datas e o plano antes de limitar um dispositivo ou drenar um link. + +> ⚠️ **Switches e links DZX:** +> Se o dispositivo que você está descomissionando é um switch DZX, ou possui quaisquer links DZX, identifique os contribuidores afetados o mais cedo possível e notifique-os, pois eles podem precisar mover ou reconstruir seus links antes da sua data. Também crie um evento de manutenção no [portal OPS](contribute-ops-management.md) para a data de descomissionamento. --- @@ -20,12 +23,12 @@ O processo ocorre em três etapas: limitar o dispositivo 31 dias antes do dia do Princípios: -- **Pare novos usuários cedo, migre usuários existentes gradualmente.** Limitar o dispositivo cedo significa que ele apenas perde usuários a partir desse ponto. Usuários existentes continuam funcionando e migram no seu próprio ritmo. +- **Pare novos usuários cedo, mova os existentes gradualmente.** Limitar o dispositivo cedo significa que ele apenas perde usuários a partir desse ponto. Usuários existentes continuam funcionando e migram no seu próprio ritmo. - **Mantenha tudo ativo durante a janela de aviso.** Não drene os links ou o dispositivo até o dia do descomissionamento, para que os usuários em migração mantenham o serviço normal. -- **A ordem de desmontagem é imposta pelo contrato.** Você não pode excluir um link ou dispositivo enquanto estiver ativo, então as etapas abaixo drenam primeiro e excluem por último. +- **A ordem de desmontagem é imposta pelo contrato.** Você não pode excluir um link ou dispositivo enquanto ele estiver ativo, então os passos abaixo drenam primeiro e excluem por último. -> ⚠️ **Aviso com pouca antecedência:** -> Se você tiver menos de 31 dias antes da saída, comece imediatamente. Limite o dispositivo agora e encurte as janelas para caber no tempo disponível. A ordem das etapas não muda. +> ⚠️ **Aviso curto:** +> Se você tem menos de 31 dias antes da saída, comece imediatamente. Limite o dispositivo agora e encurte as janelas para caber no tempo disponível. A ordem dos passos não muda. --- @@ -37,15 +40,15 @@ Limite o dispositivo para que novos usuários não possam se conectar: doublezero device update --pubkey --max-users 0 ``` -Usuários existentes não são afetados e continuam funcionando. Repita para cada dispositivo sendo descomissionado no site. Os links e o dispositivo permanecem totalmente ativos, para que os usuários conectados mantenham o serviço normal. +Os usuários existentes não são afetados e continuam funcionando. Repita para cada dispositivo sendo descomissionado no site. Os links e o dispositivo permanecem totalmente ativos, então os usuários conectados mantêm o serviço normal. --- ## Fase 2 — Janela de aviso (14 dias antes) -A equipe DoubleZero notifica os usuários conectados, pedindo que se reconectem a um DZD diferente antes da data de descomissionamento. Coordene com a equipe sobre quem entra em contato com quais usuários. +A equipe da DoubleZero notifica os usuários conectados, pedindo que se reconectem a um DZD diferente antes da data de descomissionamento. Coordene com a equipe sobre quem contata quais usuários. -Nada é drenado durante esta janela, para que os usuários mantenham o serviço normal. Os usuários se reconectam no seu próprio ritmo. Monitore a contagem de usuários com: +Nada é drenado durante esta janela, então os usuários mantêm o serviço normal. Os usuários se reconectam no seu próprio ritmo. Monitore a contagem de usuários com: ```bash doublezero device list @@ -55,18 +58,26 @@ doublezero device list ## Fase 3 — Dia do descomissionamento -Execute estas etapas em ordem. Cada etapa desbloqueia a próxima. +Antes de começar, identifique exatamente o que precisa ser removido: o dispositivo, os links conectados a ele e as interfaces a serem limpas. Você pode encontrar tudo isso com: + +```bash +doublezero device list | grep # encontre seu dispositivo: seu código e pubkey +doublezero link list | grep # encontre os links conectados ao dispositivo +doublezero device interface list # liste as interfaces no dispositivo a remover +``` + +Execute estes passos em ordem. Cada passo desbloqueia o próximo. > ⚠️ **Antes da exclusão final do dispositivo:** -> Notifique a Fundação DoubleZero antes de executar a última etapa. A Fundação remove quaisquer usuários que não migraram a tempo, o que de outra forma bloquearia a exclusão, e conclui quaisquer etapas necessárias do lado da fundação. +> Notifique a Fundação DoubleZero antes de executar o último passo. A Fundação remove quaisquer usuários que não migraram a tempo, o que de outra forma bloquearia a exclusão, e completa quaisquer etapas necessárias do lado da fundação. ### 1. Drenar os links -Faça a drenagem suave primeiro, depois a drenagem forçada. Veja [Drenagem de Links](contribute-operations.md#link-draining) para saber o que cada estado faz. +Faça soft-drain primeiro, depois hard-drain. Veja [Drenagem de Links](contribute-operations.md#link-draining) para saber o que cada estado faz. ```bash doublezero link update --pubkey --status soft-drained -# quando o tráfego tiver sido movido: +# quando o tráfego tiver saído: doublezero link update --pubkey --status hard-drained ``` @@ -78,7 +89,7 @@ Repita para cada link nos dispositivos sendo removidos. doublezero link delete --pubkey ``` -Isso libera as interfaces que os links estavam utilizando. +Isso libera as interfaces que os links estavam usando. ### 3. Excluir as interfaces @@ -94,7 +105,7 @@ Repita para cada interface no dispositivo. doublezero device update --pubkey --status drained ``` -A drenagem remove o dispositivo do roteamento e encerra quaisquer sessões de usuário restantes. Também move o dispositivo para fora do seu estado ativo para que possa ser excluído. +Drenar remove o dispositivo do roteamento e encerra quaisquer sessões de usuário restantes. Também move o dispositivo para fora do seu estado ativo, permitindo que ele seja excluído. ### 5. Excluir o dispositivo @@ -102,7 +113,7 @@ A drenagem remove o dispositivo do roteamento e encerra quaisquer sessões de us doublezero device delete --pubkey ``` -O dispositivo só pode ser excluído quando não estiver mais ativo, não tiver links referenciando-o e não tiver interfaces restantes, o que as etapas anteriores tratam. +O dispositivo só pode ser excluído quando não estiver mais ativo, não tiver links referenciando-o e não tiver interfaces restantes, o que os passos anteriores resolvem. --- @@ -112,9 +123,9 @@ Limitar e drenar são reversíveis até que você comece a excluir: ```bash doublezero device update --pubkey --max-users # restaurar capacidade -doublezero link update --pubkey --status soft-drained # a partir de hard-drained +doublezero link update --pubkey --status soft-drained # de hard-drained doublezero link update --pubkey --status activated # de volta ao ativo doublezero device update --pubkey --status activated # reverter drenagem do dispositivo ``` -Excluir os links, interfaces ou dispositivo é permanente: fecha as contas onchain. Só comece a excluir quando a saída estiver confirmada. \ No newline at end of file +Excluir os links, interfaces ou dispositivo é permanente: isso fecha as contas onchain. Só comece a excluir quando a saída estiver confirmada. \ No newline at end of file diff --git a/docs/contribute-decommission.zh.md b/docs/contribute-decommission.zh.md index 85f616a..6bb6fc8 100644 --- a/docs/contribute-decommission.zh.md +++ b/docs/contribute-decommission.zh.md @@ -1,51 +1,54 @@ -# 站点退役指南（贡献者） +# 站点退役指南（面向贡献者） -本指南介绍如何退役 DoubleZero 设备（DZD）或退出站点：如何在不影响已连接用户的情况下从网络中移除您的设备和链路，然后在链上删除它们。 +本指南介绍如何退役 DoubleZero 设备 (DZD) 或退出站点：如何在不影响已连接用户的情况下从网络中移除您的设备和链路，然后在链上删除它们。 -整个流程分为三个阶段：在退役日前 31 天对设备设置上限，在通知窗口期间通知已连接的用户以便他们迁移，然后在退役当天排空并删除链路、接口和设备。 +整个流程分为三个阶段：在退役日前 31 天对设备设置上限，在通知窗口期内通知已连接的用户以便其迁移，然后在退役当天排空并删除链路、接口和设备。 > ⚠️ **请先与 DoubleZero 协调：** -> 在退役设备或站点之前，务必与 DoubleZero 团队保持一致。在对设备设置上限或排空链路之前，请先商定日期和计划，以便协调用户迁移以及基金会侧所需的步骤。 +> 在退役设备或站点之前，务必与 DoubleZero 团队保持同步，并与我们确定退役日期和时间。我们需要在该时间段前后执行一些操作步骤，因此需要提前安排。在对设备设置上限或排空链路之前，请先就日期和计划达成一致。 + +> ⚠️ **DZX 交换机和链路：** +> 如果您要退役的设备是 DZX 交换机，或包含任何 DZX 链路，请尽早识别受影响的贡献者并通知他们，因为他们可能需要在您的退役日期之前迁移或重建其链路。同时，请在 [OPS 门户](contribute-ops-management.md) 中为退役日期创建维护事件。 --- ## 概述 -| 时间 | 操作 | 负责方 | +| 时间 | 操作 | 执行者 | |------|------|--------| -| 31 天前 | 对设备设置上限，使新用户无法接入（`--max-users 0`） | 贡献者 | -| 14 天前 | 通知已连接用户迁移至其他设备 | DoubleZero 团队 | +| 31 天前 | 对设备设置上限，阻止新用户接入（`--max-users 0`） | 贡献者 | +| 14 天前 | 通知已连接用户迁移到其他设备 | DoubleZero 团队 | | 通知窗口期 | 用户自行重新连接到其他 DZD | 用户 | | 退役当天 | 排空并删除链路、接口和设备 | 贡献者 | 原则： -- **尽早停止新用户接入，逐步迁移现有用户。** 提前对设备设置上限意味着从该时刻起只会流失用户。现有用户继续正常工作，按照自己的节奏进行迁移。 -- **在通知窗口期内保持所有服务正常运行。** 在退役当天之前不要排空链路或设备，以确保迁移中的用户保持正常服务。 -- **拆除顺序由合约强制执行。** 链路或设备在活跃状态下无法删除，因此以下步骤先排空再删除。 +- **尽早阻止新用户，逐步迁移现有用户。** 提前对设备设置上限意味着从该时刻起不再接纳新用户。现有用户继续正常使用，按自己的时间安排进行迁移。 +- **在通知窗口期内保持一切在线。** 在退役当天之前不要排空链路或设备，以便迁移中的用户继续获得正常服务。 +- **拆除顺序由合约强制执行。** 在链路或设备处于活跃状态时无法删除，因此以下步骤先排空后删除。 -> ⚠️ **时间紧迫的情况：** -> 如果距离退出不足 31 天，请立即开始。现在就对设备设置上限，并根据可用时间压缩各窗口期。步骤顺序不变。 +> ⚠️ **紧急情况：** +> 如果距离退出不足 31 天，请立即开始。现在就对设备设置上限，并压缩窗口期以适应可用时间。步骤顺序不变。 --- -## 阶段 1 — 对设备设置上限（31 天前） +## 第一阶段 — 设备设置上限（31 天前） -对设备设置上限，使新用户无法接入： +对设备设置上限，阻止新用户接入： ```bash doublezero device update --pubkey --max-users 0 ``` -现有用户不受影响，继续正常工作。对站点中每个待退役的设备重复此操作。链路和设备保持完全活跃，已连接用户继续享受正常服务。 +现有用户不受影响，继续正常使用。对站点中每个需要退役的设备重复此操作。链路和设备保持完全活跃，已连接用户继续获得正常服务。 --- -## 阶段 2 — 通知窗口期（14 天前） +## 第二阶段 — 通知窗口期（14 天前） -DoubleZero 团队通知已连接的用户，要求他们在退役日期之前重新连接到其他 DZD。请与团队协调由谁联系哪些用户。 +DoubleZero 团队通知已连接用户，要求他们在退役日期之前重新连接到其他 DZD。与团队协调确定由谁联系哪些用户。 -此窗口期内不进行任何排空操作，用户继续享受正常服务。用户按照自己的节奏进行重新连接。使用以下命令监控用户数量： +在此窗口期内不进行任何排空操作，用户继续获得正常服务。用户按自己的节奏自行重新连接。使用以下命令监控用户数量： ```bash doublezero device list @@ -53,16 +56,24 @@ doublezero device list --- -## 阶段 3 — 退役当天 +## 第三阶段 — 退役当天 + +在开始之前，明确需要移除的内容：设备、连接到设备的链路，以及需要清理的接口。您可以通过以下命令查找所有相关信息： + +```bash +doublezero device list | grep # 查找您的设备：设备代码和公钥 +doublezero link list | grep # 查找连接到该设备的链路 +doublezero device interface list # 列出设备上需要移除的接口 +``` -按顺序执行以下步骤。每个步骤解锁下一个步骤。 +按顺序执行以下步骤。每个步骤为下一步解锁前置条件。 -> ⚠️ **在最终删除设备之前：** -> 在执行最后一步之前，请通知 DoubleZero Foundation。基金会会移除未及时迁移的用户（否则这些用户会阻止删除操作），并完成基金会侧所需的步骤。 +> ⚠️ **最终删除设备之前：** +> 在执行最后一步之前，请通知 DoubleZero 基金会。基金会会移除未及时迁移的用户（否则这些用户会阻止删除操作），并完成基金会方面所需的步骤。 ### 1. 排空链路 -先软排空，再硬排空。请参阅[链路排空](contribute-operations.md#link-draining)了解每种状态的作用。 +先进行软排空，然后硬排空。有关每种状态的作用，请参阅 [链路排空](contribute-operations.md#link-draining)。 ```bash doublezero link update --pubkey --status soft-drained @@ -70,7 +81,7 @@ doublezero link update --pubkey --status soft-drained doublezero link update --pubkey --status hard-drained ``` -对待移除设备上的每条链路重复此操作。 +对所有需要移除的设备上的每条链路重复此操作。 ### 2. 删除链路 @@ -78,7 +89,7 @@ doublezero link update --pubkey --status hard-drained doublezero link delete --pubkey ``` -这将释放链路之前使用的接口。 +这将释放链路所占用的接口。 ### 3. 删除接口 @@ -94,7 +105,7 @@ doublezero device interface delete doublezero device update --pubkey --status drained ``` -排空操作会将设备从路由中移除并关闭所有剩余的用户会话。同时将设备从活跃状态移出，使其可以被删除。 +排空操作会将设备从路由中移除并关闭所有剩余的用户会话。它还会将设备从活跃状态转出，使其可以被删除。 ### 5. 删除设备 @@ -102,11 +113,11 @@ doublezero device update --pubkey --status drained doublezero device delete --pubkey ``` -设备只有在不再处于活跃状态、没有链路引用它、且没有剩余接口的情况下才能被删除，前面的步骤已处理了这些前提条件。 +设备只有在不再处于活跃状态、没有链路引用、且没有剩余接口的情况下才能被删除，前面的步骤已处理这些前置条件。 --- -## 取消或推迟 +## 取消或延期 在开始删除之前，设置上限和排空操作都是可逆的：