Merge pull request #7 from orelvis15/feature/download_installer_for_hydra

Feature/download installer for hydra

Author: orelvis15

.github/workflows/action.yml

@@ -21,7 +21,7 @@ jobs:
             os: ubuntu-latest
             artifact_name: target/release/cvm
             asset_name: cvm-x86_64
-            target: x86_64-unknown-linux-gnu
+            target: x86_64-unknown-linux-musl
           - name: rpi
             os: ubuntu-latest
             artifact_name: target/release/cvm

CHANGELOG.md

@@ -1,3 +1,6 @@
+## cvm v0.3.0
+- add download cardano bins for hydra
+
 ## cvm v0.2.0
 - add versionate remote config
 

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "cvm"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 authors = ["Orelvis Lago Vasallo"]
 description = "CLI for version control in cardano pools"

Cargo.toml

@@ -9,15 +9,19 @@ This CLI is implemented based on the scripts generated by the community, with th
 [Documentation to get started in the tool](https://orelvis15.github.io/cvm/)
 
 ## Support
+- Compiled download support is provided by IOK, the download is done from the hydra.iohk.io pages themselves, they only provide support for (Ubuntu 18.04 LTS, 20.04 LTS; Mint 19.3, 20; Debian 10.3).
+- Compilation support is provided by CVM, compilation is done on the local server, we are working on supporting RedHat based versions.
 
-|   OS    |    BASH    |     ZSH     |    FISH     |
-|:-------:|:----------:|:-----------:|:-----------:|
-| Ubuntu  |    Yes     | Coming Soon | Coming Soon |
-| Debian  |    Yes     | Coming Soon | Coming Soon |
-| centos  | not tested | Coming Soon | Coming Soon |
-| RedHat  | not tested | Coming Soon | Coming Soon |
-| Fedora  | not tested | Coming Soon | Coming Soon |
-| Rasbian | not tested | Coming Soon | Coming Soon |
+
+    |   OS    | Download |   Build    |
+    |:-------:|:--------:|:----------:|
+    | Ubuntu  |   Yes    |    Yes     |
+    | Debian  |   Yes    |    Yes     |
+    | Debian  |   Yes    |    Yes     |
+    |  Mint   |   Yes    | Not tested |
+    | RedHat  |    -     | Not tested |
+    | Fedora  |    -     | Not tested |
+    | Rasbian |    -     | Not tested |
 
 ## Install CVM Release
 
@@ -30,73 +34,113 @@ curl https://raw.githubusercontent.com/orelvis15/cvm/master/install.sh -sSf | ba
 ```
 curl https://raw.githubusercontent.com/orelvis15/cvm/master/install.sh -sSf | bash -s -- debug && source "$HOME"/.cvm/env
 ```
+## Starting
+
+To start running the cardano node we need to decide how we want to manage the node versions.
 
+#### We have two options
+- Download the executables published by IOK
+- Compile cardano locally
+
+---
 ## Prepare Pool
 
 Prepare the server to be able to run cardano-node.
 
-* Install all necessary dependencies.
-* Create the community-proposed folder structure in [prepare.sh](https://github.com/cardano-community/guild-operators/blob/alpha/scripts/cnode-helper-scripts/prereqs.sh#L427) and other extras.
-* Download all the configuration files depending on the network we select (mainnet by default)
-* Download all the [scripts](https://github.com/cardano-community/guild-operators/tree/alpha/scripts/cnode-helper-scripts) that the community offers us
+#### 1: Using the binary download (**Default**)
 
-### Prepare pool for mainnet
+This is the default option, we just need to run:
 
 `cvm init`
-or
-`cvm init mainnet`
 
-### Prepare pool for testnet
+what happens now?
+
+- It will be verified that the user has write permissions in the `/opt` directory
+- All necessary dependencies will be installed
+- The project folder structure will be created in `/opt/cardano`
+- All scripts and configuration files needed for cardano node to work will be downloaded
+
+#### 2: Compiling locally
+
+For this case it is only necessary to add the `-b` option
+
+`cvm init -b`
 
-`cvm init testnet`
+what happens now?
 
+- Same steps as executed with `cvm init`
+- Ghcup, Cabal and Ghc dependency is installed
+- The libsecp256k1 library is installed (compiled locally)
+
+#### If you want to configure the server for testnet just add `testnet` to the command
+
+`cvm init testnet` | `cvm init -b testnet`
+
+In this case, instead of downloading the configuration files for the mainnet, those corresponding to the testnet would be downloaded.
+
+----
 ## Install cardano node
 
-Build the version of cardano node passed by parameters, by default the latest version is built.
+To install the cardano node binaries on the server we also have two options, it all depends on how you have prepared the server, to download the binaries or to compile them.
 
-### build the x.x.x version
+#### 1: Using the binary download (**Default**)
 
-`
-cvm install x.x.x
-`
+`cvm install x.x.x`
 
-### build last version
+what happens now?
 
-`
-cvm install
-`
+- The binaries corresponding to version x.x.x are downloaded if they exist from the page [Hydra](https://hydra.iohk.io/)
 
+#### 2: Compiling locally
+
+It is mandatory to prepare the server to compile cardano, otherwise this process would fail due to lack of dependencies.
+
+`cvm install -b x.x.x`
+
+what happens now?
+
+- Changes corresponding to the x.x.x version of the [cardano-node](https://github.com/input-output-hk/cardano-node) repository are compiled locally
+
+#### Extra!!
+If we leave the version field blank, cvm will look for the latest release published by IOK.
+
+`cvm install` o `cvm install -b`
+
+---
 ## List install versions
 
 List all version installed.
 
 `
-cvm list
+cvm ls
 `
-or
-`
-cvm -l
-`
-
+---
 ## Use versions
 
-Start using the version passed by parameters. 
-This command creates the relevant services for the operation of the cardano node
+Point the cardano-node service to the version passed by parameters.
 
 `
 cvm use x.x.x
 `
 
+what happens now?
+- The service is created, in case it does not exist or it is updated in case there are any updates.
+- The new version is changed to the current folder where the cnode.services service points.
+- The systemctl daemon is restarted.
+
+---
 ## Remove version
 Delete the specified version
 
 `
 cvm remove x.x.x
 `
 
+---
 ## Start or Stop node
 
 To start or stop the cardano node use
+
 `
 cvm start
 `
@@ -105,6 +149,11 @@ or
 cvm stop
 `
 
+The start command does not set the cardano node service to start automatically, in case of a system reboot you will need to start it manually. If you want to set it to start automatically when the system boots run
+
+`systemctl enable cnode.service`
+
+---
 ## Update cvm
 Update CLI to the latest version
 
@@ -118,14 +167,16 @@ If you want to force the update of all configuration files and scripts
 cvm config update -f
 `
 
+---
 ## Clear cache
 
-Clear cache files of cabal, ghc and cardano build
+Clear cache files of cabal, ghc, cardano build and .cvm/tmp
 
 `
 cvm clean
 `
 
+---
 ## More info and community
 - [Telegram](https://t.me/cvm_cli)
 - [Website](https://sites.google.com/view/cvmcli/inicio)

README.md

@@ -45,8 +45,8 @@ others_files = ["cardano-submit-api", "cardano-api", "cardano-api-test", "cardan
 [download_install]
 base_url = "https://hydra.iohk.io/build/"
 end_url = "/download/1/cardano-node-{version}-linux.tar.gz"
-versions = ["1.35.0"]
-build_id = ["16994721"]
+versions = ["1.35.0", "1.34.1", "1.34.0", "1.33.0", "1.32.1", "1.31.0"]
+build_id = ["16994721", "13065769", "12997298", "9941151", "9116140", "8110920"]
 
 #Services items
 

config/config_remote.toml

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-if [[ $(id -u) == 0 ]] ; then echo "Rlease don't run as root" ; exit 1 ; fi
+if [[ $(id -u) == 0 ]] ; then echo "Please don't run as root" ; exit 1 ; fi
 
 repo="https://api.github.com/repos/orelvis15/cvm/releases/latest"
 env="https://raw.githubusercontent.com/orelvis15/cvm/master/env"

install.sh

@@ -10,6 +10,7 @@ use subcommands::subcommands_impl::install::Install;
 use subcommands::subcommands_impl::list::List;
 use subcommands::subcommands_impl::start::Start;
 use subcommands::subcommands_impl::stop::Stop;
+use crate::subcommands::commands_config::CommandsConfig;
 use crate::subcommands_impl::clean::Clean;
 use crate::subcommands_impl::config::Config;
 use crate::subcommands_impl::r#use::Use;
@@ -53,7 +54,7 @@ fn main() {
         Some(("clean", matches)) => {
             Clean::start(matches)
         }
-        Some(("list", matches)) => {
+        Some(("ls", matches)) => {
             List::start(matches)
         }
         Some(("update", matches)) => {

src/main.rs

@@ -18,10 +18,12 @@ pub fn command_config() -> ArgMatches {
             .about("Start the environment to be able to build a Cardano node")
             .arg(get_arg_network())
             .arg(get_arg_force_init())
+            .arg(get_arg_build_init())
         )
         .subcommand(Command::new(CommandsConfig::INSTALL.to_string())
             .about("Build the cardano node and make it available for use")
             .arg(get_arg_version())
+            .arg(get_arg_build_install())
         )
         .subcommand(Command::new(CommandsConfig::USE.to_string())
             .about("Change the current cardano-node to the new version")
@@ -39,7 +41,7 @@ pub fn command_config() -> ArgMatches {
         )
         .subcommand(Command::new(CommandsConfig::CLEAN.to_string())
             .about("Remove temporary and build files"))
-        .subcommand(Command::new(CommandsConfig::LIST.to_string())
+        .subcommand(Command::new(CommandsConfig::LS.to_string())
             .about("List all installed versions of cardano node"))
         .subcommand(Command::new(CommandsConfig::UPDATE.to_string())
             .about("Update to the new version of CVM if it exists"))
@@ -58,6 +60,20 @@ fn get_arg_network() -> Arg<'static> {
     Arg::new(Args::NETWORK._to_string()).default_value(Args::LATEST._to_string()).takes_value(true)
 }
 
+fn get_arg_build_install() -> Arg<'static> {
+    Arg::new(Args::BUILD._to_string())
+        .short('b')
+        .long(Args::BUILD._to_string())
+        .help("Build cardano-node locally")
+}
+
+fn get_arg_build_init() -> Arg<'static> {
+    Arg::new(Args::BUILD._to_string())
+        .short('b')
+        .long(Args::BUILD._to_string())
+        .help("Prepare server for build cardano-node")
+}
+
 fn get_arg_force_init() -> Arg<'static> {
     Arg::new(Args::FORCE._to_string())
         .short('f')
@@ -77,7 +93,7 @@ pub enum CommandsConfig {
     INSTALL,
     USE,
     REMOVE,
-    LIST,
+    LS,
     UPDATE,
     START,
     STOP,
@@ -92,7 +108,7 @@ impl Display for CommandsConfig {
             CommandsConfig::INSTALL => write!(f, "install"),
             CommandsConfig::USE => write!(f, "use"),
             CommandsConfig::REMOVE => write!(f, "remove"),
-            CommandsConfig::LIST => write!(f, "list"),
+            CommandsConfig::LS => write!(f, "ls"),
             CommandsConfig::UPDATE => write!(f, "update"),
             CommandsConfig::START => write!(f, "start"),
             CommandsConfig::STOP => write!(f, "stop"),
@@ -107,6 +123,7 @@ pub enum Args {
     VERSION,
     LATEST,
     FORCE,
+    BUILD,
 }
 
 impl Args {
@@ -116,6 +133,7 @@ impl Args {
             Args::VERSION => { "version" }
             Args::LATEST => { "latest" }
             Args::FORCE => { "force" }
+            Args::BUILD => { "build" }
         }
     }
 }
@@ -127,6 +145,7 @@ impl Display for Args {
             Args::VERSION => write!(f, "version"),
             Args::LATEST => write!(f, "latest"),
             Args::FORCE => write!(f, "force"),
+            Args::BUILD => write!(f, "build"),
         }
     }
 }