From d512d487dc196dbfdfd18dbffdbb1778625d0150 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 15 Nov 2024 17:29:23 +0100 Subject: [PATCH 1/8] doc: fix presentation of next packages --- docs/introduction/howtoget.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index 82eba5d40d6c..b82a8689ebf8 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -156,12 +156,13 @@ can be found here: https://chrispinnock.com/tezos/packages/ New set of Debian packages """""""""""""""""""""""""" -There is also a new generation of Debian packages that are available for testing. +For testing purposes only, we provide an experimental (or "next") version of the Debian packages for the latest release. You can use them to test new packaging features, compatibility and integration with other softwares and :doc:`share your feedback with us <../developer/contributing>`. + These packages will replace the currently available packages mentioned above. The new set of packages can be installed by adding the following apt repository:: - export distribution=debian + export distribution=next/debian export release=bookworm .. literalinclude:: install-bin-deb.sh -- GitLab From 78b9ad2077fc1f7ae023819f4eda39d6427c33a7 Mon Sep 17 00:00:00 2001 From: Eugen Zalinescu Date: Wed, 20 Nov 2024 15:51:35 +0100 Subject: [PATCH 2/8] Docs: unflag DAL node as Experimental --- docs/shell/cli-commands.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/shell/cli-commands.rst b/docs/shell/cli-commands.rst index cfa0633acf1d..7b7070c3bb87 100644 --- a/docs/shell/cli-commands.rst +++ b/docs/shell/cli-commands.rst @@ -79,8 +79,8 @@ DAC client manual (Experimental) .. _dal_node_manual: -DAL node manual (Experimental) -============================== +DAL node manual +=============== The command line of the Octez DAL node is documented in Unix ``man`` format, as shown below. You can also obtain this manual by running ``octez-dal-node --help``. -- GitLab From b195ef3c6c5615515408674fb9a150cf22448100 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 22 Nov 2024 16:57:48 +0100 Subject: [PATCH 3/8] doc: make sphinx command line visible --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index f2e53fbd469e..7f35fb120ac6 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -214,7 +214,7 @@ docexes-gen: api/errors.rst shell/p2p_api.rst rpc .PHONY: sphinx sphinx: install-dependencies (echo ':orphan:'; echo ''; cat ../CHANGES.rst) > CHANGES-dev.rst - @$(SPHINXBUILD) --builder html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) + $(SPHINXBUILD) --builder html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) @ln -s active "$(BUILDDIR)/paris" || true # Syntax check RST files. -- GitLab From ddaab30f3f52555b36ad8c996ee26b6062ecc563 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Fri, 22 Nov 2024 16:58:35 +0100 Subject: [PATCH 4/8] doc: explain docker storage upgrade in v20 --- docs/releases/version-20.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/releases/version-20.rst b/docs/releases/version-20.rst index 45fed148efd9..469541115eec 100644 --- a/docs/releases/version-20.rst +++ b/docs/releases/version-20.rst @@ -32,9 +32,10 @@ Octez v20.2 fixes an implementation bug in the baker binary. We found that, unde **Even though this scenario is highly unlikely, we still recommend Tezos bakers to upgrade to at least v20.2.** -Octez v20.3 includes a new version (``3.2``) of the node's storage. The upgrade to this new version must be done manually, using ``octez-node upgrade storage``, before running a node with a data directory with an earlier storage version. +Octez v20.3 includes a new version (``3.2``) of the node's storage. The upgrade to this new version must be done manually, using ``octez-node upgrade storage``, before running a node with a data directory with an earlier storage version. +If you are using Docker images, see the storage upgrade procedure at :ref:`using_docker_images`. -Upgrading the storage is irreversible and not backwards compatible: v20.3 nodes do not support data directories with an earlier storage version and earlier versions of Octez do not support the new version neither. +Upgrading the storage is irreversible and not backwards compatible: v20.3 nodes do not support data directories with an earlier storage version and earlier versions of Octez do not support the new version neither. This operation should only take up to 10s in nodes operating in Rolling history mode, which is the recommended setup for bakers. However, it may require around 10 minutes for nodes operating on Full and Archive modes, depending on the performance of the machine. Users must be aware of the downtime during the upgrade that may impact their services. -- GitLab From f3d9417225fae2ff302a06b7a5f20cfa01a0b24e Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Mon, 25 Nov 2024 11:24:25 +0100 Subject: [PATCH 5/8] doc: check consensus rights only when appropriate --- docs/shell/dal_run.rst | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index 586a97888d9f..e2208b5aa47b 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -17,12 +17,6 @@ Running the DAL node Follow these steps to run a DAL node along with a layer 1 node and a baker. -#. Verify that you have attestation rights by running this command, where ``MY_ADDRESS`` is your account's address (not its ``octez-client`` alias): - - .. code-block:: shell - - octez-client rpc get /chains/main/blocks/head/helpers/attestation_rights?delegate="$MY_ADDRESS" - #. Install the DAL trusted setup as described in :ref:`Install DAL trusted setup `. #. Initialize the DAL node by running its ``config init`` command. @@ -71,7 +65,15 @@ Follow these steps to run a DAL node along with a layer 1 node and a baker. The baker daemon connects to the DAL node and attests to the availability of DAL data as well as its usual layer 1 baking function. -#. In a new terminal window, verify that the DAL node is running properly: +#. In a new terminal window, verify that your baking daemon has attestation rights allocated, by running this command, where ``MY_ADDRESS`` is your account's address (not its ``octez-client`` alias): + + .. code-block:: shell + + octez-client rpc get /chains/main/blocks/head/helpers/attestation_rights?delegate="$MY_ADDRESS" + + If the previous command reports no attestation rights (``[]``), you may have to register as a delegate or re-activate your delegate and wait for a few cycles to get some rights (see :ref:`DelegateRegistration`). + +#. Verify that the DAL node is running properly: #. Verify that the node is connected to other DAL nodes by running this command: -- GitLab From 51dcdea0a8c73b43d56691c368092d519f17c4b6 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Tue, 26 Nov 2024 14:34:55 +0000 Subject: [PATCH 6/8] doc: quote '?' in RPC query --- docs/shell/dal_run.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index e2208b5aa47b..3797567a2adf 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -69,7 +69,7 @@ Follow these steps to run a DAL node along with a layer 1 node and a baker. .. code-block:: shell - octez-client rpc get /chains/main/blocks/head/helpers/attestation_rights?delegate="$MY_ADDRESS" + octez-client rpc get "/chains/main/blocks/head/helpers/attestation_rights?delegate=$MY_ADDRESS" If the previous command reports no attestation rights (``[]``), you may have to register as a delegate or re-activate your delegate and wait for a few cycles to get some rights (see :ref:`DelegateRegistration`). -- GitLab From 7fe332aa76748a7db4ae06c4a4bfd6fc1f1bb337 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 27 Nov 2024 11:54:54 +0100 Subject: [PATCH 7/8] doc: add redirections on S3 --- docs/_redirects.s3 | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 docs/_redirects.s3 diff --git a/docs/_redirects.s3 b/docs/_redirects.s3 new file mode 100644 index 000000000000..060a31f03c8a --- /dev/null +++ b/docs/_redirects.s3 @@ -0,0 +1,5 @@ +# These file redirect pages on the S3 bucket using a CloudFront server. +# All redirections are relative to the docs/ folder. + +# this one is temporary, just for testing: +/install.html /introduction/howtoget.html 301 -- GitLab From b8c4974a6058b11a333cba5ac645ebe890552cd8 Mon Sep 17 00:00:00 2001 From: Nic Volanschi Date: Wed, 27 Nov 2024 13:39:36 +0000 Subject: [PATCH 8/8] doc: fixes on fixes --- docs/_redirects.s3 | 2 +- docs/introduction/howtoget.rst | 7 +++++-- docs/releases/version-20.rst | 4 ++-- docs/shell/dal_run.rst | 6 ++++-- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/docs/_redirects.s3 b/docs/_redirects.s3 index 060a31f03c8a..2a285ed73f19 100644 --- a/docs/_redirects.s3 +++ b/docs/_redirects.s3 @@ -1,4 +1,4 @@ -# These file redirect pages on the S3 bucket using a CloudFront server. +# This file redirects pages on the S3 bucket using a CloudFront server. # All redirections are relative to the docs/ folder. # this one is temporary, just for testing: diff --git a/docs/introduction/howtoget.rst b/docs/introduction/howtoget.rst index b82a8689ebf8..e0e2083df967 100644 --- a/docs/introduction/howtoget.rst +++ b/docs/introduction/howtoget.rst @@ -156,9 +156,12 @@ can be found here: https://chrispinnock.com/tezos/packages/ New set of Debian packages """""""""""""""""""""""""" -For testing purposes only, we provide an experimental (or "next") version of the Debian packages for the latest release. You can use them to test new packaging features, compatibility and integration with other softwares and :doc:`share your feedback with us <../developer/contributing>`. -These packages will replace the currently available packages mentioned above. +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:: diff --git a/docs/releases/version-20.rst b/docs/releases/version-20.rst index 469541115eec..ca748609e347 100644 --- a/docs/releases/version-20.rst +++ b/docs/releases/version-20.rst @@ -32,10 +32,10 @@ Octez v20.2 fixes an implementation bug in the baker binary. We found that, unde **Even though this scenario is highly unlikely, we still recommend Tezos bakers to upgrade to at least v20.2.** -Octez v20.3 includes a new version (``3.2``) of the node's storage. The upgrade to this new version must be done manually, using ``octez-node upgrade storage``, before running a node with a data directory with an earlier storage version. +Octez v20.3 includes a new version (``3.2``) of the node's storage. The upgrade to this new version must be done manually, using ``octez-node upgrade storage``, before starting a node with a data directory with an earlier storage version. If you are using Docker images, see the storage upgrade procedure at :ref:`using_docker_images`. -Upgrading the storage is irreversible and not backwards compatible: v20.3 nodes do not support data directories with an earlier storage version and earlier versions of Octez do not support the new version neither. +Upgrading the storage is irreversible and not backwards compatible: v20.3 nodes do not support data directories with an earlier storage version and earlier versions of Octez do not support the new version either. This operation should only take up to 10s in nodes operating in Rolling history mode, which is the recommended setup for bakers. However, it may require around 10 minutes for nodes operating on Full and Archive modes, depending on the performance of the machine. Users must be aware of the downtime during the upgrade that may impact their services. diff --git a/docs/shell/dal_run.rst b/docs/shell/dal_run.rst index 3797567a2adf..fc85129edcb1 100644 --- a/docs/shell/dal_run.rst +++ b/docs/shell/dal_run.rst @@ -26,6 +26,8 @@ Follow these steps to run a DAL node along with a layer 1 node and a baker. octez-dal-node config init --endpoint http://127.0.0.1:8732 + where ``$MY_ADDRESS`` is the baking key address (not the alias registered with ``octez-client``). + You can specify a custom directory to store the DAL node data in by using the ``--data-dir`` argument: .. code-block:: shell @@ -65,13 +67,13 @@ Follow these steps to run a DAL node along with a layer 1 node and a baker. The baker daemon connects to the DAL node and attests to the availability of DAL data as well as its usual layer 1 baking function. -#. In a new terminal window, verify that your baking daemon has attestation rights allocated, by running this command, where ``MY_ADDRESS`` is your account's address (not its ``octez-client`` alias): +#. In a new terminal window, verify that your baking daemon has attestation rights allocated, by running this command: .. code-block:: shell octez-client rpc get "/chains/main/blocks/head/helpers/attestation_rights?delegate=$MY_ADDRESS" - If the previous command reports no attestation rights (``[]``), you may have to register as a delegate or re-activate your delegate and wait for a few cycles to get some rights (see :ref:`DelegateRegistration`). + If the previous command reports no attestation rights (``[]``), first check that you do have attestation rights during the current cycle (by adding the ``"&cycle="`` argument). If that is not the case, you may have to register as a delegate or re-activate your delegate and wait for a few cycles to get some rights (see :ref:`DelegateRegistration`). #. Verify that the DAL node is running properly: -- GitLab