From c93e1735b1b55d7ea49bb927286a822aa2eabaaa Mon Sep 17 00:00:00 2001 From: Pietro Abate Date: Fri, 7 Feb 2025 10:43:27 +0100 Subject: [PATCH] doc: change packages documentation to remove current packages and promote next packages --- docs/introduction/howtoget.rst | 89 ++++++++-------------------- docs/introduction/install-bin-deb.sh | 1 + docs/releases/version-21.rst | 2 +- 3 files changed, 28 insertions(+), 64 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index cc1e8383bdff..0e2a3a99269f 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -10,7 +10,7 @@ Octez consists of :ref:`several binaries ` (i.e., executable fil There are several options for getting the binaries, depending on how you plan to use Octez: -- :ref:`installing binaries `. +- :ref:`installing packages `. This is the easiest way to install native binaries for the latest stable release, together with their dependencies, using a package manager. - :ref:`using docker images `. This is the easiest way to run the latest stable release of the binaries in @@ -50,31 +50,16 @@ All our installation scenarios are tested daily, including by automated means, t These tests are performed by applying scenarios in several standard environments, from scratch. However, if you encounter problems when performing one of the installation scenarios in your own environment, you may want to take a look at :doc:`get_troubleshooting`. -.. _getting_static_binaries: - -Getting static binaries ------------------------ - -You can get static Linux binaries of the latest release from the -`Octez package registry `__. - -This repository provides static binaries for x86_64 and arm64 architectures. Since these binaries -are static, they can be used on any Linux distribution without any additional prerequisites. -However, note that, by embedding all dependencies, static binary executables are typically much larger than dynamically-linked executables. - -For upgrading to a newer release, you just have to download and run the new -versions of the binaries. - .. _installing_packages: Ubuntu and Debian Octez packages ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -If you're using Ubuntu or Debian, you can install the same packages as in the release page -using ``apt`` directly from our APT repository, instead of going to the Octez -release page as explained above. +If you're using Ubuntu or Debian, you can install the packages +using ``apt`` directly from our APT repository. We support the following distribution/releases: + - ``debian/bookworm`` - ``ubuntu/noble`` - ``ubuntu/jammy`` @@ -99,12 +84,14 @@ We also maintain a separate repository for release candidates. To install the last release candidate simply prepend ``RC/`` to the distribution name as in ``export distribution=RC/debian`` -Then, to install the binaries, run the following commands: +Then, to install the binaries, run the following command to install the octez-baker and all its dependencies: -.. literalinclude:: install-bin-deb.sh - :language: shell - :start-after: [install tezos] - :end-before: [install octez additional packages] +:: + + sudo apt install octez-baker + +Once the Octez binary packages are installed, they can be set up as services +as explained in :doc:`./services`. To remove the Octez packages you can simply run the following command. @@ -113,45 +100,6 @@ To remove the Octez packages you can simply run the following command. :start-after: [test autopurge] :end-before: [check autopurge] -Also there are some experimental packages: - -- ``octez-experimental`` - binaries that are considered experimental including - the Alpha baker -- ``octez-evm-node`` - the EVM endpoint node for Etherlink - -The packages are set up to run under a dedicated user. The ``octez-node``, -``octez-baker`` and ``octez-smartrollup`` packages use a user and group called -tezos. The ``octez-signer`` package uses a user and group called tzsigner. It’s -possible to configure the software to use a different user (even root). - -The documentation for these packages, originally developed by Chris Pinnock, -can be found here: https://chrispinnock.com/tezos/packages/ - -.. _new_packages: - -New set of Debian packages -"""""""""""""""""""""""""" - - -We are developing a new set of Octez Debian packages. They are distributed with latest Octez releases for testing purposes only, and should be considered experimental. - -You can use them to test new packaging features, compatibility and integration with other software and :doc:`share your feedback with us <../developer/contributing>`. - -These will eventually replace the Debian packages mentioned above. - -The new set of packages can be installed by adding the following apt repository:: - - export distribution=next/debian - export release=bookworm - -.. literalinclude:: install-bin-deb.sh - :language: shell - :start-after: [add repository] - :end-before: [end add repository] - -Once the Octez binary packages are installed, they can be set up as services -as explained in :doc:`./services`. - If migrating from Serokell packages you can check out migration documentation :doc:`./serokell`. @@ -172,6 +120,21 @@ For example using ``yum``:: yum install ./octez-client-19.1-1.x86_64.rpm +.. _getting_static_binaries: + +Getting static binaries +----------------------- + +You can get static Linux binaries of the latest release from the +`Octez package registry `__. + +This repository provides static binaries for x86_64 and arm64 architectures. Since these binaries +are static, they can be used on any Linux distribution without any additional prerequisites. +However, note that, by embedding all dependencies, static binary executables are typically much larger than dynamically-linked executables. + +For upgrading to a newer release, you just have to download and run the new +versions of the binaries. + .. _using_docker_images: Using Docker images diff --git a/docs/introduction/install-bin-deb.sh b/docs/introduction/install-bin-deb.sh index b361c0fdea03..72f9d7059fb3 100755 --- a/docs/introduction/install-bin-deb.sh +++ b/docs/introduction/install-bin-deb.sh @@ -120,6 +120,7 @@ apt-get install -y debconf-utils apt-utils procps if [ "$RELEASETYPE" = "Master" ]; then # [add repository] + apg-get update apt-get install -y sudo gpg curl curl -s "https://packages.nomadic-labs.com/$distribution/octez.asc" | diff --git a/docs/releases/version-21.rst b/docs/releases/version-21.rst index 4030c2c06f39..a4cd22a8da02 100644 --- a/docs/releases/version-21.rst +++ b/docs/releases/version-21.rst @@ -163,7 +163,7 @@ The packages, as introduced since Octez version 20, are now **available via APT We recommend users to install them from the APT repository corresponding to their Linux distribution, rather than from the links available in the GitLab release page. In addition, a **new set of Debian packages is now available for testing**. These packages will replace the current available packages in the future. -Check :ref:`the documentation ` for more details. +Check :ref:`the documentation ` for more details. Changelog --------- -- GitLab