Skip to content

Commit

Permalink
Move dbscripts SQL to koios-artifacts repo, and prep v1.1.0 (#1708)
Browse files Browse the repository at this point in the history
  • Loading branch information
@rdlrt
rdlrt committed Nov 27, 2023
1 parent 0c55c1d commit 71a1917
Show file tree
Hide file tree
Showing 6 changed files with 76 additions and 55 deletions.
17 changes: 2 additions & 15 deletions Scripts/gliveview/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -889,21 +889,8 @@ <h1>gLiveView</h1>
<p>Ensure the <a href="../../basics/#pre-requisites">Pre-Requisites</a> are in place before you proceed.</p>
</div>
<p><strong>Koios gLiveView</strong> is a local monitoring tool to use in addition to remote monitoring tools like Prometheus/Grafana, Zabbix or IOG's RTView. This is especially useful when moving to a systemd deployment - if you haven't done so already - as it offers an intuitive UI to monitor the node status.</p>
<p>The tool is independent from other files and can run as a standalone utility that can be stopped/started without affecting the status of <code>cardano-node</code>.</p>
<h5 id="download">Download<a class="headerlink" href="#download" title="Permanent link">⚓︎</a></h5>
<p>If you've used <a href="../../basics/#pre-requisites">guild-deploy.sh</a>, you can skip this part, as this is already set up for you. The tool relies on the common <code>env</code> configuration file.
To get current epoch blocks, the <a href="../logmonitor/">logMonitor.sh</a> script is needed (and can be combined with <a href="../cncli/">CNCLI</a>). This is optional and <strong>Koios gLiveView</strong> will function without it.</p>
<div class="admonition info">
<p class="admonition-title">Note</p>
<p>For those who follow the <a href="../../basics/#folder-structure">folder structure</a> in this repo and do not wish to run <code>guild-deploy.sh</code>, you can run the below in <code>$CNODE_HOME/scripts</code> folder</p>
</div>
<p>To download the script:</p>
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-s<span class="w"> </span>-o<span class="w"> </span>gLiveView.sh<span class="w"> </span>https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/gLiveView.sh
curl<span class="w"> </span>-s<span class="w"> </span>-o<span class="w"> </span>env<span class="w"> </span>https://raw.githubusercontent.com/cardano-community/guild-operators/master/scripts/cnode-helper-scripts/env
chmod<span class="w"> </span><span class="m">755</span><span class="w"> </span>gLiveView.sh
</code></pre></div>
<h5 id="configuration-startup">Configuration &amp; Startup<a class="headerlink" href="#configuration-startup" title="Permanent link">⚓︎</a></h5>
<p>For most setups, it's enough to set <code>CNODE_PORT</code> in the <code>env</code> file. The rest of the variables should automatically be detected. If required, modify User Variables in <code>env</code> and <code>gLiveView.sh</code> to suit your environment (if folder structure you use is different). This should lead you to a stage where you can now start running <code>./gLiveView.sh</code> in the folder you downloaded the script (the default location would be <code>$CNODE_HOME/scripts</code>). Note that the script is smart enough to automatically detect when you're running as a Core or Relay and will show fields accordingly.</p>
<p>For most setups, it's enough to set <code>CNODE_PORT</code> in the <code>env</code> file. The rest of the variables should automatically be detected. If required, modify User Variables in <code>env</code> and <code>gLiveView.sh</code> to suit your environment (if the environment is customised). This should lead you to a stage where you can now start running <code>./gLiveView.sh</code> in the folder you downloaded the script (the default location would be <code>$CNODE_HOME/scripts</code>). Note that the script is smart enough to automatically detect when you're running as a Core or Relay and will show fields accordingly.</p>
<p>The tool can be run in legacy mode with only standard ASCII characters for terminals with trouble displaying the box-drawing characters. Run <code>./gLiveView.sh -h</code> to show available command-line parameters or permanently set it directly in script.</p>
<p>A sample output from both core and relay together with peer analysis:</p>
<div class="tabbed-set" data-tabs="1:3"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><label for="__tabbed_1_1">Core</label><div class="tabbed-content">
Expand Down Expand Up @@ -938,7 +925,7 @@ <h6 id="upper-main-section">Upper main section<a class="headerlink" href="#upper
<li><strong>Mem (RSS)</strong> - RSS is the Resident Set Size and shows how much memory is allocated to cardano-node and that is in RAM. It does not include memory that is swapped out. It does include memory from shared libraries as long as the pages from those libraries are actually in memory. It does include all stack and heap memory. </li>
<li><strong>Mem (Live) / (Heap)</strong> - GC (Garbage Collector) values that show how much memory is used for live/heap data. A large difference between them (or the heap approaching the physical memory limit) means the node is struggling with the garbage collector and/or may begin swapping. </li>
<li><strong>GC Minor / Major</strong> - Collecting garbage from "Young space" is called a Minor GC. Major (Full) GC is done more rarily and is a more expensive operation. Explaining garbage collection is a topic outside the scope of this documentation and google is your friend for this. </li>
<li><strong>Block propagation</strong> - Last delay measures the duration between when the last block was scheduled to be produced and when the node learned about it. Late blocks are blocks whose delay is larger than 5s. If the node is not synching, the number of late blocks needs to stay low. Within &#8531;/5s estimates the chance of observing a delay of &#8531;/5s (based on the delays observed for previous blocks). A healthy node needs to stay above 95% of blocks within 3s. Finally, served blocks counts how many blocks were fetched by "in" peers. If this does not increase for a long time, it means the "in" peers are learning about new blocks from somewhere else (and therefore this node is not contributing towards accelerating the propagation). Overall, these metrics are helpful in tweaking the topology and/or performance of the network links. </li>
<li><strong>Block propagation</strong> - Last Block measures the duration between when the last block was scheduled to be produced and when the node learned about it. Late blocks are blocks whose delay is larger than 5s. If the node is not synching, the number of late blocks needs to stay low. Within &#8531;/5s estimates the chance of observing a delay of &#8531;/5s (based on the delays observed for previous blocks). A healthy node needs to stay above 95% of blocks within 3s. Finally, served blocks counts how many blocks were fetched by "in" peers. If this does not increase for a long time, it means the "in" peers are learning about new blocks from somewhere else (and therefore this node is not contributing towards accelerating the propagation). Overall, these metrics are helpful in tweaking the topology and/or performance of the network links. </li>
</ul>
<h6 id="core-section">Core section<a class="headerlink" href="#core-section" title="Permanent link">⚓︎</a></h6>
<p>If the node is run as a core, identified by the 'forge-about-to-lead' parameter, a second core section is displayed.</p>
Expand Down
41 changes: 37 additions & 4 deletions docker/docker/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -744,6 +744,19 @@
🔔 Built-in Cardano software
</a>

<nav class="md-nav" aria-label="🔔 Built-in Cardano software">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#mithril" class="md-nav__link">
Mithril
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -992,6 +1005,19 @@
🔔 Built-in Cardano software
</a>

<nav class="md-nav" aria-label="🔔 Built-in Cardano software">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#mithril" class="md-nav__link">
Mithril
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1099,12 +1125,18 @@ <h3 id="built-in-cardano-software">🔔 Built-in Cardano software<a class="heade
<li>cardano-hw-cli</li>
<li>cardano-node</li>
<li>cardano-submit-api</li>
<li>mithril-client</li>
<li>mithril-signer</li>
</ul>
<h4 id="mithril">Mithril<a class="headerlink" href="#mithril" title="Permanent link">⚓︎</a></h4>
<h3 id="built-in-tools">🔔 Built-in tools<a class="headerlink" href="#built-in-tools" title="Permanent link">⚓︎</a></h3>
<ul>
<li>CNTools</li>
<li>gLiveView</li>
<li>CNCLI</li>
<li>Ogmios</li>
<li>Cardano Hardware CLI</li>
<li>Cardano Signer</li>
<li>Monitoring ready (with EKG and Prometheus)</li>
</ul>
<h4 id="docker-splash-screen">Docker Splash screen<a class="headerlink" href="#docker-splash-screen" title="Permanent link">⚓︎</a></h4>
Expand All @@ -1119,11 +1151,12 @@ <h4 id="cncli">CNCLI<a class="headerlink" href="#cncli" title="Permanent link">
<p><img alt="CNCLI" src="../imgs/cncli.png" /></p>
<h4 id="strategy">Guild Operators Docker strategy ( mainnet/ preview / preprod / guild)<a class="headerlink" href="#strategy" title="Permanent link">⚓︎</a></h4>
<p>Modular docker images based on Debian.</p>
<p>Based on the Guild's work we decided to build the Cardano Node images in 3 stages:</p>
<p>Based on the Guild's work the Cardano Node image is built in a single stage: -&gt; <a href="https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_bin">dockerfile_bin</a></p>
<ul>
<li>1<sup>st</sup> stage: it uses <code>prereq.sh</code> to prepare the development environment before compiling the node source code. -&gt; <a href="https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_stage1">Stage1</a></li>
<li>2<sup>nd</sup> stage: based on stage1, this stage intent is to compile and produce the binaries of the node. -&gt; <a href="https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_stage2">Stage2</a></li>
<li>3<sup>rd</sup> stage: based upon a minimal debian image it incorporates the node's binaries as well as all the Koios' SPO tools. -&gt; <a href="https://github.com/cardano-community/guild-operators/blob/master/files/docker/node/dockerfile_stage3">Stage3</a></li>
<li>Uses <code>guild-deploy.sh</code> to:</li>
<li>Install the os prerequisites</li>
<li>Add the cardano software from release binaries</li>
<li>Add the guild's SPO tools and the node's configuration files.</li>
</ul>
<h3 id="additional-docs">Additional docs<a class="headerlink" href="#additional-docs" title="Permanent link">⚓︎</a></h3>
<p>If you prefer to build the images your own than you can check:</p>
Expand Down
3 changes: 2 additions & 1 deletion docker/run/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1025,7 +1025,8 @@ <h4 id="use-cases_1">Use Cases:<a class="headerlink" href="#use-cases_1" title="
<p class="admonition-title">Note</p>
<p>1) <code>--entrypoint=bash</code> # This option won't start the node's container but only the OS running (the node software wont actually start, you'll need to manually execute entrypoint.sh ), ready to get in (trough the command <code>docker exec -it &lt; container name or hash &gt; /bin/bash</code>) and play/explore around with it in command line mode.
2) all guild tools env variable can be used to start a new container using custom values by using the "-e" option.
3) CPU and RAM and SHared Memory allocation option for the container can be used when you start the container (i.e. --shm-size or --memory or --cpus <a href="https://docs.docker.com/config/containers/resource_constraints/">official docker resource docs</a>)</p>
3) CPU and RAM and Shared Memory allocation option for the container can be used when you start the container (i.e. --shm-size or --memory or --cpus <a href="https://docs.docker.com/config/containers/resource_constraints/">official docker resource docs</a>)
4) <code>--env MITHRIL_DOWNLOAD=Y</code> # This option will allow Mithril client to download the latest Mithril snapshot of the blockchain when the container starts and does not have a copy of the blockchain yet. This is useful when you want to start a new node from scratch and don't want to wait for the node to sync from the network. This option is only available for the mainnet, preprod, and preview networks.</p>
</div>


Expand Down
2 changes: 1 addition & 1 deletion search/search_index.json
View file

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions sitemap.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,172 +2,172 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://cardano-community.github.io/guild-operators/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/basics/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/build/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/contributors/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/grest-meets/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/sidebar/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/upgrade/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Appendix/RecoverByronWallet/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Appendix/monitoring/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Appendix/postgres/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/dbsync/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/graphql/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/grest-changelog/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/grest/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/node-cli/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/offchain-metadata-tools/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Build/wallet/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/blockperf/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/cncli/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/cntools-changelog/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/cntools-common/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/cntools/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/env/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/gliveview/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/itnrewards/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/itnwitness/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/logmonitor/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/sendalerts/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/Scripts/topologyupdater/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/docker/build/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/docker/docker/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/docker/run/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/docker/security/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>https://cardano-community.github.io/guild-operators/docker/tips/</loc>
<lastmod>2023-11-03</lastmod>
<lastmod>2023-11-27</lastmod>
<changefreq>daily</changefreq>
</url>
</urlset>
Binary file modified sitemap.xml.gz
View file
Binary file not shown.

0 comments on commit 71a1917

Please sign in to comment.