You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 11, 2024. It is now read-only.
This creates the necessary Docker images to start Lisk Service in the containers.
14
24
15
25
== Start
16
26
17
27
.Inside the lisk-service root folder
18
28
----
29
+
cp ./docker/example.env .env
30
+
----
31
+
----
19
32
make up
20
33
----
21
34
@@ -204,10 +217,147 @@ If you wish to take a snapshot of your Docker installation, the details can be f
204
217
205
218
== Logging
206
219
207
-
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.
220
+
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.
221
+
222
+
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.
208
223
209
224
For example, to see the logs for the Gateway microservice, execute the following command:
210
225
211
226
----
212
227
docker container logs lisk-service_gateway_1
213
228
----
229
+
230
+
To check the logs for different microservices using the `make` commands, the following commands listed below can be used:
231
+
232
+
.Displays the logs for all the microservices that have been logged so far, and that are currently existing
233
+
----
234
+
make logs
235
+
----
236
+
237
+
.Displays the latest logs for all the microservices
238
+
----
239
+
make logs-live
240
+
----
241
+
242
+
.Displays the logs for the specified microservice.
243
+
----
244
+
make logs-blockchain-connector
245
+
----
246
+
In the above example, it will display logs only for the `blockchain-connector` microservice.
247
+
248
+
.Displays the latest logs for the specified microservice.
249
+
----
250
+
make logs-live-blockchain-connector
251
+
----
252
+
In the above example, it will display the latest logs only for the `blockchain-connector` microservice.
253
+
254
+
255
+
Replace the `blockchain-connector` with the specific service name required.
256
+
257
+
258
+
== Upgrade Lisk Service
259
+
260
+
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 {url_tags}[available tags] on GitHub.
261
+
262
+
[tabs]
263
+
====
264
+
Option A - Download pre-built images from DockerHub::
265
+
+
266
+
--
267
+
. Stop Lisk Service
268
+
+
269
+
----
270
+
make stop
271
+
----
272
+
NOTE: In case the database needs to be flushed please execute the `make down` command instead. Please check the {url_rel_notes}[release notes] for the relevant version to see if the existing databases need to be flushed.
273
+
274
+
. Checkout the version with *`git checkout <tag>`*
275
+
+
276
+
----
277
+
git checkout v0.7.0
278
+
----
279
+
280
+
. Update `docker-compose.yml` to download the specific image versions from the DockerHub as shown below.
281
+
Update specified images with the desired version, for example `0.7.0`.
282
+
+
283
+
.docker-compose.yml
284
+
[source,yaml]
285
+
----
286
+
blockchain-app-registry:
287
+
image: lisk/service_blockchain_app_registry:0.7.0
288
+
...
289
+
290
+
blockchain-connector:
291
+
image: lisk/service_blockchain_connector:0.7.0
292
+
...
293
+
294
+
blockchain-indexer:
295
+
image: lisk/service_blockchain_indexer:0.7.0
296
+
...
297
+
298
+
blockchain-coordinator:
299
+
image: lisk/service_blockchain_coordinator:0.7.0
300
+
...
301
+
302
+
transaction-statistics:
303
+
image: lisk/service_transaction_statistics:0.7.0
304
+
...
305
+
306
+
fee-estimator:
307
+
image: lisk/service_fee_estimator:0.7.0
308
+
...
309
+
310
+
gateway:
311
+
image: lisk/service_gateway:0.7.0
312
+
...
313
+
314
+
market:
315
+
image: lisk/service_market:0.7.0
316
+
...
317
+
318
+
export:
319
+
image: lisk/service_export:0.7.0
320
+
321
+
----
322
+
323
+
. Start Lisk Service in the containers.
324
+
+
325
+
----
326
+
make up
327
+
----
328
+
--
329
+
Option B - Build images locally ::
330
+
+
331
+
--
332
+
Build the images locally using the following steps.
333
+
Navigate inside the lisk-service root folder, and execute the following commands.
334
+
335
+
. Stop Lisk Service
336
+
+
337
+
----
338
+
make stop
339
+
----
340
+
NOTE: In case the database needs to be flushed please execute the `make down` command instead. Please check the {url_rel_notes}[release notes] for the relevant version to see if the existing databases need to be flushed.
341
+
342
+
. Checkout the version with *`git checkout <tag>`*
343
+
+
344
+
----
345
+
git checkout v0.7.0
346
+
----
347
+
348
+
. Build the required updated Docker images
349
+
+
350
+
----
351
+
make build
352
+
----
353
+
354
+
. Start Lisk Service in the containers
355
+
+
356
+
----
357
+
make up
358
+
----
359
+
--
360
+
361
+
====
362
+
363
+
To verify the microservice logs, please refer to the <<Logging>> section.
//TODO: add in link to new Backups page for importing the DB snapshot manually
16
20
@@ -19,6 +23,9 @@ For more details about PM2, see {url_pm2_docs}[PM2 docs].
19
23
20
24
Moreover, we'll also talk about the steps to reset a Lisk Service node.
21
25
26
+
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].
27
+
28
+
22
29
== Various PM2 commands
23
30
24
31
=== Start
@@ -103,6 +110,7 @@ Alternatively, it is also possible to check the logs for a specific PM2 process
103
110
For example, `pm2 logs 0` can be used to check the Lisk Service Gateway logs.
104
111
105
112
TIP: The process ID of each PM2-managed process can be seen by executing the <<list>> command.
113
+
To learn more about PM2 log management please refer the {url_pm2_management}[PM2 logs documentation].
106
114
107
115
For example, to see the logs for the Gateway microservice, execute the following command:
You can start Lisk Service again with the <<start>> command.
378
+
379
+
380
+
== Upgrade Lisk Service
381
+
382
+
To upgrade Lisk Service to a desired version, please follow the steps listed below. To find all the tagged versions for Lisk Service, please check the {url_tags}[available tags] on GitHub.
383
+
384
+
. Stop the existing running version of Lisk Service.
0 commit comments