book: deploy updates for 10.5.1 release

Author: johnalotoski

mdbook/README-book.md

@@ -24,4 +24,4 @@ _Use the nagivation panel on the left to explore [The Cardano Book][book]._
 
 <br />
 
-<center><sub><sup><span style="color:lightgray; font-style:italic">0a9e67e887052d1db931483319073e74f2dd3abb</span></sup></sub></center>
+<center><sub><sup><span style="color:lightgray; font-style:italic">56ebfef5595c43014029b039ade01b0ef06233e0</span></sup></sub></center>

static/book.play.dev.cardano.org/README-book.html

@@ -175,7 +175,7 @@ <h3 id="documentation"><a class="header" href="#documentation">Documentation</a>
 <br />
 <hr />
 <br />
-<center><sub><sup><span style="color:lightgray; font-style:italic">0a9e67e887052d1db931483319073e74f2dd3abb</span></sup></sub></center>
+<center><sub><sup><span style="color:lightgray; font-style:italic">56ebfef5595c43014029b039ade01b0ef06233e0</span></sup></sub></center>
 
                     </main>
 

static/book.play.dev.cardano.org/adv-preprod.html

@@ -161,11 +161,10 @@ <h1 class="menu-title">The Cardano Operations Book</h1>
                 <div id="content" class="content">
                     <main>
                         <h2 id="advanced-configuration-pre-production-testnet"><a class="header" href="#advanced-configuration-pre-production-testnet">Advanced Configuration: Pre-Production Testnet</a></h2>
-<p>Users wanting to test a cardano-node pre-release version on the pre-production
-environment may obtain compatible configuration files below.</p>
-<p>The latest version available is cardano-node pre-release <code>10.5.1</code>.</p>
+<p>There is currently no pre-release version available for the preview environment.</p>
+<p>The latest version available is cardano-node release <code>10.5.1</code>.</p>
 <h4 id="configuration-files"><a class="header" href="#configuration-files">Configuration files</a></h4>
-<p>Compatible with cardano-node pre-release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
 <pre><code>NOTE:
 The non-block-producer node config has `PeerSharing` enabled by
 default, so should not be used with block-producers.

static/book.play.dev.cardano.org/adv-preview.html

@@ -161,11 +161,10 @@ <h1 class="menu-title">The Cardano Operations Book</h1>
                 <div id="content" class="content">
                     <main>
                         <h2 id="advanced-configuration-preview-testnet"><a class="header" href="#advanced-configuration-preview-testnet">Advanced Configuration: Preview Testnet</a></h2>
-<p>Users wanting to test a cardano-node pre-release version on the preview
-environment may obtain compatible configuration files below.</p>
-<p>The latest version available is cardano-node pre-release <code>10.5.1</code>.</p>
+<p>There is currently no pre-release version available for the preview environment.</p>
+<p>The latest version available is cardano-node release <code>10.5.1</code>.</p>
 <h4 id="configuration-files"><a class="header" href="#configuration-files">Configuration files</a></h4>
-<p>Compatible with cardano-node pre-release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
 <pre><code>NOTE:
 The non-block-producer node config has `PeerSharing` enabled by
 default, so should not be used with block-producers.

static/book.play.dev.cardano.org/env-mainnet.html

@@ -174,7 +174,7 @@ <h2 id="environment-production-mainnet"><a class="header" href="#environment-pro
 <p>Consulted: SPOs, IOG Tribes, IOG Executive Team</p>
 <p>Informed: Cardano Core Tribe, COO, IOG Director of Engineering, IOG VP Community</p>
 <h4 id="configuration-files"><a class="header" href="#configuration-files">Configuration files</a></h4>
-<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">10.4.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
 <pre><code>NOTE:
 The non-block-producer node config has `PeerSharing` enabled by
 default, so should not be used with block-producers.
@@ -197,19 +197,26 @@ <h4 id="configuration-files"><a class="header" href="#configuration-files">Confi
 <li><a href="environments/mainnet/conway-genesis.json">Conway Genesis</a></li>
 <li><a href="environments/mainnet/guardrails-script.plutus">Compiled guardrails script</a></li>
 </ul>
+<h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode">Ouroboros Genesis Mode</a></h4>
+<p>For those preferring to use Genesis mode over bootstrap peers, the following
+requirements will also need to be met:</p>
+<ul>
+<li>
+<p>The node config file will need to have <code>ConsensusMode</code> set to <code>GenesisMode</code></p>
+</li>
+<li>
+<p>To the topology file, a new key of <code>peerSnapshotFile</code> will need to be added
+and set to the path of the peer snapshot file, provided above.  The declared
+path can be absolute or relative with respect to the directory of the topology
+file.</p>
+</li>
+</ul>
 <h4 id="utxo-hd"><a class="header" href="#utxo-hd">UTXO-HD</a></h4>
-<p>Users migrating from a previous version of the node should read the <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">release
+<p>Users migrating from a node version older than <code>10.4.1</code> should also read the <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">10.4.1 release
 notes</a> and
 the consensus <a href="https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/utxo-hd/migrating">migration guide</a>
 to properly configure the node and convert the database such that a replay from
 genesis can be avoided.</p>
-<h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode">Ouroboros Genesis Mode</a></h4>
-<p>There is a known bug with the experimental Ouroboros Genesis feature that is
-not yet recommended for mainnet use: ChainSync Jumping (CSJ) is not disabled
-once a node is caught up. This should not affect normal operation of the
-syncing node, but does risk a DoS attack for the caught-up node. It will be
-corrected in a future release (Issue
-<a href="https://github.com/IntersectMBO/ouroboros-consensus/issues/1490">IntersectMBO/ouroboros-consensus#1490</a>).</p>
 <h4 id="guardrails-reference-script-utxo"><a class="header" href="#guardrails-reference-script-utxo">Guardrails reference script UTxO</a></h4>
 <p>For convenience, the guardrails script has been put on a UTxO so that it can be used as reference script in
 Treasury Withdrawal and Protocol Parameter Change proposals.</p>

static/book.play.dev.cardano.org/env-preprod.html

@@ -177,7 +177,7 @@ <h2 id="environment-pre-production-testnet"><a class="header" href="#environment
 <p>Consulted: SPOs, IOG Tribes</p>
 <p>Informed: Cardano Core Tribe, COO, Director of Engineering, VP Community</p>
 <h4 id="configuration-files"><a class="header" href="#configuration-files">Configuration files</a></h4>
-<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">10.4.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
 <pre><code>NOTE:
 The non-block-producer node config has `PeerSharing` enabled by
 default, so should not be used with block-producers.
@@ -191,34 +191,26 @@ <h4 id="configuration-files"><a class="header" href="#configuration-files">Confi
 <li><a href="environments/preprod/db-sync-config.json">DB Sync Config</a></li>
 <li><a href="environments/preprod/submit-api-config.json">Submit API Config</a></li>
 <li><a href="environments/preprod/topology.json">Node Topology</a></li>
-<li><a href="environments/preprod/topology-genesis-mode.json">Node Topology (Genesis mode)</a></li>
 <li><a href="environments/preprod/peer-snapshot.json">Peer Snapshot</a></li>
 <li><a href="environments/preprod/byron-genesis.json">Byron Genesis</a></li>
 <li><a href="environments/preprod/shelley-genesis.json">Shelley Genesis</a></li>
 <li><a href="environments/preprod/alonzo-genesis.json">Alonzo Genesis</a></li>
 <li><a href="environments/preprod/conway-genesis.json">Conway Genesis</a></li>
 <li><a href="environments/preprod/guardrails-script.plutus">Compiled guardrails script</a></li>
 </ul>
+<h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode">Ouroboros Genesis Mode</a></h4>
+<p>Ouroboros genesis mode is now the default consensus mode on preview and preprod
+testnets starting with node <code>10.5.0</code>.  If needed, use of praos mode and the
+bootstrap peers found in the above topology file can be reverted to by setting:</p>
+<ul>
+<li>Node config's <code>ConsensusMode</code> option to a value of <code>PraosMode</code></li>
+</ul>
 <h4 id="utxo-hd"><a class="header" href="#utxo-hd">UTXO-HD</a></h4>
-<p>Users migrating from a previous version of the node should read the <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">release
+<p>Users migrating from a node version older than <code>10.4.1</code> should also read the <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">10.4.1 release
 notes</a> and
 the consensus <a href="https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/utxo-hd/migrating">migration guide</a>
 to properly configure the node and convert the database such that a replay from
 genesis can be avoided.</p>
-<h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode">Ouroboros Genesis Mode</a></h4>
-<p>For those preferring to use Genesis mode over bootstrap peers, the Genesis mode
-topology file given above can be used in place of the default topology file.
-The following requirements will also need to be met:</p>
-<ul>
-<li>
-<p>The node config file will need to have <code>ConsensusMode</code> set to <code>GenesisMode</code></p>
-</li>
-<li>
-<p>The peer snapshot file, provided above, will need to exist at the path
-declared at <code>peerSnapshotFile</code> in the genesis mode topology file: an absolute
-path, or a relative path with respect to the node binary directory</p>
-</li>
-</ul>
 <h4 id="guardrails-reference-script-utxo"><a class="header" href="#guardrails-reference-script-utxo">Guardrails reference script UTxO</a></h4>
 <p>For convenience, the guardrails script has been put on a UTxO so that it can be used as reference script in
 Treasury Withdrawal and Update Protocol Parameter proposals.</p>

static/book.play.dev.cardano.org/env-preview.html

@@ -178,7 +178,7 @@ <h2 id="environment-preview-testnet"><a class="header" href="#environment-previe
 <p>Consulted: SPOs</p>
 <p>Informed: Cardano Core Tribe, COO, Director of Engineering</p>
 <h4 id="configuration-files"><a class="header" href="#configuration-files">Configuration files</a></h4>
-<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">10.4.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.5.1">10.5.1</a></p>
 <pre><code>NOTE:
 The non-block-producer node config has `PeerSharing` enabled by
 default, so should not be used with block-producers.
@@ -192,34 +192,26 @@ <h4 id="configuration-files"><a class="header" href="#configuration-files">Confi
 <li><a href="environments/preview/db-sync-config.json">DB Sync Config</a></li>
 <li><a href="environments/preview/submit-api-config.json">Submit API Config</a></li>
 <li><a href="environments/preview/topology.json">Node Topology</a></li>
-<li><a href="environments/preview/topology-genesis-mode.json">Node Topology (Genesis mode)</a></li>
 <li><a href="environments/preview/peer-snapshot.json">Peer Snapshot</a></li>
 <li><a href="environments/preview/byron-genesis.json">Byron Genesis</a></li>
 <li><a href="environments/preview/shelley-genesis.json">Shelley Genesis</a></li>
 <li><a href="environments/preview/alonzo-genesis.json">Alonzo Genesis</a></li>
 <li><a href="environments/preview/conway-genesis.json">Conway Genesis</a></li>
 <li><a href="environments/preview/guardrails-script.plutus">Compiled guardrails script</a></li>
 </ul>
+<h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode">Ouroboros Genesis Mode</a></h4>
+<p>Ouroboros genesis mode is now the default consensus mode on preview and preprod
+testnets starting with node <code>10.5.0</code>.  If needed, use of praos mode and the
+bootstrap peers found in the above topology file can be reverted to by setting:</p>
+<ul>
+<li>Node config's <code>ConsensusMode</code> option to a value of <code>PraosMode</code></li>
+</ul>
 <h4 id="utxo-hd"><a class="header" href="#utxo-hd">UTXO-HD</a></h4>
-<p>Users migrating from a previous version of the node should read the <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">release
+<p>Users migrating from a node version older than <code>10.4.1</code> should also read the <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.4.1">10.4.1 release
 notes</a> and
 the consensus <a href="https://ouroboros-consensus.cardano.intersectmbo.org/docs/for-developers/utxo-hd/migrating">migration guide</a>
 to properly configure the node and convert the database such that a replay from
 genesis can be avoided.</p>
-<h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode">Ouroboros Genesis Mode</a></h4>
-<p>For those preferring to use Genesis mode over bootstrap peers, the Genesis mode
-topology file given above can be used in place of the default topology file.
-The following requirements will also need to be met:</p>
-<ul>
-<li>
-<p>The node config file will need to have <code>ConsensusMode</code> set to <code>GenesisMode</code></p>
-</li>
-<li>
-<p>The peer snapshot file, provided above, will need to exist at the path
-declared at <code>peerSnapshotFile</code> in the genesis mode topology file: an absolute
-path, or a relative path with respect to the node binary directory</p>
-</li>
-</ul>
 <h4 id="guardrails-reference-script-utxo"><a class="header" href="#guardrails-reference-script-utxo">Guardrails reference script UTxO</a></h4>
 <p>For convenience, the guardrails script has been put on a UTxO so that it can be used as reference script in
 Treasury Withdrawal and Protocol Parameter Change proposals.</p>

static/book.play.dev.cardano.org/environments/mainnet/config-bp.json

@@ -19,19 +19,12 @@
     "SnapshotInterval": 4320
   },
   "MaxKnownMajorProtocolVersion": 2,
-  "MinBigLedgerPeersForTrustedState": 5,
   "MinNodeVersion": "10.4.0",
   "PeerSharing": false,
   "Protocol": "Cardano",
   "RequiresNetworkMagic": "RequiresNoMagic",
   "ShelleyGenesisFile": "shelley-genesis.json",
   "ShelleyGenesisHash": "1a3be38bcbb7911969283716ad7aa550250226b76a61fc51cc9a9a35d9276d81",
-  "SyncTargetNumberOfActiveBigLedgerPeers": 30,
-  "SyncTargetNumberOfActivePeers": 0,
-  "SyncTargetNumberOfEstablishedBigLedgerPeers": 50,
-  "SyncTargetNumberOfKnownBigLedgerPeers": 100,
-  "TargetNumberOfActivePeers": 20,
-  "TargetNumberOfEstablishedPeers": 40,
   "TargetNumberOfKnownPeers": 100,
   "TargetNumberOfRootPeers": 100,
   "TraceAcceptPolicy": true,

static/book.play.dev.cardano.org/environments/mainnet/config.json

@@ -19,21 +19,12 @@
     "SnapshotInterval": 4320
   },
   "MaxKnownMajorProtocolVersion": 2,
-  "MinBigLedgerPeersForTrustedState": 5,
   "MinNodeVersion": "10.4.0",
   "PeerSharing": true,
   "Protocol": "Cardano",
   "RequiresNetworkMagic": "RequiresNoMagic",
   "ShelleyGenesisFile": "shelley-genesis.json",
   "ShelleyGenesisHash": "1a3be38bcbb7911969283716ad7aa550250226b76a61fc51cc9a9a35d9276d81",
-  "SyncTargetNumberOfActiveBigLedgerPeers": 30,
-  "SyncTargetNumberOfActivePeers": 0,
-  "SyncTargetNumberOfEstablishedBigLedgerPeers": 50,
-  "SyncTargetNumberOfKnownBigLedgerPeers": 100,
-  "TargetNumberOfActivePeers": 20,
-  "TargetNumberOfEstablishedPeers": 40,
-  "TargetNumberOfKnownPeers": 150,
-  "TargetNumberOfRootPeers": 60,
   "TraceAcceptPolicy": true,
   "TraceBlockFetchClient": false,
   "TraceBlockFetchDecisions": false,