Skip to content

Commit

Permalink
Deploying to gh-pages from @ 8bfe22d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
pepoviola committed Nov 14, 2023
1 parent 9d15cf4 commit 0aacdfd
Show file tree
Hide file tree
Showing 9 changed files with 31 additions and 31 deletions.
2 changes: 1 addition & 1 deletion acknowledgement.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h1 class="menu-title">🧟🧟🧟 ZombieNet 🧟🧟🧟</h1>
<div id="content" class="content">
<main>
<h1 id="acknowledgement"><a class="header" href="#acknowledgement">Acknowledgement</a></h1>
<p>This project take inspiration and some patterns from <a href="https://github.com/paritytech/polkadot-launch">polkadot-launch</a> and <a href="https://gitlab.parity.io/parity/simnet/-/tree/master">simnet</a>.</p>
<p>This project takes inspiration and some patterns from <a href="https://github.com/paritytech/polkadot-launch">polkadot-launch</a> and <a href="https://gitlab.parity.io/parity/simnet/-/tree/master">simnet</a>.</p>

</main>

Expand Down
12 changes: 6 additions & 6 deletions guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,15 +178,15 @@ <h2 id="intro"><a class="header" href="#intro">Intro</a></h2>
<hr />
<h3 id="example-0---different-configuration-file-types-2-validators"><a class="header" href="#example-0---different-configuration-file-types-2-validators">Example 0 - Different configuration file types (2 validators)</a></h3>
<hr />
<p>In this example, is shown the alternateive options of a configuration file. The different extensions supported are: <code>yaml</code>, <code>json</code> and of course <code>.toml</code>.
<p>In this example, is shown the alternative options of a configuration file. The different extensions supported are: <code>yaml</code>, <code>json</code> and of course <code>.toml</code>.
This simple config exists only in order to show how the same configuration exists in 3 different formats, and thus uses only 1 relay chain (<code>rococo-local</code>) with 2 nodes (<code>alice</code> and <code>bob</code>);</p>
<p>The configuration files are:</p>
<ul>
<li><a href="https://github.com/paritytech/zombienet/blob/main/examples/0000-test-config-small-network.json">0000-test-config-small-network.json</a>;</li>
<li><a href="https://github.com/paritytech/zombienet/blob/main/examples/0000-test-config-small-network.yaml">0000-test-config-small-network.yaml</a>;</li>
<li><a href="https://github.com/paritytech/zombienet/blob/main/examples/0000-test-config-small-network.toml">0000-test-config-small-network.toml</a>;</li>
</ul>
<p>and the test files for running each confgiration are:</p>
<p>and the test files for running each configuration are:</p>
<ul>
<li><a href="https://github.com/paritytech/zombienet/blob/main/examples/0000-test-json-config-small-network.zndsl">0000-test-json-config-small-network.zndsl</a>;</li>
<li><a href="https://github.com/paritytech/zombienet/blob/main/examples/0000-test-yaml-config-small-network.zndsl">0000-test-yaml-config-small-network.zndsl</a>;</li>
Expand Down Expand Up @@ -262,7 +262,7 @@ <h3 id="example-1---small-network-2-validators-1-parachain"><a class="header" hr
# logs
bob: log line matches glob &quot;*rted #1*&quot; within 10 seconds
bob: log line matches &quot;Imported #[0-9]+&quot; within 10 seconds
bob: count of log lines maching &quot;Error&quot; is 0 within 10 seconds
bob: count of log lines matching &quot;Error&quot; is 0 within 10 seconds

# system events
bob: system event contains &quot;A candidate was included&quot; within 20 seconds
Expand All @@ -280,7 +280,7 @@ <h3 id="example-1---small-network-2-validators-1-parachain"><a class="header" hr
<h3 id="example-2---small-network-with-replacements"><a class="header" href="#example-2---small-network-with-replacements">Example 2 - Small network with replacements</a></h3>
<hr />
<p>In Example 1, we used some <em>hardcoded</em> default values but sometimes it's more useful to be able to change them dynamically.
For example, if you are building images in your <code>CI</code> and those images have an unique tag. To address these cases, Zombienet uses a templating language called <a href="https://mozilla.github.io/nunjucks/">Nunjucks</a> that allows defining environment variables which then can get updated at <em>runtime</em>.</p>
For example, if you are building images in your <code>CI</code> and those images have a unique tag. To address these cases, Zombienet uses a templating language called <a href="https://mozilla.github.io/nunjucks/">Nunjucks</a> that allows defining environment variables which then can get updated at <em>runtime</em>.</p>
<p>Following the previous example, we will replace the <em>images</em> with variables that will read the value from the environment. An interesting addon test that needs to be noticed here, is that the bob validator, is using a different version of polkadot (v0.9.37) instead of the latest (which at the time of writing this documentation was v0.9.39):</p>
<p><a href="https://github.com/paritytech/zombienet/blob/main/examples/0002-small-network-env-vars.toml">0002-small-network-env-vars.toml</a></p>
<pre><code class="language-toml">[relaychain]
Expand Down Expand Up @@ -319,7 +319,7 @@ <h3 id="example-2---small-network-with-replacements"><a class="header" href="#ex
<p>And again we get the network info with direct links:</p>
<h2 id=""><a class="header" href="#"><img src="./imgs/small-network-envs-launch.png" alt="network info" /></a></h2>
<p>This example shows that we can use custom environmental variables in our config file in order to dynamically alter the configuration of the network.</p>
<p>In addition that the validators support the capability of running different versions of the image.</p>
<p>In addition the validators support the capability of running different versions of the image.</p>
<blockquote>
<p>Note: In general all the config fields that start with <code>default_*</code> can be overridden in the <code>nodes</code> or <code>collators</code> config.</p>
</blockquote>
Expand Down Expand Up @@ -397,7 +397,7 @@ <h4 id="logs-in-podman"><a class="header" href="#logs-in-podman">Logs in Podman<
podman logs -f alice_pod-alice
</code></pre>
<h4 id="logs-in-native"><a class="header" href="#logs-in-native">Logs in native</a></h4>
<p>With the <code>native</code> provider you can follow the logs of the pods with the command suggestion that <code>zombienet</code> gives you when it spawn a new process.
<p>With the <code>native</code> provider you can follow the logs of the pods with the command suggestion that <code>zombienet</code> gives you when it spawns a new process.
For example:</p>
<pre><code> alice running

Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h1 class="menu-title">🧟🧟🧟 ZombieNet 🧟🧟🧟</h1>
<div id="content" class="content">
<main>
<h1 id="what-is-zombienet"><a class="header" href="#what-is-zombienet">What is ZombieNet?</a></h1>
<p>ZombieNet aims to be a testing framework for Substrate based blockchains, providing a simple CLI tool that allowS users to spawn and test ephemeral networks. The assertions used in the tests can include on-chain storage, metrics, logs and custom JS scripts that interact with the chain. To make these easy to define, Zombienet uses a built-in natural language tool to write tests as smoothly as possible.</p>
<p>ZombieNet aims to be a testing framework for Substrate based blockchains, providing a simple CLI tool that allows users to spawn and test ephemeral networks. The assertions used in the tests can include on-chain storage, metrics, logs and custom JS scripts that interact with the chain. To make these easy to define, Zombienet uses a built-in natural language tool to write tests as smoothly as possible.</p>
<p>Internally, it's a JS library designed to run on NodeJS and support different backend providers to run the various blockchain nodes. Currently, Kubernetes, Podman and native are the supported providers.</p>

</main>
Expand Down
2 changes: 1 addition & 1 deletion install.html
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ <h2 id="using-nix"><a class="header" href="#using-nix">Using Nix</a></h2>
<p>Or a particular release can be specified. e.g. to run <code>v1.3.40</code>, use:</p>
<pre><code>nix run github:paritytech/zombienet/v1.3.40 -- spawn config.toml
</code></pre>
<p>Another option is to add he <code>zombienet</code> binary to the <code>PATH</code> for the current shell. This can be done with:</p>
<p>Another option is to add the <code>zombienet</code> binary to the <code>PATH</code> for the current shell. This can be done with:</p>
<pre><code>nix shell github:paritytech/zombienet/v1.3.40
</code></pre>

Expand Down
2 changes: 1 addition & 1 deletion intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h1 class="menu-title">🧟🧟🧟 ZombieNet 🧟🧟🧟</h1>
<div id="content" class="content">
<main>
<h1 id="what-is-zombienet"><a class="header" href="#what-is-zombienet">What is ZombieNet?</a></h1>
<p>ZombieNet aims to be a testing framework for Substrate based blockchains, providing a simple CLI tool that allowS users to spawn and test ephemeral networks. The assertions used in the tests can include on-chain storage, metrics, logs and custom JS scripts that interact with the chain. To make these easy to define, Zombienet uses a built-in natural language tool to write tests as smoothly as possible.</p>
<p>ZombieNet aims to be a testing framework for Substrate based blockchains, providing a simple CLI tool that allows users to spawn and test ephemeral networks. The assertions used in the tests can include on-chain storage, metrics, logs and custom JS scripts that interact with the chain. To make these easy to define, Zombienet uses a built-in natural language tool to write tests as smoothly as possible.</p>
<p>Internally, it's a JS library designed to run on NodeJS and support different backend providers to run the various blockchain nodes. Currently, Kubernetes, Podman and native are the supported providers.</p>

</main>
Expand Down
10 changes: 5 additions & 5 deletions network-definition-spec.html
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ <h2 id="relaychain"><a class="header" href="#relaychain"><code>relaychain</code>
<li><code>chain_spec_path</code>: (String) Path to the chain spec file, <strong>NOTE</strong> should be the <code>plain</code> version to allow customizations.</li>
<li><code>chain_spec_command</code>: (String) Command to generate the chain spec, <strong>NOTE</strong> can't be used in combination with <code>chain_spec_path</code>.</li>
<li><code>default_args</code>: (Array of strings) An array of arguments to use as default to pass to the <code>command</code>.</li>
<li><code>default_substrate_cli_args_version</code>: (0|1) Allow to set the substrate cli args version (see: https://github.com/paritytech/substrate/pull/13384). By default zombienet will evaluate your binary and set the correct version, but that produce an small overhead that could be skipped if you set directly with this key.</li>
<li><code>default_substrate_cli_args_version</code>: (0|1) Allow to set the substrate cli args version (see: https://github.com/paritytech/substrate/pull/13384). By default zombienet will evaluate your binary and set the correct version, but that produces a small overhead that could be skipped if you set directly with this key.</li>
<li><code>default_overrides</code>: (Array of objects) An array of overrides to upload to the nodes, objects with:
<ul>
<li><code>local_path</code>: string;</li>
Expand All @@ -216,7 +216,7 @@ <h2 id="relaychain"><a class="header" href="#relaychain"><code>relaychain</code>
<li><code>command</code>: (String) Override default command.</li>
<li><code>command_with_args</code>: (String) Override default command and args.</li>
<li><code>args</code>: (Array of strings) Arguments to be passed to the <code>command</code>.</li>
<li><code>substrate_cli_args_version</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produce an small overhead that could be skipped if you set directly with this key.</li>
<li><code>substrate_cli_args_version</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produces a small overhead that could be skipped if you set directly with this key.</li>
<li><code>validator</code>: (Boolean, default true) Pass the <code>--validator</code> flag to the <code>command</code>.</li>
<li><code>invulnerable</code>: (Boolean, default false) If true, the node will be added to <code>invulnerables</code> in the chain spec.</li>
<li><code>balance</code>: (number, default 2000000000000) Balance to set in <code>balances</code> for node's account.</li>
Expand Down Expand Up @@ -253,7 +253,7 @@ <h2 id="relaychain"><a class="header" href="#relaychain"><code>relaychain</code>
<li><code>overrides</code>: Array of <code>overrides</code> definitions.</li>
<li><code>prometheus_prefix</code>: A parameter for customizing the metric's prefix for the specific node. Will apply to all the nodes of the group; Defaults to 'substrate'.</li>
<li><code>resources</code>: (Object) <strong>Only</strong> available in <code>kubernetes</code>, represent the resources <code>limits</code>/<code>reservations</code> needed by the node.</li>
<li><code>substrate_cli_args_version</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produce an small overhead that could be skipped if you set directly with this key.</li>
<li><code>substrate_cli_args_version</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produces a small overhead that could be skipped if you set directly with this key.</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -293,7 +293,7 @@ <h2 id="parachains"><a class="header" href="#parachains"><code>parachains</code>
<li><code>image</code>: (String) Image to use.</li>
<li><code>command</code>: (String, default <code>polkadot-parachain</code>) Command to run.</li>
<li><code>args</code>: (Array of strings) An array of arguments to use as default to pass to the <code>command</code>.</li>
<li><code>packages/orchestrator/src/providers/k8s/index.ts</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produce an small overhead that could be skipped if you set directly with this key.</li>
<li><code>packages/orchestrator/src/providers/k8s/index.ts</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produces a small overhead that could be skipped if you set directly with this key.</li>
<li><code>command_with_args</code>: (String) Overrides <code>command</code> and <code>args</code>.</li>
<li><code>env</code>: Array of env vars Object to set in the container.
<ul>
Expand All @@ -317,7 +317,7 @@ <h2 id="parachains"><a class="header" href="#parachains"><code>parachains</code>
<ul>
<li>name: (String) name of the <code>env</code> var.</li>
<li>value: (String| number) Value of the env var.</li>
<li><code>substrate_cli_args_version</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produce an small overhead that could be skipped if you set directly with this key.</li>
<li><code>substrate_cli_args_version</code>: (0|1) By default zombienet will evaluate your binary and set the correct version, but that produces a small overhead that could be skipped if you set directly with this key.</li>
</ul>
</li>
</ul>
Expand Down
Loading

0 comments on commit 0aacdfd

Please sign in to comment.