Skip to content

Commit

Permalink
deploy: 9ce2fd1
Browse files Browse the repository at this point in the history
  • Loading branch information
@PierreBesson
PierreBesson committed Aug 19, 2024
1 parent 2a70036 commit 241d8a9
Show file tree
Hide file tree
Showing 31 changed files with 59 additions and 59 deletions.
2 changes: 1 addition & 1 deletion deployments/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h1 class="menu-title">Parachain Devops Guide</h1>
<main>
<h1 id="deployments"><a class="header" href="#deployments">Deployments</a></h1>
<p>This section describes the various types of deployments and options used for each.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion deployments/options.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ <h2 id="parachain-specifics"><a class="header" href="#parachain-specifics">Parac
<p>A real life example of this while executing as a statemine collator would be:</p>
<pre><code class="language-bash">./statemine --chain statemine --in-peers 25 --out-peers 25 --db-cache 512 --pruning=1000 --unsafe-pruning -- --chain kusama -db-cache 512 --pruning=1000 --wasm-execution Compiled
</code></pre>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion deployments/roles.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ <h2 id="simplified-diagram-of-the-parachain-network-architecture"><a class="head
<h2 id="downsides-of-deploying-nodes-without-clear-role-separation"><a class="header" href="#downsides-of-deploying-nodes-without-clear-role-separation">Downsides of deploying nodes without clear role separation</a></h2>
<p>Although, it is possible for a single node to assume multiple roles (collator, RPC, bootnode), robust network deployments are composed of multiple nodes of each types to ensure reliability.</p>
<p>For example, if a collator node also serves as an RPC node, receiving increased user traffic might overload the node and bring down block production. To prevent this from happening, it is possible to set up several dedicated RPC nodes behind a load balancer. Similarly, setting up additional collators in your network will allows downtime of fraction of the collator set without slowing down block production.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion deployments/targets.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h1 id="deployment-targets"><a class="header" href="#deployment-targets">Deploym
<tr><td>Kubernetes</td><td>A container orchestration engine to host your blockchain instances. This option is only recommended if you already have prior experience with Kubernetes, especially in production environments.</td></tr>
<tr><td>Local Container</td><td>An instance running on a local container engine (e.g. containerd, docker, Podman).</td></tr>
</tbody></table>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion explanations/chainspecs.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -429,7 +429,7 @@ <h3 id="verify-a-chain-spec-file"><a class="header" href="#verify-a-chain-spec-f
<h3 id="convert-a-plain-chain-spec-to-raw"><a class="header" href="#convert-a-plain-chain-spec-to-raw">Convert a plain chain-spec to raw</a></h3>
<pre><code class="language-bash">chain-spec-builder convert-to-raw chainspec.json &gt; chainspec.raw.json
</code></pre>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion explanations/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ <h2 id="general-approach-to-security"><a class="header" href="#general-approach-
<p>First is using cold / warm / hot keys, so that the compromise of say a session key would not lead to any funds being stolen. Also using multisig accounts on offline devices can greatly help security and also give an on-chain audit trail of all actions, allows for alerting for any onchain actions etc...</p>
<p><img src="../images/AEEVr6.png" alt="key stages" /></p>
<p>Proxy accounts also let you limit the permission that an account or multisig account has on a particular target account (e.g. only staking functions can be executed by the staking controller multisig account and require 3 of 5 people to approve).</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion explanations/keys_accounts.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ <h3 id="insert-a-specific-key-onto-a-node-keystore-using-the-node-binary"><a cla
<li><code>KEY_SCHEME</code>: an encryption scheme (eg. <code>sr25519</code>, <code>ed25519</code>, <code>ecdsa</code>)</li>
<li><code>KEY_FILE</code>: a plain text file which contains the seed or private key</li>
</ul>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion guides/collator_deployment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ <h4 id="install-the-node-helm-chart"><a class="header" href="#install-the-node-h
setPublicAddressToExternalIp:
enabled: true
</code></pre>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion guides/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h1 class="menu-title">Parachain Devops Guide</h1>
<main>
<h1 id="how-to-guides"><a class="header" href="#how-to-guides">How-to Guides</a></h1>
<p>This section provides useful guides for getting started with Polkadot infrastructure.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
4 changes: 2 additions & 2 deletions guides/parachain_deployment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ <h3 id="optional-dry-run-your-parachain-network-locally"><a class="header" href=
<li>Connect to it with <a href="https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944">Polkadot.js Apps</a> on <code>ws://127.0.0.1:9944</code>.</li>
<li>You can inspect the <a href="https://polkadot.js.org/apps/?rpc=ws%3A%2F%2F127.0.0.1%3A9944#/chainstate">chain state in Polkadot.js Apps</a> to verify that everything is in order for the launch.</li>
</ul>
<p>Note: if you look at the node logs, it should be starting to sync the relay-chain (Rococo in our case). You don’t have to wait until it is fully synced.</p>
<p>Note: if you look at the node logs, it should be starting to sync the relay-chain (Rococo in our case). For this dry-run step, you don’t have to wait until it is fully synced. However, after deployment, a node needs to be fully synced in order to collate parachain blocks.</p>
<h2 id="deploy-your-nodes"><a class="header" href="#deploy-your-nodes">Deploy your nodes</a></h2>
<p>You can use any method you choose to set up your nodes on your machines, we recommend either Ansible </p>
<h3 id="deploy-your-nodes-with-ansible"><a class="header" href="#deploy-your-nodes-with-ansible">Deploy your nodes with Ansible</a></h3>
Expand Down Expand Up @@ -395,7 +395,7 @@ <h3 id="reserve-bulk-coretime"><a class="header" href="#reserve-bulk-coretime">R
<p>Note: any account with enough funds can buy and assign coretime for a parachain.</p>
<h3 id="renew-bulk-coretime"><a class="header" href="#renew-bulk-coretime">Renew Bulk Coretime</a></h3>
<p>TODO</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion guides/readiness-checklist.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ <h1 id="tips"><a class="header" href="#tips">Tips:</a></h1>
Other useful debug targets are<code>runtime=debug</code>, <code>sync=debug</code>, <code>author=debug</code>, <code>xcm=debug</code>, etc.</li>
<li>You should avoid setting trace logging on all your nodes; if you do, set it on a limited number of nodes where it is useful and remove it when not needed anymore.</li>
</ul>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion guides/rpc_index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ <h4 id="tools-for-securing-websocket-connections"><a class="header" href="#tools
</ol>
<h3 id="how-to-guides"><a class="header" href="#how-to-guides">How-to Guides</a></h3>
<p>This section provides a deployment guide for an RPC node via Ansible and Kubernetes.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion guides/rpc_kubernetes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ <h3 id="best-practices"><a class="header" href="#best-practices">Best Practices<
<li>A backup is ideally used due to easily scale up new RPC nodes</li>
<li>Enabling serviceMonitor to enable monitoring of the RPC nodes</li>
</ul>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion guides/subkey.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@ <h1 id="generate-node-keys-libp2p-keys"><a class="header" href="#generate-node-k
<p>Use the <code>subkey inspect-node-key</code> command to display the peer identifier for the node that corresponds with the node key in the specified file name. Before using this command, you should have previously used the <code>subkey generate-node-key</code> command and saved the key to a file.</p>
<pre><code>&gt; subkey inspect-node-key --file &lt;file-name&gt;
</code></pre>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h1 id="overview"><a class="header" href="#overview">Overview</a></h1>
<li><a href="./explanations/index.html">Explanations</a>: Explanations of concepts and configurations relevant to Polkadot blockchain infrastructure.</li>
<li><a href="./references/index.html">References</a>: Index of useful links and tools.</li>
</ul>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/helm.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ <h2 id="important-chart-options"><a class="header" href="#important-chart-option
<tr><td>node.flags</td><td>Flags to use with binary in container</td></tr>
<tr><td>node.customChainspecUrl</td><td>Custom Chainspec URL</td></tr>
</tbody></table>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ <h1 class="menu-title">Parachain Devops Guide</h1>
<main>
<h1 id="kubernetes"><a class="header" href="#kubernetes">Kubernetes</a></h1>
<p>As previously mentioned, Kubernetes deployments are only recommended for people with good prior operating experience of Kubernetes.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/key_injection_test.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ <h2 id="verify-keys-exist"><a class="header" href="#verify-keys-exist">Verify ke
&quot;hasKey&quot;: true
}
</code></pre>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion kubernetes/testnetmanager.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ <h3 id="examples"><a class="header" href="#examples">Examples</a></h3>
<h3 id="how-does-it-work-"><a class="header" href="#how-does-it-work-">How does it work ?</a></h3>
<p>The testnet-manager is deployed in the same Kubernetes namespaces as nodes deployed with the <a href="https://github.com/paritytech/helm-charts/tree/main/charts/node">node helm-chart</a>. As node pods deployed with the chart are tagged with the appropriate labels (e.g. chain name, para ID), the manager is able to query the Kubernetes API and list the running nodes for each network (relay-chain, parachains).</p>
<p>By combining this list of nodes with the on-chain state retrieved from RPC endpoints (e.g. list of active validators accounts), the manager can automate node key setup (by interacting directly with each node RPC endpoint) and registration (by submitting sudo extrinsics). Behind the scenes, it uses a derivation formula for generating deterministic Validator/Collator accounts addresses: &quot;${VALIDATORS_ROOT_SEED}//${node-name}&quot;.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion monitoring/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ <h3 id="non-polkadot-specific-tools"><a class="header" href="#non-polkadot-speci
<p>For available set of Polkadot dashboards, alerts and rules are listed in <a href="https://github.com/paritytech/polkadot-monitoring-mixin">polkadot-monitoring-mixin</a> repository.</p>
<p>An example of the metric dashboard from polkadot-monitoring-mixin:</p>
<p><img src="../images/metric_dashboard.png" alt="metric_dashboard" /></p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion monitoring/infrastructure.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ <h2 id="docker-compose"><a class="header" href="#docker-compose">Docker Compose<
regex: '/(.*)'
target_label: 'container'
</code></pre>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion monitoring/polkadot_sdk.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ <h4 id="differences-in-metric-labels"><a class="header" href="#differences-in-me
<h4 id="best-practices"><a class="header" href="#best-practices">Best Practices</a></h4>
<p>To avoid confusion caused by running metrics on different ports, it is recommended to maintain uniformity by using the same Prometheus port (default is 9615) for all relay chain metrics. The chain label in the metrics helps determine which metric belongs to which chain, ensuring clarity and organization.</p>
<p>By following this guide, you can effectively expose and manage Prometheus metrics for both the Polkadot relay chain and parachain binaries.</p>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
2 changes: 1 addition & 1 deletion overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h1 id="overview"><a class="header" href="#overview">Overview</a></h1>
<li><a href="./explanations/index.html">Explanations</a>: Explanations of concepts and configurations relevant to Polkadot blockchain infrastructure.</li>
<li><a href="./references/index.html">References</a>: Index of useful links and tools.</li>
</ul>
<footer id="last-change">Last change: 2024-08-14, commit: <a href="https://github.com/paritytech/devops-guide/commit/674251c">674251c</a></footer>
<footer id="last-change">Last change: 2024-08-19, commit: <a href="https://github.com/paritytech/devops-guide/commit/9ce2fd1">9ce2fd1</a></footer>
</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
Loading

0 comments on commit 241d8a9

Please sign in to comment.