Checking Installation Requirements or Failures

Updated on 2024-09-05 GMT+08:00

View PDF

Function

This command is used to check whether a node meets the IEF software installation requirements. If the node does not meet the requirements, a message is displayed, indicating the reasons. The command can also be used to locate the cause of an IEF software installation failure.

Syntax

edgectl diagnose installation [params] CHECKITEMS

diagnose can be abbreviated as diag.
installation can be abbreviated as install.

That is, the following abbreviated commands are supported:

edgectl diag installation [params] CHECKITEMS

edgectl diag install [params] CHECKITEMS

Parameters

**Table 1** Parameter description
Parameter	Mandatory	Shorthand	Description
CHECKITEMS	No	N/A	Check item list. The following values are supported: default: Check the hardware architecture, CPU, memory, hard disks, domain name resolution, network connectivity, and Docker. arch: Check whether the hardware architecture is supported by IEF. cpu: Check whether the CPU meets the IEF requirements. mem or memory: Check whether the memory meets the IEF requirements. disk: Check whether the hard disks meet the IEF requirements. dns: Check whether the domain name resolution function is normal. network: Check whether the node can be connected to IEF. docker: Check whether Docker is running properly. gpu or nvidia: Check whether the node is equipped with GPUs and whether the GPU driver is running properly. npu: Checks whether the node is equipped with NPUs. The check items are separated by commas (,). For example: edgectl diag install [params] cpu,disk Check items can also be deleted by adding a hyphen (-) before a check item. For example: edgectl diag install [params] default,-docker
--domain-name	No	None	Domain name to be resolved. It is required if you configure edgectl to check the domain name resolution function of the node.
--edge-hub-url	No	None	Endpoint address of IEF. It is used to check the connectivity between a node and IEF.
--node-id	No	None	Node ID. The default value is fake-node-id.
--project-id	No	None	Project ID. The default value is fake-project-id.
--detail	No	-x	Whether to print internal logs.

Example

Check whether a node meets the IEF software installation requirements.

edgectl diagnose installation

If the check is successful, the following information is displayed:

+---------------------------------+
| Installation diagnose succeed. |
+---------------------------------+

If the check fails, the information similar to the following is displayed:

Failed to get Docker version.
ERROR6102: Make sure that Docker is running.
For more information, see IEF documentation.

+-------------------------------+
| Installation diagnose failed. |
+-------------------------------+

In addition, an error code is displayed. You can obtain the help information from the documentation provided in the error message.

Parent topic: Managing the Product Lifecycle

Previous topic: Managing the Product Lifecycle

Next topic: Checking Nodes