From f3c8469b89ad5c0d8a99a762df019cd771acc26d Mon Sep 17 00:00:00 2001 From: Rjan Date: Mon, 23 May 2022 12:47:51 +0200 Subject: [PATCH 1/7] Initial audit of Operate/Upgrades Initial audit/revision of the Operate/Upgrades page --- .../en/storage-providers/operate/upgrades.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index d47749eb..007587da 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -1,7 +1,7 @@ --- title: "Upgrades" -description: "This guide covers how to safely upgrade Lotus when running a miner." -lead: "This guide covers how to safely upgrade Lotus when running a miner." +description: "This guide covers how to safely upgrade Lotus when running a storage provider." +lead: "This guide covers how to safely upgrade Lotus when running a storage provider." draft: false menu: storage-providers: @@ -51,7 +51,7 @@ Once you have the default configuration file, compare it with your configuration ## Upgrade in-place -1. Safely shutdown your Lotus Miner as explained [here]({{< relref "maintenance" >}}). +1. Safely shutdown your `lotus-miner` as explained [here]({{< relref "../../storage-providers/operate/maintenance/" >}}). 1. Shutdown any seal workers 1. Shutdown your Lotus Node (`lotus daemon stop` or `systemctl stop lotus-daemon`) 1. Pull the new version and rebuild. For more information read the [Lotus installation guide]({{< relref "../../lotus/install/prerequisites" >}}) again: @@ -67,7 +67,7 @@ make all make install ``` -1. Start the Lotus daemon and wait for sync: +1. Start the Lotus daemon and wait for it to finish syncing: ```shell lotus daemon @@ -79,7 +79,7 @@ systemctl start lotus-daemon lotus sync wait ``` -2. Start your miner and your workers +2. Start your `lotus-miner` and your `lotus-workers` ```shell lotus-miner run @@ -95,9 +95,9 @@ lotus-worker run This upgrade procedure should only be used as a last resort or when the chain has been upgraded and requires such action to be taken. {{< /alert >}} -It is similar to re-installing everything from scratch, so you can follow the usual [installation]({{< relref "../../lotus/install/prerequisites" >}}) and [miner-setup]({{< relref "initialize" >}}) guides after it. Before you do this, consider: +It is similar to re-installing everything from scratch, so you can follow the usual [installation]({{< relref "../../lotus/install/prerequisites/" >}}) and [miner-setup]({{< relref "../../storage-providers/setup/initialize/" >}}) guides after it. Before you do this, consider: -- [Backing up your Lotus wallets]({{< relref "manage-fil#exporting-and-importing-addresses" >}}) +- [Backing up your Lotus wallets]({{< relref "./../lotus/manage/manage-fil/#exporting-and-importing-addresses" >}}) - You may want to backup your Lotus Node and Miner configurations as well. Once you are ready, stop everything and delete the data folders (or rename them): @@ -109,5 +109,4 @@ rm -rf ~/.lotusminer rm -rf ~/.lotusworker ``` -After that Lotus applications will start from scratch. - +After that Lotus applications will start from scratch. \ No newline at end of file From ae58fbd5280ae0009a71ead68af1414b1fcf103f Mon Sep 17 00:00:00 2001 From: Rjan Date: Mon, 23 May 2022 12:51:15 +0200 Subject: [PATCH 2/7] Fix link path Fix link path --- content/en/storage-providers/operate/upgrades.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index 007587da..87048b0b 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -97,7 +97,7 @@ This upgrade procedure should only be used as a last resort or when the chain ha It is similar to re-installing everything from scratch, so you can follow the usual [installation]({{< relref "../../lotus/install/prerequisites/" >}}) and [miner-setup]({{< relref "../../storage-providers/setup/initialize/" >}}) guides after it. Before you do this, consider: -- [Backing up your Lotus wallets]({{< relref "./../lotus/manage/manage-fil/#exporting-and-importing-addresses" >}}) +- [Backing up your Lotus wallets]({{< relref "../../lotus/manage/manage-fil/#exporting-and-importing-addresses" >}}) - You may want to backup your Lotus Node and Miner configurations as well. Once you are ready, stop everything and delete the data folders (or rename them): From 128bc07a7cda89927701c7cdb66eb39b2b6186e2 Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 25 May 2022 10:10:29 +0200 Subject: [PATCH 3/7] Add diff comparison commands Add diff comparison commands --- .../en/storage-providers/operate/upgrades.md | 26 +++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index 87048b0b..4a7673c3 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -20,7 +20,7 @@ The are two types of upgrades: ## Cross-check your config file -All upgrade types require you to double-check that your configuration files are up-to-date. You can do this by exporting the default configuration files from Lotus and comparing them to your configuration files. +All upgrade types require you to double-check that your configuration files are up-to-date.You can do this by exporting the default configuration files from Lotus and comparing them to your configuration files. To export the default configuration files from Lotus, run: @@ -47,7 +47,29 @@ If you would prefer to have Lotus export the default configuration to a file, ru lotus-miner config default >> ~/default-lotus-miner-configuration.toml ``` -Once you have the default configuration file, compare it with your configuration file and make sure that you're not missing any sections. See the [Lotus release notes](https://github.com/filecoin-project/lotus/releases) for details on what new sections have been added. +Once you have the updated default configuration file, compare it with your configuration file and make sure that you're not missing any sections. You can use the `diff` command to produce a list of changes that would need to be made to the first file, to make it match the second file. + +If you keep the same formatting as the default configuration file it should be fairly easy to spot difference and new sections using this command: + +```shell +diff -y -W 200 your-config.toml default-lotus-miner-configuration.toml +``` + +A `vertical bar` sign indcates that there is a difference in that line. + +```toml + #ListenAddress = "/ip4/127.0.0.1/tcp/4567/http" | #ListenAddress = "/ip4/127.0.0.1/tcp/2345/http" +``` + +While the `greater-than-sign` indicates that the first configuration file is missing some lines. + +```toml + > # env var: LOTUS_STORAGE_ALLOWPROVEREPLICAUPDATE2 + > #AllowProveReplicaUpdate2 = true + > +``` + +You can also check the [Lotus release notes](https://github.com/filecoin-project/lotus/releases) for details on what new sections have been added. ## Upgrade in-place From ed2e795aa4fe262162b05ca25b1210dec5b0204a Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 25 May 2022 10:20:18 +0200 Subject: [PATCH 4/7] Small typos Small typos --- content/en/storage-providers/operate/upgrades.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index 4a7673c3..1fead084 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -20,7 +20,7 @@ The are two types of upgrades: ## Cross-check your config file -All upgrade types require you to double-check that your configuration files are up-to-date.You can do this by exporting the default configuration files from Lotus and comparing them to your configuration files. +All upgrade types require you to double-check that your configuration files are up-to-date. You can do this by exporting the default configuration files from Lotus and comparing them to your configuration files. To export the default configuration files from Lotus, run: @@ -47,7 +47,7 @@ If you would prefer to have Lotus export the default configuration to a file, ru lotus-miner config default >> ~/default-lotus-miner-configuration.toml ``` -Once you have the updated default configuration file, compare it with your configuration file and make sure that you're not missing any sections. You can use the `diff` command to produce a list of changes that would need to be made to the first file, to make it match the second file. +Once you have an updated default configuration file from the new version, compare it with your configuration file and make sure that you're not missing any sections. You can use the `diff` command to produce a list of changes that would need to be made to the first file, to make it match the second file. If you keep the same formatting as the default configuration file it should be fairly easy to spot difference and new sections using this command: @@ -55,18 +55,18 @@ If you keep the same formatting as the default configuration file it should be f diff -y -W 200 your-config.toml default-lotus-miner-configuration.toml ``` -A `vertical bar` sign indcates that there is a difference in that line. +A `vertical bar` sign indcates that there is a difference in that line between your configuraion file, and the default configuration file.. ```toml - #ListenAddress = "/ip4/127.0.0.1/tcp/4567/http" | #ListenAddress = "/ip4/127.0.0.1/tcp/2345/http" +#ListenAddress = "/ip4/127.0.0.1/tcp/4567/http" | #ListenAddress = "/ip4/127.0.0.1/tcp/2345/http" ``` -While the `greater-than-sign` indicates that the first configuration file is missing some lines. +While the `greater-than-sign` indicates that the your configuration file is missing some lines that are included in the updated default configuration file. ```toml - > # env var: LOTUS_STORAGE_ALLOWPROVEREPLICAUPDATE2 - > #AllowProveReplicaUpdate2 = true - > + > # env var: LOTUS_STORAGE_ALLOWPROVEREPLICAUPDATE2 + > #AllowProveReplicaUpdate2 = true + > ``` You can also check the [Lotus release notes](https://github.com/filecoin-project/lotus/releases) for details on what new sections have been added. From 9fdbb9eed5be3e5511e25b774da8fd2f30128481 Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 25 May 2022 10:24:19 +0200 Subject: [PATCH 5/7] Sentence fix Sentence fix --- content/en/storage-providers/operate/upgrades.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index 1fead084..863f893d 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -47,7 +47,7 @@ If you would prefer to have Lotus export the default configuration to a file, ru lotus-miner config default >> ~/default-lotus-miner-configuration.toml ``` -Once you have an updated default configuration file from the new version, compare it with your configuration file and make sure that you're not missing any sections. You can use the `diff` command to produce a list of changes that would need to be made to the first file, to make it match the second file. +Once you have an updated default configuration file from the new version, compare it with your configuration file and make sure that you're not missing any sections. You can use the `diff` command to produce a list of changes that would need to be made to the your configuration file, to make it match the updated default configuration file. If you keep the same formatting as the default configuration file it should be fairly easy to spot difference and new sections using this command: From 50a5623db37bcf90b07e1e1a93b40c5194e2a716 Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 25 May 2022 18:02:18 +0200 Subject: [PATCH 6/7] Remove a punctuation Remove a punctuation --- content/en/storage-providers/operate/upgrades.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index 863f893d..19716965 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -55,7 +55,7 @@ If you keep the same formatting as the default configuration file it should be f diff -y -W 200 your-config.toml default-lotus-miner-configuration.toml ``` -A `vertical bar` sign indcates that there is a difference in that line between your configuraion file, and the default configuration file.. +A `vertical bar` sign indcates that there is a difference in that line between your configuraion file, and the default configuration file. ```toml #ListenAddress = "/ip4/127.0.0.1/tcp/4567/http" | #ListenAddress = "/ip4/127.0.0.1/tcp/2345/http" From 5b162e0b9cedc105dcfe0381d64b70b16151ff01 Mon Sep 17 00:00:00 2001 From: Rjan Date: Wed, 25 May 2022 18:07:16 +0200 Subject: [PATCH 7/7] Fix typo Fix typo --- content/en/storage-providers/operate/upgrades.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/storage-providers/operate/upgrades.md b/content/en/storage-providers/operate/upgrades.md index 19716965..6abe0306 100644 --- a/content/en/storage-providers/operate/upgrades.md +++ b/content/en/storage-providers/operate/upgrades.md @@ -55,13 +55,13 @@ If you keep the same formatting as the default configuration file it should be f diff -y -W 200 your-config.toml default-lotus-miner-configuration.toml ``` -A `vertical bar` sign indcates that there is a difference in that line between your configuraion file, and the default configuration file. +A `vertical bar` sign indcates that there is a difference in that line between your configuration file, and the default configuration file. ```toml #ListenAddress = "/ip4/127.0.0.1/tcp/4567/http" | #ListenAddress = "/ip4/127.0.0.1/tcp/2345/http" ``` -While the `greater-than-sign` indicates that the your configuration file is missing some lines that are included in the updated default configuration file. +The `greater-than-sign` indicates that your configuration file is missing some lines that are included in the updated default configuration file. ```toml > # env var: LOTUS_STORAGE_ALLOWPROVEREPLICAUPDATE2