Skip to content

Commit

Permalink
Merge pull request #599 from KtorZ/master
Browse files Browse the repository at this point in the history
Review / rework section 07
  • Loading branch information
olgahryniuk authored Apr 18, 2024
2 parents 9581049 + b215f5e commit 87ad9ee
Show file tree
Hide file tree
Showing 13 changed files with 75 additions and 403 deletions.
19 changes: 9 additions & 10 deletions docs/07-development-guidelines/01-installing-the-cardano-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,24 @@ metaTitle: Installing the Cardano node
## Downloading pre-compiled executables

You can install the Cardano node and the CLI using
[pre-compiled executable files](https://github.com/input-output-hk/cardano-node#executables)
[pre-compiled executable files](https://github.com/intersectmbo/cardano-node/releases/latest)
for your platform.

## Using Docker

You can also use a [Docker](https://www.docker.com/) image to run your Cardano node in a container. For more details, see [this explainer](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/Docker.md).

## Building from source

Alternatively, if you want to build from source, there are two options
available to you. Depending on your build tool preference, you can build from
the source code using either of the following:

- [Cabal: building the node](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md)
- [Nix: building the node](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/building-the-node-using-nix.md)
- [Assisted with Nix](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/building-the-node-using-nix.md) (recommended)
- [Manually with Cabal](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/install.md)

Please refer to the [cardano-node releases page](https://github.com/input-output-hk/cardano-node/releases/latest) to ensure you are working with the latest version of the node.

Once you have installed the node, you need to
[specify the configuration parameters](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/understanding-config-files.md).

## Using Docker
Please refer to the [cardano-node releases page](https://github.com/intersectmbo/cardano-node/releases/latest) to ensure you are working with the latest version of the node.

You can also use a Docker image to build your Cardano node. For more details, see [this explainer](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/Docker.md).
Once you have installed the node, you need to [configure it](https://github.com/input-output-hk/cardano-node-wiki/blob/main/docs/getting-started/understanding-config-files.md).


65 changes: 34 additions & 31 deletions docs/07-development-guidelines/02-cardano-node-course.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,36 +3,39 @@ title: The Cardano node video course
metaTitle: The Cardano node video course
---

The IOG Academy provides this course on YouTube.

The IOG Academy provides this course on YouTube.
<p align="right">
<small>Instructor: Carlos Lopez de Lara, product owner at [Input Output](https://iohk.io/).</small>
</p>

| Video | Summary |
| -------- | --------- |
| [Cardano node course](https://www.youtube.com/playlist?list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR) | Instructor: Carlos Lopez de Lara, product owner, Cardano node. |
| [Building the node with Cabal](https://www.youtube.com/watch?v=csqvbw3F_BU&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=1) | Video 1. Step-by-step demonstration of the whole installation, with prerequisites. |
| [Building the node with Nix](https://www.youtube.com/watch?v=iREukg3-JSM&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=2&pp=iAQB) | Video 2. Another full demonstration, this time using Nix. |
| [Running the node](https://www.youtube.com/watch?v=YlUljmlCPYs&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=3&pp=iAQB) | Video 3. Running the node and connecting to a network. |
| [Generating keys and addresses](https://www.youtube.com/watch?v=8ZYuiRxPAZc&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=4&pp=iAQB) | Video 4. A detailed explanation of generating the different types of keys and addresses used in Cardano. |
| [Simple transactions with the build-raw command](https://www.youtube.com/watch?v=rbst_uiGpI4&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=5&pp=iAQB) | Video 5. Carlos describes the two commands used to build a transaction, and demonstrates the hard way; using the `build-raw` command. |
| [Simple transaction with the build command](https://www.youtube.com/watch?v=AVz_zsDd6wE&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=6&pp=iAQB) | Video 6. A demonstration of the power and convenience of using the `build` command. |
| [Register stake address and delegate to a stake pool](https://www.youtube.com/watch?v=m0BmjjNt19w&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=7&pp=iAQB) | Video 7. Carlos explains certificates and demonstrates the process of delegating ada to the stake pool using the Cardano command line interface. |
| [Protocol parameters 1/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=8&pp=iAQB) | Video 8. Parameters, one of four. These videos explain what the protocol parameters are, and how they influence the behavior of Cardano. |
| [Protocol parameters 2/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=9&pp=iAQB) | Video 9. Parameters, two of four. |
| [Protocol parameters 3/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=10&pp=iAQB) | Video 10. Parameters, three of four. |
| [Protocol parameters 4/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=11&pp=iAQB) | Video 11. Parameters, four of four. |
| [Peer-to-peer (P2P) networking](https://www.youtube.com/watch?v=7YyCJ3fDN0I&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=12&pp=iAQB) | Video 12. P2P networking; a detailed explanation of Dynamic P2P networking and its advantages. |
| [P2P networking; topology and configuration](https://www.youtube.com/watch?v=hOFVL6gjFrw&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=13&pp=iAQB) | Video 13. P2P networking; how to configure the topology and configuration files for the different types of nodes. |
| [Creating a stake pool. The setup](https://www.youtube.com/watch?v=6AQaPdmxnfo&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=14&pp=iAQB) | Video 14. Creating a stake pool; recommended hardware layout and software configuration. |
| [Creating a stake pool. Generating stake pool keys](https://www.youtube.com/watch?v=xydi4_pqOdo&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=15&pp=iAQB) | Video 15. Creating a stake pool; a detailed demonstration and explanation of generating the required keys and other artifacts. |
| [Creating a stake pool. Registering the stake pool](https://www.youtube.com/watch?v=9UK_EFG-nkA&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=16&pp=iAQB) | Video 16. Creating a stake pool; using the artifacts created earlier to complete the registration. |
| [Creating a stake pool. RTS, topology, and systemd](https://www.youtube.com/watch?v=1CaMmsgFPnw&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=17&pp=iAQB) | Video 17. Creating a stake pool; the Haskell runtime options, and how to extend and override them. Details of the topology files and the startup scripts. Using systemd to restart your node as required. |
| [Stake snapshots](https://www.youtube.com/watch?v=t5BOFmy6IYg&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=18&pp=iAQB) | Video 18. How to request test funds from the faucet. Details of stake distribution snapshots. |
| [Stake pool operations. Useful commands 1/2](https://www.youtube.com/watch?v=NCdsk75-7NA&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=19&pp=iAQB) | Video 19. Stake pool operations; useful commands for managing your stake pool; video one of two. |
| [Stake pool operations. Useful commands 2/2](https://www.youtube.com/watch?v=NCdsk75-7NA&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=20&pp=iAQB) | Video 20. Stake pool operations; useful commands two of two. |
| [Monitoring with Prometheus](https://www.youtube.com/watch?v=iqAmwhk7djE&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=21&pp=iAQB) | Video 22. Stake pool operations; how to install and configure Prometheus to monitor your Cardano node. |
| [Cardano governance](https://www.youtube.com/watch?v=biUHK1UDkAY&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=22&pp=iAQB) | Video 23. Carlos discusses the history and mechanism of implementing Cardano updates.
| [Creating a local cluster](https://www.youtube.com/watch?v=2oAonlDUcNY&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=23&pp=iAQB) | Video 24. Creating a local cluster; using the `create-cardano` command. |
| [Local cluster from Byron to Shelley](https://www.youtube.com/watch?v=8Sp2ljOrXXw&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=24&pp=iAQB) | Video 25. Creating a local cluster; moving from genesis to Byron to Shelley. |
| [Creating a stake pool on the local cluster](https://www.youtube.com/watch?v=0svni-Dy4zM&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=25&pp=iAQB) | Video 26. Creating a local cluster; providing funds, keys, and configuration files for a new stake pool. |
| [Bringing the d parameter down](https://www.youtube.com/watch?v=LNUzmhdGPbY&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=26&pp=iAQB) | Video 27. Creating a local cluster; submitting a proposal to bring the decentralization parameter (d) down from 1 to 0.80. |
| [From Shelley to Alonzo](https://www.youtube.com/watch?v=mFyutul_5mU&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=27&pp=iAQB) | Video 28. Creating a local cluster; moving our local cluster from the Shelley era to Alonzo. |
| Video | Summary |
| -------- | --------- |
| [Cardano node course](https://www.youtube.com/playlist?list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR) | Introduction to the course. |
| [Building the node with Cabal](https://www.youtube.com/watch?v=csqvbw3F_BU&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=1) | Step-by-step demonstration of the whole installation, with prerequisites. |
| [Building the node with Nix](https://www.youtube.com/watch?v=iREukg3-JSM&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=2&pp=iAQB) | Another full demonstration, this time using Nix. |
| [Running the node](https://www.youtube.com/watch?v=YlUljmlCPYs&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=3&pp=iAQB) | Running the node and connecting to a network. |
| [Generating keys and addresses](https://www.youtube.com/watch?v=8ZYuiRxPAZc&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=4&pp=iAQB) | A detailed explanation of generating the different types of keys and addresses used in Cardano. |
| [Simple transactions with the build-raw command](https://www.youtube.com/watch?v=rbst_uiGpI4&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=5&pp=iAQB) | Carlos describes the two commands used to build a transaction, and demonstrates the hard way; using the `build-raw` command. |
| [Simple transaction with the build command](https://www.youtube.com/watch?v=AVz_zsDd6wE&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=6&pp=iAQB) | A demonstration of the power and convenience of using the `build` command. |
| [Register stake address and delegate to a stake pool](https://www.youtube.com/watch?v=m0BmjjNt19w&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=7&pp=iAQB) | Carlos explains certificates and demonstrates the process of delegating ada to the stake pool using the Cardano command line interface. |
| [Protocol parameters 1/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=8&pp=iAQB) | Parameters, one of four. These videos explain what the protocol parameters are, and how they influence the behavior of Cardano. |
| [Protocol parameters 2/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=9&pp=iAQB) | Parameters, two of four. |
| [Protocol parameters 3/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=10&pp=iAQB) | Parameters, three of four. |
| [Protocol parameters 4/4](https://www.youtube.com/watch?v=Czwc4U3B5k8&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=11&pp=iAQB) | Parameters, four of four. |
| [Peer-to-peer (P2P) networking](https://www.youtube.com/watch?v=7YyCJ3fDN0I&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=12&pp=iAQB) | P2P networking; a detailed explanation of Dynamic P2P networking and its advantages. |
| [P2P networking; topology and configuration](https://www.youtube.com/watch?v=hOFVL6gjFrw&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=13&pp=iAQB) | P2P networking; how to configure the topology and configuration files for the different types of nodes. |
| [Creating a stake pool. The setup](https://www.youtube.com/watch?v=6AQaPdmxnfo&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=14&pp=iAQB) | Creating a stake pool; recommended hardware layout and software configuration. |
| [Creating a stake pool. Generating stake pool keys](https://www.youtube.com/watch?v=xydi4_pqOdo&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=15&pp=iAQB) | Creating a stake pool; a detailed demonstration and explanation of generating the required keys and other artifacts. |
| [Creating a stake pool. Registering the stake pool](https://www.youtube.com/watch?v=9UK_EFG-nkA&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=16&pp=iAQB) | Creating a stake pool; using the artifacts created earlier to complete the registration. |
| [Creating a stake pool. RTS, topology, and systemd](https://www.youtube.com/watch?v=1CaMmsgFPnw&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=17&pp=iAQB) | Creating a stake pool; the Haskell runtime options, and how to extend and override them. Details of the topology files and the startup scripts. Using systemd to restart your node as required. |
| [Stake snapshots](https://www.youtube.com/watch?v=t5BOFmy6IYg&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=18&pp=iAQB) | How to request test funds from the faucet. Details of stake distribution snapshots. |
| [Stake pool operations. Useful commands 1/2](https://www.youtube.com/watch?v=NCdsk75-7NA&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=19&pp=iAQB) | Stake pool operations; useful commands for managing your stake pool; video one of two. |
| [Stake pool operations. Useful commands 2/2](https://www.youtube.com/watch?v=NCdsk75-7NA&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=20&pp=iAQB) | Stake pool operations; useful commands two of two. |
| [Monitoring with Prometheus](https://www.youtube.com/watch?v=iqAmwhk7djE&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=21&pp=iAQB) | Stake pool operations; how to install and configure Prometheus to monitor your Cardano node. |
| [Cardano governance](https://www.youtube.com/watch?v=biUHK1UDkAY&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=22&pp=iAQB) | Carlos discusses the history and mechanism of implementing Cardano updates.
| [Creating a local cluster](https://www.youtube.com/watch?v=2oAonlDUcNY&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=23&pp=iAQB) | Creating a local cluster; using the `create-cardano` command. |
| [Local cluster from Byron to Shelley](https://www.youtube.com/watch?v=8Sp2ljOrXXw&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=24&pp=iAQB) | Creating a local cluster; moving from genesis to Byron to Shelley. |
| [Creating a stake pool on the local cluster](https://www.youtube.com/watch?v=0svni-Dy4zM&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=25&pp=iAQB) | Creating a local cluster; providing funds, keys, and configuration files for a new stake pool. |
| [Bringing the d parameter down](https://www.youtube.com/watch?v=LNUzmhdGPbY&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=26&pp=iAQB) | Creating a local cluster; submitting a proposal to bring the decentralization parameter (d) down from 1 to 0.80. |
| [From Shelley to Alonzo](https://www.youtube.com/watch?v=mFyutul_5mU&list=PLNEK_Ejlx3x2ut-Pq-hi0NFVsgKB3EddR&index=27&pp=iAQB) | Creating a local cluster; moving our local cluster from the Shelley era to Alonzo. |
23 changes: 0 additions & 23 deletions docs/07-development-guidelines/03-node-tests.mdx

This file was deleted.

Loading

0 comments on commit 87ad9ee

Please sign in to comment.