From 83076c6f69a8c4d6a2805b32cf165c61b14cc0b0 Mon Sep 17 00:00:00 2001 From: JuArce <52429267+JuArce@users.noreply.github.com> Date: Fri, 18 Oct 2024 17:36:57 -0300 Subject: [PATCH 1/3] docs: update to v0.10.0 --- Makefile | 2 +- config-files/config-operator.yaml | 2 +- docs/3_guides/1_SDK_how_to.md | 2 +- docs/SUMMARY.md | 1 + docs/operator_guides/0_running_an_operator.md | 4 +- .../upgrading_guides/v0_10_0.md | 57 +++++++++++++++++++ 6 files changed, 63 insertions(+), 5 deletions(-) create mode 100644 docs/operator_guides/upgrading_guides/v0_10_0.md diff --git a/Makefile b/Makefile index 37d43b3ae6..0ab4a1d79d 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ OS := $(shell uname -s) CONFIG_FILE?=config-files/config.yaml AGG_CONFIG_FILE?=config-files/config-aggregator.yaml -OPERATOR_VERSION=v0.9.2 +OPERATOR_VERSION=v0.10.0 ifeq ($(OS),Linux) BUILD_ALL_FFI = $(MAKE) build_all_ffi_linux diff --git a/config-files/config-operator.yaml b/config-files/config-operator.yaml index eedcecb80e..f700326acf 100644 --- a/config-files/config-operator.yaml +++ b/config-files/config-operator.yaml @@ -22,7 +22,7 @@ bls: ## Operator Configurations operator: aggregator_rpc_server_ip_port_address: aggregator.alignedlayer.com:8090 - operator_tracker_ip_port_address: https://holesky.tracker.alignedlayer.com + operator_tracker_ip_port_address: https://holesky.telemetry.alignedlayer.com address: '' earnings_receiver_address: '' #Can be the same as the operator. delegation_approver_address: '0x0000000000000000000000000000000000000000' diff --git a/docs/3_guides/1_SDK_how_to.md b/docs/3_guides/1_SDK_how_to.md index 9163457a0a..db2bbd0392 100644 --- a/docs/3_guides/1_SDK_how_to.md +++ b/docs/3_guides/1_SDK_how_to.md @@ -12,7 +12,7 @@ To use this SDK in your Rust project, add the following to your `Cargo.toml`: ```toml [dependencies] -aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag="v0.9.2" } +aligned-sdk = { git = "https://github.com/yetanotherco/aligned_layer", tag="v0.10.0" } ``` To find the latest release tag go to [releases](https://github.com/yetanotherco/aligned_layer/releases) and copy the diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 82e58280b7..545b4f1437 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -40,6 +40,7 @@ * [Operator FAQ](operator_guides/1_operator_FAQ.md) * [Troubleshooting](operator_guides/2_troubleshooting.md) * Upgrading Guides + * [Upgrading to v0.10.0](operator_guides/upgrading_guides/v0_10_0.md) * [Upgrading to v0.9.2](operator_guides/upgrading_guides/v0_9_2.md) ## Useful links diff --git a/docs/operator_guides/0_running_an_operator.md b/docs/operator_guides/0_running_an_operator.md index 07aebd5bfe..7519fe820c 100644 --- a/docs/operator_guides/0_running_an_operator.md +++ b/docs/operator_guides/0_running_an_operator.md @@ -1,7 +1,7 @@ # Register as an Aligned operator in testnet > **CURRENT VERSION:** -> Aligned Operator [v0.9.2](https://github.com/yetanotherco/aligned_layer/releases/tag/v0.9.2) +> Aligned Operator [v0.10.0](https://github.com/yetanotherco/aligned_layer/releases/tag/v0.10.0) > **IMPORTANT:** > You must be [whitelisted](https://docs.google.com/forms/d/e/1FAIpQLSdH9sgfTz4v33lAvwj6BvYJGAeIshQia3FXz36PFfF-WQAWEQ/viewform) to become an Aligned operator. @@ -26,7 +26,7 @@ Minimum hardware requirements: To start with, clone the Aligned repository and move inside it ```bash -git clone https://github.com/yetanotherco/aligned_layer.git --branch v0.9.2 +git clone https://github.com/yetanotherco/aligned_layer.git --branch v0.10.0 cd aligned_layer ``` diff --git a/docs/operator_guides/upgrading_guides/v0_10_0.md b/docs/operator_guides/upgrading_guides/v0_10_0.md new file mode 100644 index 0000000000..503cbf6746 --- /dev/null +++ b/docs/operator_guides/upgrading_guides/v0_10_0.md @@ -0,0 +1,57 @@ +# Upgrading to v0.10.0 + +This guide will walk you through the process of upgrading your Aligned Operator to v0.10.0. + +## Changes + +### New Features + +* feat(telemetry): Add url data to operator updates on telemetry service in [#1136](https://github.com/yetanotherco/aligned_layer/pull/1136) +* fix: add panic catch on operator calling FFI in [#1196](https://github.com/yetanotherco/aligned_layer/pull/1196) + + +## How to upgrade + +### Step 1 - Update the configuration for your specific Operator + +This version requires update the operator configuration file changing the following field: + +```yaml +## Operator Configurations +operator: + operator_tracker_ip_port_address: https://holesky.telemetry.alignedlayer.com +``` + +{% hint style="info" %} + +Previous URL of operator_tracker_ip_port_address. Now it sends data to a telemetry server with better tracking and error handling + +{% endhint %} + +### Step 2 - Update the Operator + +Inside the Aligned repository, run: + +```bash +make update_operator +``` + +This will recreate the binaries. You can then proceed to restart the operator. + +### Step 3 - Check the Operator Version + +To see the operator version, run: + +```bash +./operator/build/aligned-operator --version +``` + +This will display the current version of the operator binary. + +``` +Aligned Layer Node Operator version v0.10.0 +``` + +### Step 4 - Restart the Operator + +Restart the operator based on your system config From ca9ffdabd93a47d49d5593e196963d1103e582fc Mon Sep 17 00:00:00 2001 From: "Mariano A. Nicolini" Date: Fri, 18 Oct 2024 17:43:23 -0300 Subject: [PATCH 2/3] Update docs/operator_guides/upgrading_guides/v0_10_0.md --- docs/operator_guides/upgrading_guides/v0_10_0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operator_guides/upgrading_guides/v0_10_0.md b/docs/operator_guides/upgrading_guides/v0_10_0.md index 503cbf6746..b282e57b23 100644 --- a/docs/operator_guides/upgrading_guides/v0_10_0.md +++ b/docs/operator_guides/upgrading_guides/v0_10_0.md @@ -1,6 +1,6 @@ # Upgrading to v0.10.0 -This guide will walk you through the process of upgrading your Aligned Operator to v0.10.0. +This guide will walk you through the process of upgrading your Aligned Operator to v0.10.0. ## Changes From ba8506c50a17082d81848dad8e1c152a2760e8f8 Mon Sep 17 00:00:00 2001 From: "Mariano A. Nicolini" Date: Fri, 18 Oct 2024 17:44:38 -0300 Subject: [PATCH 3/3] Update docs/operator_guides/upgrading_guides/v0_10_0.md --- docs/operator_guides/upgrading_guides/v0_10_0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/operator_guides/upgrading_guides/v0_10_0.md b/docs/operator_guides/upgrading_guides/v0_10_0.md index b282e57b23..a7a25ba616 100644 --- a/docs/operator_guides/upgrading_guides/v0_10_0.md +++ b/docs/operator_guides/upgrading_guides/v0_10_0.md @@ -36,7 +36,7 @@ Inside the Aligned repository, run: make update_operator ``` -This will recreate the binaries. You can then proceed to restart the operator. +This will recompile the binaries. You can then proceed to restart the operator. ### Step 3 - Check the Operator Version