docs: update to v0.10.0 (#1301)

Co-authored-by: Mariano A. Nicolini <[email protected]>
yetanotherco · Oct 18, 2024 · 403b363 · 403b363
1 parent 468fed9
commit 403b363
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 5 deletions.
diff --git 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
@@ -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: '<operator_address>'
   earnings_receiver_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
@@ -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
@@ -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
@@ -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
@@ -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 recompile 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