book: deploy 10.3.1 release promotion

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">abbb59e6eb590e4578655141540a44c2021e7b33</span></sup></sub></center>
+<center><sub><sup><span style="color:lightgray; font-style:italic">9d80cb6f5abe843cfb0284659044f96adb593de0</span></sup></sub></center>

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

@@ -193,7 +193,7 @@ <h3 id="documentation"><a class="header" href="#documentation">Documentation</a>
 <br />
 <hr />
 <br />
-<center><sub><sup><span style="color:lightgray; font-style:italic">abbb59e6eb590e4578655141540a44c2021e7b33</span></sup></sub></center>
+<center><sub><sup><span style="color:lightgray; font-style:italic">9d80cb6f5abe843cfb0284659044f96adb593de0</span></sup></sub></center>
 
                     </main>
 

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

@@ -179,11 +179,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 preprod
-environment may obtain compatible configuration files below.</p>
-<p>The latest version available is cardano-node pre-release <code>10.3.1</code>.</p>
+<p>There is currently no pre-release version available for the preprod environment.</p>
+<p>The latest version available is cardano-node release <code>10.3.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.3.1">10.3.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.3.1">10.3.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.
@@ -211,12 +210,12 @@ <h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode"
 The following requirements will also need to be met:</p>
 <ul>
 <li>
-<p>The node config will need to have <code>ConsensusMode</code> set to <code>GenesisMode</code></p>
+<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 server invocation directory</p>
+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>

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

@@ -179,11 +179,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.3.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.3.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.3.1">10.3.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.3.1">10.3.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.
@@ -211,12 +210,12 @@ <h4 id="ouroboros-genesis-mode"><a class="header" href="#ouroboros-genesis-mode"
 The following requirements will also need to be met:</p>
 <ul>
 <li>
-<p>The node config will need to have <code>ConsensusMode</code> set to <code>GenesisMode</code></p>
+<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 server invocation directory</p>
+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>

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

@@ -192,7 +192,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.2.1">10.2.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.3.1">10.3.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.
@@ -206,13 +206,35 @@ <h4 id="configuration-files"><a class="header" href="#configuration-files">Confi
 <li><a href="environments/mainnet/db-sync-config.json">DB Sync Config</a></li>
 <li><a href="environments/mainnet/submit-api-config.json">Submit API Config</a></li>
 <li><a href="environments/mainnet/topology.json">Node Topology</a></li>
+<li><a href="environments/mainnet/topology-genesis-mode.json">Node Topology (Genesis mode)</a></li>
 <li><a href="environments/mainnet/topology-non-bootstrap-peers.json">Node Topology (Non-bootstrap-peers)</a></li>
+<li><a href="environments/mainnet/peer-snapshot.json">Peer Snapshot</a></li>
+<li><a href="environments/mainnet/checkpoints.json">Checkpoints</a></li>
 <li><a href="environments/mainnet/byron-genesis.json">Byron Genesis</a></li>
 <li><a href="environments/mainnet/shelley-genesis.json">Shelley Genesis</a></li>
 <li><a href="environments/mainnet/alonzo-genesis.json">Alonzo Genesis</a></li>
 <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 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>
+<li>
+<p>The checkpoints file, provided above, will need to exist at the path
+declared at <code>CheckpointsFile</code> in the node config file: an absolute
+path, or a relative path with respect to the config file 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/env-preprod.html

@@ -195,7 +195,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.2.1">10.2.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.3.1">10.3.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.
@@ -209,12 +209,28 @@ <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>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

@@ -196,7 +196,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.2.1">10.2.1</a></p>
+<p>Compatible with cardano-node release <a href="https://github.com/IntersectMBO/cardano-node/releases/tag/10.3.1">10.3.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.
@@ -210,12 +210,28 @@ <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>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>