Add update service node page for docker in Lisk Service v0.7.0 #1850

chris529 · 2023-09-14T09:05:17Z

Closes # https://github.com/LiskHQ/lisk-docs/issues/1570

codecov · 2023-09-14T09:08:55Z

Codecov Report

Merging #1850 (68b7ab3) into release/0.7.0 (ccb2964) will decrease coverage by 0.09%.
Report is 96 commits behind head on release/0.7.0.
The diff coverage is n/a.

@@                Coverage Diff                @@
##           release/0.7.0    #1850      +/-   ##
=================================================
- Coverage          66.90%   66.82%   -0.09%     
=================================================
  Files                300      298       -2     
  Lines               5140     5112      -28     
  Branches             927      922       -5     
=================================================
- Hits                3439     3416      -23     
+ Misses              1701     1696       -5

see 6 files with indirect coverage changes

This reverts commit 7307f65.

docs/antora/modules/ROOT/pages/update-existing-node/update-docker.adoc

Tschakki · 2023-10-16T09:52:56Z

docs/antora/modules/ROOT/pages/management/docker.adoc

 == Start

 .Inside the lisk-service root folder
 ----
+cp ./docker/example.env .env


but this is not about starting it for the first time, it is about how to start it in general. I don't think you need to do it every time you start Lisk Service. So it shouldn't be mentioned here

Tschakki · 2023-10-16T09:56:27Z

docs/antora/modules/ROOT/pages/management/docker.adoc

@@ -12,10 +12,23 @@ Mona Bärenfänger <[email protected]>
 :url_snapshot_config: configuration/index.adoc
 :url_backups: management/snapshots.adoc

+NOTE: To upgrade Lisk Service to a desired version, please check out the specific version with *`git checkout <tag>`*, and then create the Docker image, followed by starting Lisk Service as shown in the commands below.


How to update Lisk Service should not be a note, it should at least be a separate section, and every step necessary to update Lisk Service should be explained it that very section, and supported, if possible, by code snippets the user can simply copy.

OK, there is now a section showing how to update Lisk Service 👍

…-add-update-service-node-page-for-source

sameersubudhi

Looks good overall. However, please consider the following recommendations as well.

docs/antora/modules/ROOT/pages/management/docker.adoc

Co-authored-by: Sameer <[email protected]>

Tschakki

Imho it would be beneficial to have separate pages for the update guides, as initially intended, as the process includes several steps and also there are multiple options how to update.

Also, should we include steps to backup the existing data before the update, or is that not necessary?

Tschakki · 2023-10-19T09:20:55Z

docs/antora/modules/ROOT/pages/management/docker.adoc

+
+To upgrade the Docker container to a desired version, please follow one of the two options below. To find all the tagged versions for Lisk Service, please check the available tags (https://github.com/LiskHQ/lisk-service/tags) on GitHub.
+
+==== Option A - Download pre-built images from DockerHub


Option A should be the recommended way to upgrade Lisk Service, imho Option A and B should be switched, because B looks easier

Also, imho it would be nice to use tabs to switch between Option A & B

OK, I have now added tabs.

Also, imho it would be nice to use tabs to switch between Option A & B

I'd prefer that Download pre-built images from DockerHub remain the first option. Building images locally can be problematic at times if the dependencies are stale and we did not publish an update for any reason.

docs/antora/modules/ROOT/pages/management/docker.adoc

Tschakki · 2023-10-19T09:25:34Z

docs/antora/modules/ROOT/pages/management/docker.adoc

+
+==== Option B - Build images locally
+
+Build the images locally using the following steps.


At what point does it describe how to download and install the new version?

Seems like the step to run git checkout <tag> in between the Stop Lisk Service and Build the required updated Docker images steps are missing. Have left a suggestion here.

Done as suggested 👍

Co-authored-by: Mona Bärenfänger <[email protected]>

docs/antora/modules/ROOT/pages/management/docker.adoc

Co-authored-by: Sameer <[email protected]>

…e-for-source Add update service node page for source in Lisk Service v0.7.0

Tschakki

Thank you! 🎉

chris529 added 2 commits September 13, 2023 17:09

Update index.adoc

7307f65

create-update-docker.adoc

37152f6

chris529 self-assigned this Sep 14, 2023

chris529 added type: docs type: improvement labels Sep 14, 2023

chris529 added 3 commits September 14, 2023 11:22

update-in-update-docker.adoc

2c459e5

update-in-update-docker.adoc

3259fc0

update-in-update-docker.adoc

cedcda9

chris529 changed the base branch from release/0.7.0 to 1751-add-steps-to-import-DB-snapshots September 18, 2023 13:06

chris529 changed the base branch from 1751-add-steps-to-import-DB-snapshots to release/0.7.0 September 18, 2023 13:07

Revert "Update index.adoc"

5f339fa

This reverts commit 7307f65.

chris529 requested a review from sameersubudhi September 19, 2023 07:36

chris529 added 2 commits September 19, 2023 18:05

update in update-docker.adoc

1923681

create-new-page-update-source.adoc

cc32413

sameersubudhi reviewed Sep 27, 2023

View reviewed changes

docs/antora/modules/ROOT/pages/update-existing-node/update-docker.adoc Outdated Show resolved Hide resolved

chris529 added 4 commits September 28, 2023 09:23

update-in-both update-docker.adoc-and-docker.adoc

7cdac5a

update-in-source.adoc

82333dd

update-in-source.adoc

e81abd0

removed update-eisting-node

25a3308

chris529 requested review from sameersubudhi and TalhaMaliktz September 28, 2023 09:24

sameersubudhi approved these changes Sep 28, 2023 •

edited

Loading

View reviewed changes

chris529 force-pushed the 1570-add-update-service-node-page-for-docker branch from 9daf6e2 to 25a3308 Compare October 5, 2023 12:26

chris529 added 6 commits October 5, 2023 14:31

update-in-docker.adoc

13739cc

update-in-docker.adoc

8c5cc8c

update-in-source.adoc

e82704a

update-in-source.adoc

1f136ae

update-in-source.adoc

e782520

update-in-docker.adoc

3d612a1

Tschakki suggested changes Oct 16, 2023

View reviewed changes

chris529 requested a review from sameersubudhi October 16, 2023 15:21

chris529 and others added 4 commits October 17, 2023 10:25

update in source.adoc

5f2ae7c

update in source.adoc

e2d4dd8

Merge branch '1570-add-update-service-node-page-for-docker' into 1571…

e0b7368

…-add-update-service-node-page-for-source

update in docker.adoc

88ecfb2

chris529 requested a review from Tschakki October 17, 2023 14:44

chris529 added 2 commits October 17, 2023 17:04

update in source.adoc

2126e73

update in docker.adoc

773b3ab

sameersubudhi approved these changes Oct 17, 2023

View reviewed changes

docs/antora/modules/ROOT/pages/management/docker.adoc Outdated Show resolved Hide resolved

docs/antora/modules/ROOT/pages/management/docker.adoc Outdated Show resolved Hide resolved

chris529 and others added 5 commits October 18, 2023 11:33

Update docs/antora/modules/ROOT/pages/management/docker.adoc

51222c9

Co-authored-by: Sameer <[email protected]>

Update docs/antora/modules/ROOT/pages/management/docker.adoc

aaefb4d

Co-authored-by: Sameer <[email protected]>

Update docs/antora/modules/ROOT/pages/management/source.adoc

1cbda96

Co-authored-by: Sameer <[email protected]>

Update docs/antora/modules/ROOT/pages/management/source.adoc

469bc53

Co-authored-by: Sameer <[email protected]>

update in source.adoc

68fea38

Tschakki suggested changes Oct 19, 2023

View reviewed changes

chris529 and others added 2 commits October 19, 2023 11:31

Update docs/antora/modules/ROOT/pages/management/docker.adoc

730a367

Co-authored-by: Mona Bärenfänger <[email protected]>

Update docs/antora/modules/ROOT/pages/management/docker.adoc

b596062

Co-authored-by: Mona Bärenfänger <[email protected]>

sameersubudhi reviewed Oct 19, 2023

View reviewed changes

docs/antora/modules/ROOT/pages/management/docker.adoc Outdated Show resolved Hide resolved

chris529 and others added 4 commits October 19, 2023 11:56

Update docs/antora/modules/ROOT/pages/management/docker.adoc

7cf1835

Co-authored-by: Sameer <[email protected]>

update in doker.adoc

b1bb6be

update in docker.adoc

ee83af0

update in docker.adoc

f981e0a

chris529 requested a review from Tschakki October 19, 2023 11:47

chris529 and others added 3 commits October 20, 2023 11:57

Update docs/antora/modules/ROOT/pages/management/source.adoc

acc325e

Co-authored-by: Sameer <[email protected]>

Update docs/antora/modules/ROOT/pages/management/source.adoc

c61d27d

Co-authored-by: Sameer <[email protected]>

Merge pull request #1853 from LiskHQ/1571-add-update-service-node-pag…

68b7ab3

…e-for-source Add update service node page for source in Lisk Service v0.7.0

Tschakki approved these changes Oct 20, 2023

View reviewed changes

sameersubudhi merged commit 2ca2af5 into release/0.7.0 Oct 20, 2023
7 of 8 checks passed

sameersubudhi deleted the 1570-add-update-service-node-page-for-docker branch October 20, 2023 13:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add update service node page for docker in Lisk Service v0.7.0 #1850

Add update service node page for docker in Lisk Service v0.7.0 #1850

chris529 commented Sep 14, 2023 •

edited

Loading

codecov bot commented Sep 14, 2023 •

edited

Loading

Tschakki Oct 16, 2023

Tschakki Oct 16, 2023

chris529 Oct 17, 2023

sameersubudhi left a comment

Tschakki left a comment

Tschakki Oct 19, 2023

Tschakki Oct 19, 2023

chris529 Oct 19, 2023

sameersubudhi Oct 19, 2023

chris529 Oct 19, 2023

Tschakki Oct 19, 2023

sameersubudhi Oct 19, 2023 •

edited

Loading

chris529 Oct 19, 2023

Tschakki left a comment


		To upgrade the Docker container to a desired version, please follow one of the two options below. To find all the tagged versions for Lisk Service, please check the available tags (https://github.com/LiskHQ/lisk-service/tags) on GitHub.

		==== Option A - Download pre-built images from DockerHub


		==== Option B - Build images locally

		Build the images locally using the following steps.

Add update service node page for docker in Lisk Service v0.7.0 #1850

Add update service node page for docker in Lisk Service v0.7.0 #1850

Conversation

chris529 commented Sep 14, 2023 • edited Loading

codecov bot commented Sep 14, 2023 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sameersubudhi left a comment

Choose a reason for hiding this comment

Tschakki left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sameersubudhi Oct 19, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Tschakki left a comment

Choose a reason for hiding this comment

chris529 commented Sep 14, 2023 •

edited

Loading

codecov bot commented Sep 14, 2023 •

edited

Loading

sameersubudhi Oct 19, 2023 •

edited

Loading