From 6b4bb25c71200d9bc69d7f61bd73eec3dbf7d6ff Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 28 Jul 2025 18:30:24 +0000 Subject: [PATCH] Deployed 42256cf4 to dev with MkDocs 1.6.1 and mike 2.1.3 --- dev/404.html | 70 +- dev/boot/index.html | 198 ++- dev/branding/index.html | 72 +- dev/cli/configure/index.html | 70 +- dev/cli/introduction/index.html | 72 +- dev/cli/keybindings/index.html | 70 +- dev/cli/netcalc/index.html | 70 +- dev/cli/quick/index.html | 70 +- dev/cli/tcpdump/index.html | 70 +- dev/cli/text-editor/index.html | 70 +- dev/cli/upgrade/index.html | 70 +- dev/container/index.html | 70 +- dev/developers-guide/index.html | 70 +- dev/dhcp/index.html | 70 +- dev/discovery/index.html | 70 +- dev/eth-counters/index.html | 70 +- dev/hardware/index.html | 70 +- dev/index.html | 234 +++- dev/introduction/index.html | 1833 --------------------------- dev/license/index.html | 70 +- dev/management/index.html | 70 +- dev/netboot/index.html | 70 +- dev/networking/index.html | 70 +- dev/override-package/index.html | 70 +- dev/qos/index.html | 70 +- dev/scripting-prod/index.html | 70 +- dev/scripting-restconf/index.html | 70 +- dev/scripting-sysrepocfg/index.html | 70 +- dev/scripting/index.html | 70 +- dev/search/search_index.json | 2 +- dev/sitemap.xml | 4 - dev/sitemap.xml.gz | Bin 456 -> 451 bytes dev/syslog/index.html | 70 +- dev/system/index.html | 70 +- dev/test-arch/index.html | 70 +- dev/testing/index.html | 70 +- dev/tunnels/index.html | 70 +- dev/upgrade/index.html | 74 +- dev/virtual/index.html | 70 +- dev/vpd/index.html | 70 +- dev/wifi/index.html | 70 +- 41 files changed, 1187 insertions(+), 3542 deletions(-) delete mode 100644 dev/introduction/index.html diff --git a/dev/404.html b/dev/404.html index 2bf3afc8..e1a6ebce 100644 --- a/dev/404.html +++ b/dev/404.html @@ -258,28 +258,6 @@ - - About - - - - - - - - - - - - - - - -
  • - - - - Introduction @@ -324,10 +302,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • + +
  • + + + System Boot + + + + +
  • @@ -1262,10 +1264,10 @@ - + -
    • + +
  • + + + System Boot + + + + +
  • @@ -1975,6 +2001,69 @@ virtualized instances.

    partition can be selected interactively at boot using the arrow keys. It is also possible to permanently configure the default partition from Infix using the Bootloader Configuration.

    +

    System Boot

    +

    After the system firmware (BIOS or and boot loader start +Linux the following happens. The various failure modes, e.g., missing +password in VPD, are detailed later in this section.

    +

    System boot flowchart

    +
      +
    1. Before mounting /cfg and /var partitions, hosting read-writable + data like startup-config and container images, the system first + checks if a factory reset has been requested by the user, if so it + wipes the contents of these partitions
      2. +
    2. Linux boots with a device tree which is used for detecting generic + make and model of the device, e.g., number of interfaces. It may + also reference an EEPROM with Vital Product Data. That is + where the base MAC address and per-device password hash is stored. + (Generic builds use the same MAC address and password)
      3. +
    3. On every boot the system's factory-config and failure-config are + generated from the YANG2 models of the current firmware version. + This ensures that a factory reset device can always boot, and that + there is a working fail safe, or rather fail secure, mode
      4. +
    4. On first power-on, and after a factory reset, the system does not + have a startup-config, in which case factory-config is copied + to startup-config -- if a per-product specific version exists it + is preferred over the generated one
      5. +
    5. Provided the integrity of the startup-config is OK, a system + service loads and activates the configuration
      6. +
    +

    Failure Modes

    +

    So, what happens if any of the steps above fail?

    +

    VPD Fail

    +

    The per-device password cannot be read, or is corrupt, so the system +factory-config and failure-config are not generated:

    +
      +
    1. First boot, or after factory reset: startup-config cannot be + created or loaded, and failure-config cannot be loaded. The + system ends up in an unrecoverable state, i.e., RMA3 Mode
      2. +
    2. The system has booted (at least) once with correct VPD and password + and already has a startup-config. Provided the startup-config + is OK (see below), it is loaded and system boots successfully
      3. +
    +

    In both cases, external factory reset modes/button will not help, and +in the second case will cause the device to fail on the next boot.

    +
    +

    The second case does not yet have any warning or event that can be +detected from the outside. This is planned for a later release.

    +
    +

    Broken startup-config

    +

    If loading startup-config fails for some reason, e.g., invalid JSON +syntax, failed validation against the system's YANG model, or a bug in +the system's confd service, the Fail Secure Mode is triggered and +failure-config is loaded (unless VPD Failure, see above).

    +
    +

    Tip

    +

    Please see the Branding & Releases document for how to +provide per-product failure-config, or factory-config to suit your +product's preferences.

    +
    +

    Fail Secure Mode is a fail-safe mode provided for debugging the +system. The default4 creates a setup of isolated interfaces with +communication only to the management CPU, SSH and console login using +the device's factory reset password, IP connectivity only using IPv6 +link-local, and device discovery protocols: LLDP, mDNS-SD. The login +and shell prompt are set to failure-c0-ff-ee, the last three octets of +the device's base MAC address.

    System Upgrade

    Much of the minutiae of software upgrades is delegated to RAUC, which offers lots of benefits out-of-the-box:

    @@ -2237,6 +2326,23 @@ can funtion reasonably well without a persistent /var, loosing

  • See Upgrade & Boot Order for more information. ↩

    • +
  • +

    YANG is a modeling language from IETF, replacing that used for +SNMP (MIB), used to describe the subsystems and properties of +the system. ↩

    +
    • +
  • +

    Return Merchandise Authorization (RMA), i.e., broken beyond repair +by end-user and eligible for return to manufacturer. ↩

    +
    • +
  • +

    Customer specific builds can define their own failure-config. +It may be the same as factory-config, with the hostname set to +failure, or a dedicated configuration that isolates interfaces, or +even disables ports, to ensure that the device does not cause any +security problems on the network. E.g., start forwarding traffic +between previously isolated VLANs. ↩

    +
    • diff --git a/dev/branding/index.html b/dev/branding/index.html index ad4963d7..c10dd1a9 100644 --- a/dev/branding/index.html +++ b/dev/branding/index.html @@ -269,28 +269,6 @@ - - About - - - - - - - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -337,10 +315,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - - - - Introduction @@ -335,10 +313,10 @@ - + -
    • - - - - - - - - - -
  • - + @@ -299,6 +296,53 @@ + + + + +
    • @@ -336,10 +380,10 @@ - + -