Changes for page Runtime Overview Exit codes

Summary

• Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.TudorNeacsu
	1	+XWiki.ebakker

Content

...	...	@@ -1,31 +1,47 @@
1	1	{{container}}{{container layoutStyle="columns"}}(((
2		-In this microlearning, we will give insights into what is an exit code, the main exit codes returned by a container when it stops and how can that help a Support Engineer to conduct an RCA.
	2	+In this document, we will use the information from the actual root cause analysis to make a generic view that can be used if you run into the same or a similar problem in the future. The focus will be on providing insights into what is an exit code, the main exit codes returned by a container when it stops and how can that help you to resolve your problem.
3	3
4	4	Should you have any questions, please get in touch with [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5	5
6	6	== 1. Key concepts ==
7	7
8		- In a previous [[microlearning>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Crash%20Course/Crash%20Course%20Platform/Runtime%20Overview||target="blank"]] we explained that a container can have multiple statuses. Among these, there is the status Exit. This status comes together with a code. The exit code usually points out the reason why the container stopped. In the section below we go into more details for the most common exit codes that you could see in eMagiz.
	8	+In a previous [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course Platform.Runtime Overview||target="blank"]] we explained that a container can have multiple statuses. Among these, there is the status Exit which is returned by the container uppon stopping and comes together with a code. The exit code usually points out the reason why the container stopped. In the section below we describe the most common exit codes that you can encounter in eMagiz.
9	9
10	10	[[image:Main.Images.RCA-Knowledgebase.WebHome@rca-knowledgebase-runtime-overview-exit-codes.png]]
11	11
12	12	== 2. Exit code values ==
13	13
14		-* Exited with code **0**: The application inside the container completed its work successfully without any errors.
	14	+* Exited with code **0**
	15	+** The application inside the container completed its work successfully without any errors.
15	15
16		-* Exited with code **1**: There was a general error in the application, which could be due to a variety of reasons like incorrect arguments or a failed dependency.
	17	+* Exited with code **1**
	18	+** There was a general error in the application, which could be due to a variety of reasons like incorrect arguments or a failed dependency.
	19	+** For example when you are missing a property value.
17	17
18		-* Exited with code **125**: The docker run command was not executed successfully
	21	+* Exited with code **125**
	22	+** The docker run command was not executed successfully.
	23	+** This usually occurs when eMagiz fails to execute a certain command on that container, e.g. Start, Stop.
19	19
20		-* Exited with code **126**: The command inside the container was found but cannot be executed. This can be due to permission issues or if the command is not executable.
	25	+* Exited with code **126**
	26	+** The command inside the container was found but cannot be executed. This can be due to permission issues or if the command is not executable.
	27	+** For example, when eMagiz is running on premises and the permissions are incorrectly configured.
21	21
22		-* Exited with code **127**: The command was not found. This usually happens if a script is missing or the path is not set correctly.
	29	+* Exited with code **127**
	30	+** The command was not found. This usually happens if a script is missing or the path is not set correctly.
23	23
24		-* Exited with code **137**: The container was forcefully stopped. This happens when the container exceeds its memory resource limit (OOM)
	32	+* Exited with code **137**
	33	+** The container was forcefully stopped
	34	+** This happens when the container exceeds its memory resource limit (OOM).
25	25
26		-* Exited with code **139**: The application inside the container crashed due to a segmentation fault, which is usually caused by accessing memory that the process does not have permission to access.
	36	+* Exited with code **139**
	37	+** The application inside the container crashed due to a segmentation fault, which is usually caused by accessing memory that the process does not have permission to access.
27	27
28		-* Exited with code **255**: Container exited, returning an exit code outside the acceptable range, meaning the cause of the error is not known
	39	+* Exited with code **143**
	40	+** The container stopped gracefully terminated after receiving the operating system's SIGTERM signal, which instructs the container to do so.
	41	+** For example, when you command the container to stop via Deploy Architecture or when eMagiz stops the container, e.g. Stop Machine deployment step.
	42	+
	43	+* Exited with code **255**
	44	+** Container exited, returning an exit code outside the acceptable range, meaning the cause of the error is not known.
29	29
30	30
31	31	== 5. Suggested Additional Readings ==