From f598d9d5ae2eed9129dc47686759926726961ccf Mon Sep 17 00:00:00 2001 From: Emil Lai Date: Tue, 5 Sep 2023 09:26:57 +0200 Subject: [PATCH 1/5] Note for collector when using tls. --- source/mainnet/net/guides/run-node-macos.rst | 3 +++ source/mainnet/net/guides/run-node-ubuntu.rst | 3 +++ source/mainnet/net/guides/run-node-windows.rst | 3 +++ 3 files changed, 9 insertions(+) diff --git a/source/mainnet/net/guides/run-node-macos.rst b/source/mainnet/net/guides/run-node-macos.rst index f210d6788c..fbefc49edd 100644 --- a/source/mainnet/net/guides/run-node-macos.rst +++ b/source/mainnet/net/guides/run-node-macos.rst @@ -286,6 +286,9 @@ Since the GRPC V2 port is different than the GRPC V1 port, you need to change it .. _configure-baker-macos: +.. Note:: + If the node grpc host is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + Configure a node as a baker =========================== diff --git a/source/mainnet/net/guides/run-node-ubuntu.rst b/source/mainnet/net/guides/run-node-ubuntu.rst index 7102996dcd..67a36344f0 100644 --- a/source/mainnet/net/guides/run-node-ubuntu.rst +++ b/source/mainnet/net/guides/run-node-ubuntu.rst @@ -127,6 +127,9 @@ This will open your overrides in your default editor. Below is an example for th .. _upgrade-node-Ubuntu: +.. Note:: + If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + Upgrade version =============== diff --git a/source/mainnet/net/guides/run-node-windows.rst b/source/mainnet/net/guides/run-node-windows.rst index 2b7c455600..697cd43a3d 100644 --- a/source/mainnet/net/guides/run-node-windows.rst +++ b/source/mainnet/net/guides/run-node-windows.rst @@ -244,6 +244,9 @@ Node collector configuration Since version 5.3.2 of the node, the collector uses the GRPC V2 interface. Therefore, in order to run the collector, it is required that the node which the collector connects to has the GRPC V2 interface enabled. For information about how to do this, see :ref:`the note at the top of this topic`. +.. Note:: + If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + Baking on a Windows node ======================== From b69ba6a1f76a396029d3ff1c109f742cac9bd61e Mon Sep 17 00:00:00 2001 From: Emil Lai Date: Mon, 11 Sep 2023 12:51:26 +0200 Subject: [PATCH 2/5] Add note box to docker setup for collector and tls. --- source/mainnet/net/guides/run-node-macos.rst | 2 +- source/mainnet/net/guides/run-node-ubuntu.rst | 2 +- source/mainnet/net/guides/run-node-windows.rst | 2 +- source/mainnet/net/guides/run-node.rst | 3 +++ 4 files changed, 6 insertions(+), 3 deletions(-) diff --git a/source/mainnet/net/guides/run-node-macos.rst b/source/mainnet/net/guides/run-node-macos.rst index fbefc49edd..a9f5b12199 100644 --- a/source/mainnet/net/guides/run-node-macos.rst +++ b/source/mainnet/net/guides/run-node-macos.rst @@ -287,7 +287,7 @@ Since the GRPC V2 port is different than the GRPC V1 port, you need to change it .. _configure-baker-macos: .. Note:: - If the node grpc host is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. Configure a node as a baker =========================== diff --git a/source/mainnet/net/guides/run-node-ubuntu.rst b/source/mainnet/net/guides/run-node-ubuntu.rst index 67a36344f0..1493136871 100644 --- a/source/mainnet/net/guides/run-node-ubuntu.rst +++ b/source/mainnet/net/guides/run-node-ubuntu.rst @@ -128,7 +128,7 @@ This will open your overrides in your default editor. Below is an example for th .. _upgrade-node-Ubuntu: .. Note:: - If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. Upgrade version =============== diff --git a/source/mainnet/net/guides/run-node-windows.rst b/source/mainnet/net/guides/run-node-windows.rst index 697cd43a3d..390c620257 100644 --- a/source/mainnet/net/guides/run-node-windows.rst +++ b/source/mainnet/net/guides/run-node-windows.rst @@ -245,7 +245,7 @@ Node collector configuration Since version 5.3.2 of the node, the collector uses the GRPC V2 interface. Therefore, in order to run the collector, it is required that the node which the collector connects to has the GRPC V2 interface enabled. For information about how to do this, see :ref:`the note at the top of this topic`. .. Note:: - If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. Baking on a Windows node ======================== diff --git a/source/mainnet/net/guides/run-node.rst b/source/mainnet/net/guides/run-node.rst index 40a8896b16..8642b911ff 100644 --- a/source/mainnet/net/guides/run-node.rst +++ b/source/mainnet/net/guides/run-node.rst @@ -92,6 +92,9 @@ The node requires a database which must be stored on the host system so that it enabled, make sure to edit your configuration, adding ``CONCORDIUM_NODE_GRPC2_LISTEN_PORT`` and ``CONCORDIUM_NODE_GRPC2_LISTEN_ADDRESS`` as in the sample configurations. +.. Note:: + If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + .. Note:: When upgrading, you can only upgrade one minor version at a time, or from the last release of major version X to major version X+1. You cannot skip versions. For patches, you can skip versions e.g. X.X.0 to X.X.3, or `X.1.1` to `X.2.3`. From 81d9dc26804ad730f5fe242da7fd3004911343df Mon Sep 17 00:00:00 2001 From: dg-concordium Date: Mon, 18 Sep 2023 13:43:33 +0200 Subject: [PATCH 3/5] Address review comments --- source/mainnet/net/guides/run-node-macos.rst | 2 +- source/mainnet/net/guides/run-node-ubuntu.rst | 2 +- source/mainnet/net/guides/run-node-windows.rst | 2 +- source/mainnet/net/guides/run-node.rst | 2 +- source/mainnet/net/nodes/run-node-ubuntu.rst | 3 +++ 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/source/mainnet/net/guides/run-node-macos.rst b/source/mainnet/net/guides/run-node-macos.rst index a9f5b12199..5188e50539 100644 --- a/source/mainnet/net/guides/run-node-macos.rst +++ b/source/mainnet/net/guides/run-node-macos.rst @@ -287,7 +287,7 @@ Since the GRPC V2 port is different than the GRPC V1 port, you need to change it .. _configure-baker-macos: .. Note:: - If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is `configured with TLS `_, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. Configure a node as a baker =========================== diff --git a/source/mainnet/net/guides/run-node-ubuntu.rst b/source/mainnet/net/guides/run-node-ubuntu.rst index 1493136871..d9c44e33ed 100644 --- a/source/mainnet/net/guides/run-node-ubuntu.rst +++ b/source/mainnet/net/guides/run-node-ubuntu.rst @@ -128,7 +128,7 @@ This will open your overrides in your default editor. Below is an example for th .. _upgrade-node-Ubuntu: .. Note:: - If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is `configured with TLS `_, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate, for example, ``Environment=CONCORDIUM_NODE_COLLECTOR_GRPC_HOST=https://example.concordium-node.io:20000``. Upgrade version =============== diff --git a/source/mainnet/net/guides/run-node-windows.rst b/source/mainnet/net/guides/run-node-windows.rst index 390c620257..00ce5e6288 100644 --- a/source/mainnet/net/guides/run-node-windows.rst +++ b/source/mainnet/net/guides/run-node-windows.rst @@ -245,7 +245,7 @@ Node collector configuration Since version 5.3.2 of the node, the collector uses the GRPC V2 interface. Therefore, in order to run the collector, it is required that the node which the collector connects to has the GRPC V2 interface enabled. For information about how to do this, see :ref:`the note at the top of this topic`. .. Note:: - If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is `configured with TLS `_, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. Baking on a Windows node ======================== diff --git a/source/mainnet/net/guides/run-node.rst b/source/mainnet/net/guides/run-node.rst index 8642b911ff..9ae9bef388 100644 --- a/source/mainnet/net/guides/run-node.rst +++ b/source/mainnet/net/guides/run-node.rst @@ -93,7 +93,7 @@ The node requires a database which must be stored on the host system so that it and ``CONCORDIUM_NODE_GRPC2_LISTEN_ADDRESS`` as in the sample configurations. .. Note:: - If the node is configured with TLS, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate. + If the node is `configured with TLS `_, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate, for example, ``CONCORDIUM_NODE_COLLECTOR_GRPC_HOST=https://example.concordium-node.io:20000``. .. Note:: diff --git a/source/mainnet/net/nodes/run-node-ubuntu.rst b/source/mainnet/net/nodes/run-node-ubuntu.rst index c2573cc0be..1ab8bd318d 100644 --- a/source/mainnet/net/nodes/run-node-ubuntu.rst +++ b/source/mainnet/net/nodes/run-node-ubuntu.rst @@ -125,6 +125,9 @@ This will open your overrides in your default editor. Below is an example for th [Service] Environment=CONCORDIUM_NODE_COLLECTOR_GRPC_HOST=http://localhost:20001 +.. Note:: + If the node is `configured with TLS `_, then `CONCORDIUM_NODE_COLLECTOR_GRPC_HOST` must be configured such that it uses the domain of the certificate, for example, ``Environment=CONCORDIUM_NODE_COLLECTOR_GRPC_HOST=https://example.concordium-node.io:20000``. + .. _upgrade-node-Ubuntu-testnet: Upgrade version From 5b06e1aa8cd3d05d7c45801eacd8e993321f1500 Mon Sep 17 00:00:00 2001 From: dg-concordium Date: Mon, 18 Sep 2023 13:48:41 +0200 Subject: [PATCH 4/5] Fix lint error --- source/mainnet/net/guides/run-node-macos.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/mainnet/net/guides/run-node-macos.rst b/source/mainnet/net/guides/run-node-macos.rst index 5188e50539..bf2c18ede8 100644 --- a/source/mainnet/net/guides/run-node-macos.rst +++ b/source/mainnet/net/guides/run-node-macos.rst @@ -67,7 +67,7 @@ Install/upgrade and run a node .. dropdown:: Mainnet .. Note:: - See :ref:`change-node-settings` for information about how to change the service configuration settings. See :ref:`configure-baker-macos` for information about how to set the location of baker credentials. + See :ref:`change-node-settings` for information about how to change the service configuration settings. See :ref:`baker-macos` for information about how to set the location of baker credentials. #. Go to :ref:`Downloads`, and download the latest macOS installer package (.pkg file). From f8d35594af8a22dea1f278925bf99004084bf21f Mon Sep 17 00:00:00 2001 From: dg-concordium Date: Mon, 18 Sep 2023 13:55:00 +0200 Subject: [PATCH 5/5] Fix lint error --- source/mainnet/net/guides/run-node-macos.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/mainnet/net/guides/run-node-macos.rst b/source/mainnet/net/guides/run-node-macos.rst index bf2c18ede8..17f441b73f 100644 --- a/source/mainnet/net/guides/run-node-macos.rst +++ b/source/mainnet/net/guides/run-node-macos.rst @@ -107,7 +107,7 @@ Install/upgrade and run a node .. dropdown:: Testnet .. Note:: - See :ref:`change-node-settings` for information about how to change the service configuration settings. See :ref:`configure-baker-macos` for information about how to set the location of baker credentials. + See :ref:`change-node-settings` for information about how to change the service configuration settings. See :ref:`baker-macos` for information about how to set the location of baker credentials. #. Go to :ref:`Downloads`, and download the latest macOS installer package (.pkg file).