Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

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

Merged
merged 47 commits into from
Oct 20, 2023
Merged

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

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
47 commits
Select commit Hold shift + click to select a range
7307f65
Update index.adoc
chris529 Sep 13, 2023
37152f6
create-update-docker.adoc
chris529 Sep 14, 2023
2c459e5
update-in-update-docker.adoc
chris529 Sep 14, 2023
3259fc0
update-in-update-docker.adoc
chris529 Sep 18, 2023
cedcda9
update-in-update-docker.adoc
chris529 Sep 18, 2023
5f339fa
Revert "Update index.adoc"
chris529 Sep 18, 2023
1923681
update in update-docker.adoc
chris529 Sep 19, 2023
cc32413
create-new-page-update-source.adoc
chris529 Sep 21, 2023
7cdac5a
update-in-both update-docker.adoc-and-docker.adoc
chris529 Sep 28, 2023
82333dd
update-in-source.adoc
chris529 Sep 28, 2023
e81abd0
update-in-source.adoc
chris529 Sep 28, 2023
25a3308
removed update-eisting-node
chris529 Sep 28, 2023
13739cc
update-in-docker.adoc
chris529 Oct 5, 2023
8c5cc8c
update-in-docker.adoc
chris529 Oct 5, 2023
e82704a
update-in-source.adoc
chris529 Oct 5, 2023
1f136ae
update-in-source.adoc
chris529 Oct 5, 2023
e782520
update-in-source.adoc
chris529 Oct 5, 2023
3d612a1
update-in-docker.adoc
chris529 Oct 5, 2023
eece577
update-in-source.adoc
chris529 Oct 5, 2023
c03b016
Merge branch '1570-add-update-service-node-page-for-docker' into 1571…
chris529 Oct 5, 2023
da0f0bd
update in source.adoc
chris529 Oct 13, 2023
4903212
update in source.adoc
chris529 Oct 13, 2023
7d897f6
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 13, 2023
aeeb162
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 13, 2023
2dd0e21
Update docs/antora/modules/ROOT/pages/management/source.adoc
chris529 Oct 13, 2023
516c763
Merge branch 'release/0.7.0' into 1570-add-update-service-node-page-f…
chris529 Oct 13, 2023
3ce876a
update in docker.adoc
chris529 Oct 13, 2023
5f2ae7c
update in source.adoc
chris529 Oct 17, 2023
e2d4dd8
update in source.adoc
chris529 Oct 17, 2023
e0b7368
Merge branch '1570-add-update-service-node-page-for-docker' into 1571…
sameersubudhi Oct 17, 2023
88ecfb2
update in docker.adoc
chris529 Oct 17, 2023
2126e73
update in source.adoc
chris529 Oct 17, 2023
773b3ab
update in docker.adoc
chris529 Oct 17, 2023
51222c9
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 18, 2023
aaefb4d
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 18, 2023
1cbda96
Update docs/antora/modules/ROOT/pages/management/source.adoc
chris529 Oct 18, 2023
469bc53
Update docs/antora/modules/ROOT/pages/management/source.adoc
chris529 Oct 18, 2023
68fea38
update in source.adoc
chris529 Oct 18, 2023
730a367
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 19, 2023
b596062
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 19, 2023
7cf1835
Update docs/antora/modules/ROOT/pages/management/docker.adoc
chris529 Oct 19, 2023
b1bb6be
update in doker.adoc
chris529 Oct 19, 2023
ee83af0
update in docker.adoc
chris529 Oct 19, 2023
f981e0a
update in docker.adoc
chris529 Oct 19, 2023
acc325e
Update docs/antora/modules/ROOT/pages/management/source.adoc
chris529 Oct 20, 2023
c61d27d
Update docs/antora/modules/ROOT/pages/management/source.adoc
chris529 Oct 20, 2023
68b7ab3
Merge pull request #1853 from LiskHQ/1571-add-update-service-node-pag…
sameersubudhi Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion docs/antora/modules/ROOT/pages/management/docker.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,23 @@ Mona Bärenfänger <[email protected]>
:url_config: configuration/docker.adoc
:url_FLUSHALL: https://redis.io/commands/FLUSHALL

NOTE: To upgrade Lisk Service to a desired version, please check out the specific version with *`git checkout <tag>`*, and then follow the existing process described below.
Tschakki marked this conversation as resolved.
Show resolved Hide resolved

== Build Docker image

.Inside the lisk-service root folder
----
make build
----
This creates the necessary Docker images to start Lisk Service in the containers.

== Start

.Inside the lisk-service root folder
----
cp ./docker/example.env .env
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i don't think this needs t be done every time Lisk Service is started, so it doesn't really fit here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I see your point Mona...I checked with @nagdahimanshu earlier, and he recommends that we should leave it here as it can be beneficial when Lisk Service is started for the first time.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We advice that the user performs this step (sets the .env file for all the necessary environment variable configuration) when starting the Lisk Service on with Docker Compose for the first time. Alternatively, they can export the necessary environment variables on the terminal before starting the containers which can be quite cumbersome.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As mentioned, this is not about starting for the first time. This step is already included at the right location, which is the setup guides: https://liskhq.github.io/lisk-docs/lisk-service/0.7/setup/docker.html#connecting-lisk-service-to-a-blockchain-node

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is about managing the Lisk Service docker setup. So, I think, it is relevant to maintain the necessary environment variables with the .env file. Alternatively, users can export the native environment variables which could be quite messy and inconvenient. If you prefer not having it here, you can remove the section but share a link on how to maintain the necessary environment variable information.

----
----
make up
----

Expand Down Expand Up @@ -198,10 +211,35 @@ This can be quite time-consuming when the chain is long, spanning over hours.

== Logging

To check the logs for the different microservices of Lisk Service, use the command `docker container logs CONTAINER`, where `CONTAINER` is the respective Docker container that holds the logs you wish to view.
The possibility exists here to either use the `docker` commands or the `make` commands to check the logs, and both options are listed here below.

For `docker`, to check the logs for the different microservices of Lisk Service, use the command `docker container logs CONTAINER`, where `CONTAINER` is the respective Docker container that holds the logs you wish to view.

For example, to see the logs for the Gateway microservice, execute the following command:

----
docker container logs lisk-service_gateway_1
----

To check the logs for different microservices using the `make` commands, the following commands listed below can be used:

----
make logs
----
The above command, displays the logs for all the microservices that have been logged so far, and that are currently existing.
----
make logs-live
----
The above command displays the logs for all the microservices currently logged so far, and also continues to display the latest logs.
----
make logs-blockchain-connector
----
The above command is similar to the `make logs` command, but only displays the appropriate logs for the specified microservice.
For example, in this case only for the `blockchain-connector`.
----
make logs-live-blockchain-connector
----
Finally, the above command is similar to the `make logs-live` command, but only displays the logs for the specified microservice.
chris529 marked this conversation as resolved.
Show resolved Hide resolved
For example, in this case also only for blockchain-connector here.
chris529 marked this conversation as resolved.
Show resolved Hide resolved

Replace the `blockchain-connector` with the specific service name required.
3 changes: 2 additions & 1 deletion docs/antora/modules/ROOT/pages/management/source.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Mona Bärenfänger <[email protected]> Muhammad Talha <muhammad.talha@lightcurv
// External URLs
:url_pm2_docs: https://pm2.keymetrics.io/docs/usage/quick-start/
:url_FLUSHALL: https://redis.io/commands/FLUSHALL
:url_pm2_management: https://pm2.keymetrics.io/docs/usage/log-management/

On this page, you'll find the most relevant PM2 commands for running a source-based Lisk Service installation.
For more details about PM2, see {url_pm2_docs}[PM2 docs].
Expand Down Expand Up @@ -98,7 +99,7 @@ To check the logs for the different microservices of Lisk Service, use the comma
Alternatively, it is also possible to check the logs for a specific PM2 process based on its process ID.
For example, `pm2 logs 0` can be used to check the Lisk Service Gateway logs.

TIP: The process ID of each PM2-managed process can be seen by executing the <<list>> command.
TIP: The process ID of each PM2-managed process can be seen by executing the <<list>> command. To learn more about PM2 log management please refer the {url_pm2_management}[PM2 logs documentation].
chris529 marked this conversation as resolved.
Show resolved Hide resolved

For example, to see the logs for the Gateway microservice, execute the following command:

Expand Down