Add update service node page for docker in Lisk Service v0.7.0 #1850
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
| == 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 | ||
|
There was a problem hiding this comment. i don't think this needs t be done every time Lisk Service is started, so it doesn't really fit here. There was a problem hiding this comment. 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. There was a problem hiding this comment. 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 There was a problem hiding this comment. We advice that the user performs this step (sets the There was a problem hiding this comment. 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 There was a problem hiding this comment. This section is about managing the Lisk Service docker setup. So, I think, it is relevant to maintain the necessary environment variables with the |
||
| ---- | ||
| ---- | ||
| make up | ||
| ---- | ||
|
|
||
|
|
@@ -204,10 +217,39 @@ If you wish to take a snapshot of your Docker installation, the details can be f | |
|
|
||
| == Logging | ||
|
|
||
| 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: | ||
|
|
||
| .Displays the logs for all the microservices that have been logged so far, and that are currently existing | ||
| ---- | ||
| make logs | ||
| ---- | ||
|
|
||
| .Displays the latest logs for all the microservices | ||
| ---- | ||
| make logs-live | ||
| ---- | ||
|
|
||
| .Displays the logs for the specified microservice. | ||
| ---- | ||
| make logs-blockchain-connector | ||
| ---- | ||
| In the above example, it will display logs only for the `blockchain-connector` microservice. | ||
|
|
||
| .Displays the latest logs for the specified microservice. | ||
| ---- | ||
| make logs-live-blockchain-connector | ||
| ---- | ||
| In the above example, it will display latest logs only for the `blockchain-connector` microservice. | ||
|
|
||
|
|
||
| Replace the `blockchain-connector` with the specific service name required. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,6 +10,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/ | ||
| :url_backups: management/snapshots.adoc | ||
|
|
||
| //TODO: add in link to new Backups page for importing the DB snapshot manually | ||
|
|
@@ -103,6 +104,7 @@ Alternatively, it is also possible to check the logs for a specific PM2 process | |
| 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. | ||
| To learn more about PM2 log management please refer the {url_pm2_management}[PM2 logs documentation]. | ||
|
|
||
| For example, to see the logs for the Gateway microservice, execute the following command: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
OK, there is now a section showing how to update Lisk Service 👍