diff --git a/docs/en/docs/Container/container-management.md b/docs/en/docs/Container/container-management.md index ef6dc65d475f8680e1908be5eb7c62a718944d89..2f0745fdd600c6002961b6edc3b358230fa9be50 100644 --- a/docs/en/docs/Container/container-management.md +++ b/docs/en/docs/Container/container-management.md @@ -1,26 +1,26 @@ # Container Management - [Container Management](#container-management) - - [Creating a Container](#creating-a-container) - - [Starting a Container](#starting-a-container) - - [Running a Container](#running-a-container) - - [Stopping a Container](#stopping-a-container) - - [Forcibly Stopping a Container](#forcibly-stopping-a-container) - - [Removing a Container](#removing-a-container) - - [Attaching to a Container](#attaching-to-a-container) - - [Renaming a Container](#renaming-a-container) - - [Executing a Command in a Running Container](#executing-a-command-in-a-running-container) - - [Querying Information About a Single Container](#querying-information-about-a-single-container) - - [Querying Information About All Containers](#querying-information-about-all-containers) - - [Restarting a Container](#restarting-a-container) - - [Waiting for a Container to Exit](#waiting-for-a-container-to-exit) - - [Viewing Process Information in a Container](#viewing-process-information-in-a-container) - - [Displaying Resource Usage Statistics of a Container](#displaying-resource-usage-statistics-of-a-container) - - [Obtaining Container Logs](#obtaining-container-logs) - - [Copying Data Between a Container and a Host](#copying-data-between-a-container-and-a-host) - - [Pausing a Container](#pausing-a-container) - - [Resuming a Container](#resuming-a-container) - - [Obtaining Event Messages from the Server in Real Time](#obtaining-event-messages-from-the-server-in-real-time) + - [Creating a Container](#creating-a-container) + - [Starting a Container](#starting-a-container) + - [Running a Container](#running-a-container) + - [Stopping a Container](#stopping-a-container) + - [Forcibly Stopping a Container](#forcibly-stopping-a-container) + - [Deleting a Container](#deleting-a-container) + - [Attaching to a Container](#attaching-to-a-container) + - [Renaming a Container](#renaming-a-container) + - [Executing a Command in a Running Container](#executing-a-command-in-a-running-container) + - [Querying Information About a Single Container](#querying-information-about-a-single-container) + - [Querying Information About All Containers](#querying-information-about-all-containers) + - [Restarting a Container](#restarting-a-container) + - [Waiting for a Container to Exit](#waiting-for-a-container-to-exit) + - [Viewing Process Information in a Container](#viewing-process-information-in-a-container) + - [Displaying Resource Usage Statistics of a Container](#displaying-resource-usage-statistics-of-a-container) + - [Obtaining Container Logs](#obtaining-container-logs) + - [Copying Data Between a Container and a Host](#copying-data-between-a-container-and-a-host) + - [Pausing a Container](#pausing-a-container) + - [Resuming a Container](#resuming-a-container) + - [Obtaining Event Messages from the Server in Real Time](#obtaining-event-messages-from-the-server-in-real-time) @@ -29,7 +29,7 @@ ### Description -To create a container, run the **isula create** command. The container engine will use the specified container image to create a read/write layer, or use the specified local rootfs as the running environment of the container. After the creation is complete, the container ID is output as standard output. You can run the **isula start** command to start the container. The new container is in the **inited** state. +To create a container, run the **isula create** command. The container engine will use the specified container image to create a read/write layer, or use the specified local rootfs as the running environment of the container. After the creation is complete, the container ID is output to the standard output. You can run the **isula start** command to start the container. The new container is in the **inited** status. ### Usage @@ -39,7 +39,7 @@ isula create [OPTIONS] IMAGE [COMMAND] [ARG...] ### Parameters -The following table lists the parameters supported by the **create** command. +The following table lists the parameters of the **create** command. **Table 1** Parameter description @@ -56,7 +56,7 @@ The following table lists the parameters supported by the **create** command.

--annotation

-

Sets annotations for the container. For example, set the native.umask parameter.

+

Sets annotations for the container. For example, set the native.umask annotation.

--annotation native.umask=normal #The umask value of the started container is 0022.
 --annotation native.umask=secure #The umask value of the started container is 0027.

If this parameter is not set, the umask configuration in iSulad is used.

@@ -84,7 +84,7 @@ The following table lists the parameters supported by the **create** command.

--cpu-quota

-

Limits the CPU CFS quota.

+

Sets the CPU quota in Completely Fair Scheduler (CFS).

--device=[]

@@ -144,17 +144,17 @@ The following table lists the parameters supported by the **create** command.

--health-cmd

-

Command executed in a container.

+

Command to be executed in the container.

--health-exit-on-unhealthy

-

Determines whether to kill a container when the container is detected unhealthy.

+

Determines whether to kill the container when the container is detected unhealthy.

--health-interval

-

Interval between two consecutive command executions.

+

Interval between health check commands.

--health-retries

@@ -164,7 +164,7 @@ The following table lists the parameters supported by the **create** command.

--health-start-period

-

Container initialization interval.

+

Time required to initialize the container.

--health-timeout

@@ -179,7 +179,7 @@ The following table lists the parameters supported by the **create** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-h, --hostname

@@ -189,7 +189,7 @@ The following table lists the parameters supported by the **create** command.

-i, --interactive

-

Enables the standard input of the container even if it is not connected to the standard input of the container.

+

Keep the standard input open even if it is not attached to the container.

--hugetlb-limit=[]

@@ -199,12 +199,12 @@ The following table lists the parameters supported by the **create** command.

--log-opt=[]

-

Log driver option. By default, the container serial port log function is disabled. You can run the --log-opt disable-log=false command to enable it.

+

Log driver option. By default, the container serial port log function is disabled. You can use the --log-opt disable-log=false option to enable it.

-l,--label

-

Sets a label for a container.

+

Sets labels for the container.

--lablel-file

@@ -219,37 +219,37 @@ The following table lists the parameters supported by the **create** command.

--memory-reservation

-

Sets the container memory limit. The default value is the same as that of --memory. --memory is a hard limit, and --memory-reservation is a soft limit. When the memory usage exceeds the preset value, the memory usage is dynamically adjusted (the system attempts to reduce the memory usage to a value less than the preset value when reclaiming the memory). However, the memory usage may exceed the preset value. Generally, this parameter can be used together with --memory. The value must be less than the preset value of --memory. The minimum value is 4 MB.

+

Sets the container memory limit. The default value is the same as the value of --memory. --memory is a hard limit, and --memory-reservation is a soft limit. When the memory usage exceeds the value of --memory, the memory usage is dynamically adjusted (the system attempts to reduce the memory usage to a value less than the value of --memory when reclaiming the memory). However, the memory usage may still exceed the value of --memory. Generally, this parameter can be used together with --memory. The value must be less than the value of --memory. The minimum value is 4 MB.

--memory-swap

-

Memory swap space, which should be a positive integer. The value -1 indicates no limit.

+

Memory swap space, which must be a positive integer. The value -1 indicates no limit.

--memory-swappiness

-

The value of swappiness is a positive integer ranging from 0 to 100. The smaller the value is, the less the swap partition is used and the more the memory is used in the Linux system. The larger the value is, the more the swap space is used by the kernel. The default value is –1, indicating that the default system value is used.

+

The value of swappiness is a positive integer ranging from 0 to 100. The smaller the value is, the less the swap partition is used and the more the memory is used by Linux. The larger the value is, the more the swap space is used by the kernel. The default value is –1, indicating that the default system value is used.

--mount

-

Mounts the host directory, volume, or file system to the container.

+

Mounts a host directory, volume, or file system to the container.

--no-healthcheck

-

Disables the health check configuration.

+

Disables health check configurations.

--name=NAME

-

Container name.

+

Sets a name for the container.

--net=none

-

Connects a container to a network.

+

Connects the container to a network.

--pids-limit

@@ -259,7 +259,7 @@ The following table lists the parameters supported by the **create** command.

--privileged

-

Grants container extension privileges.

+

Grants container extended privileges.

-R, --runtime

@@ -274,13 +274,13 @@ The following table lists the parameters supported by the **create** command.

--restart

-

Restart policy upon container exit.

+

Restart policy to apply upon container exit.

For a system container, --restart on-reboot is supported.

--storage-opt

-

Configures the storage driver option for a container.

+

Configures the storage driver options for the container.

-t, --tty

@@ -290,7 +290,7 @@ The following table lists the parameters supported by the **create** command.

--ulimit

-

Sets the ulimit for a container.

+

Sets the ulimit options for the container.

-u, --user

@@ -305,7 +305,7 @@ The following table lists the parameters supported by the **create** command.

--volumes-from=[]

-

Uses the mounting configuration of the specified container.

+

Mount volumes using the configurations of the specified container

@@ -313,7 +313,7 @@ The following table lists the parameters supported by the **create** command. ### Constraints -- When the **--user** or **--group-add** parameter is used to verify the user or group during container startup, if the container uses an OCI image, the verification is performed in the **etc/passwd** and **etc/group** files of the actual rootfs of the image. If a folder or block device is used as the rootfs of the container, the **etc/passwd** and **etc/group** files in the host are verified. The rootfs ignores mounting parameters such as **-v** and **--mount**. That is, when these parameters are used to attempt to overwrite the **etc/passwd** and **etc/group** files, the parameters do not take effect during the search and take effect only when the container is started. The generated configuration is saved in the **iSulad root directory/engine/container ID/start\_generate\_config.json** file. The file format is as follows: +- When the **--user** or **--group-add** parameter is used to verify the user or group during container startup, if the container uses an OCI image, the verification is performed in the `etc/passwd` and `etc/group` files of the actual rootfs of the image. If a folder or block device is used as the rootfs of the container, the `etc/passwd` and `etc/group` files in the host are verified. The rootfs ignores mounting parameters such as **-v** and **--mount** during the search. That is, when these parameters are used to attempt to overwrite the `etc/passwd` and `etc/group` files, the parameters do not take effect during the search and take effect only when the container is started. The generated configuration is saved in the `iSulad root directory/engine/container ID/start\_generate\_config.json` file. The file format is as follows: ``` { @@ -368,7 +368,7 @@ The following table lists the parameters supported by the **start** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-R, --runtime

@@ -417,7 +417,7 @@ The following table lists the parameters supported by the **run** command.

--annotation

-

Sets annotations for the container. For example, set the native.umask option.

+

Sets annotations for the container. For example, set the native.umask annotation.

--annotation native.umask=normal #The umask value of the started container is 0022.
 --annotation native.umask=secure #The umask value of the started container is 0027.

If this parameter is not set, the umask configuration in iSulad is used.

@@ -450,7 +450,7 @@ The following table lists the parameters supported by the **run** command.

--cpu-quota

-

Limits the CPU CFS quota.

+

Sets the CPU quota in Completely Fair Scheduler (CFS).

-d, --detach

@@ -515,17 +515,17 @@ The following table lists the parameters supported by the **run** command.

--health-cmd

-

Command executed in a container.

+

Command executed in the container.

--health-exit-on-unhealthy

-

Determines whether to kill a container when the container is detected unhealthy.

+

Determines whether to kill the container when the container is detected unhealthy.

--health-interval

-

Interval between two consecutive command executions.

+

Interval between health check commands.

--health-retries

@@ -535,7 +535,7 @@ The following table lists the parameters supported by the **run** command.

--health-start-period

-

Container initialization interval.

+

Time required to initialize the container.

--health-timeout

@@ -550,7 +550,7 @@ The following table lists the parameters supported by the **run** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-h, --hostname

@@ -565,12 +565,12 @@ The following table lists the parameters supported by the **run** command.

-i, --interactive

-

Enables the standard input of the container even if it is not connected to the standard input of the container.

+

Keep the standard input open even if it is not attached to the container.

--log-opt=[]

-

Log driver option. By default, the container serial port log function is disabled. You can run the --log-opt disable-log=false command to enable it.

+

Log driver option. By default, the container serial port log function is disabled. You can use the --log-opt disable-log=false option to enable it.

-m, --memory

@@ -580,17 +580,17 @@ The following table lists the parameters supported by the **run** command.

--memory-reservation

-

Sets the container memory limit. The default value is the same as that of --memory. --memory is a hard limit, and --memory-reservation is a soft limit. When the memory usage exceeds the preset value, the memory usage is dynamically adjusted (the system attempts to reduce the memory usage to a value less than the preset value when reclaiming the memory). However, the memory usage may exceed the preset value. Generally, this parameter can be used together with --memory. The value must be less than the preset value of --memory. The minimum value is 4 MB.

+

Sets the container memory limit. The default value is the same as that of --memory. --memory is a hard limit, and --memory-reservation is a soft limit. When the memory usage exceeds the value of --memory, the memory usage is dynamically adjusted (the system attempts to reduce the memory usage to a value less than the value of --memory when reclaiming the memory). However, the memory usage may still exceed the value of --memory. Generally, this parameter can be used together with --memory. The value must be less than the preset value of --memory. The minimum value is 4 MB.

--memory-swap

-

Memory swap space, which should be a positive integer. The value -1 indicates no limit.

+

Memory swap space, which must be a positive integer. The value -1 indicates no limit.

--memory-swappiness

-

The value of swappiness is a positive integer ranging from 0 to 100. The smaller the value is, the less the swap partition is used and the more the memory is used in the Linux system. The larger the value is, the more the swap space is used by the kernel. The default value is –1, indicating that the default system value is used.

+

The value of swappiness is a positive integer ranging from 0 to 100. The smaller the value is, the less the swap partition is used and the more the memory is used by Linux. The larger the value is, the more the swap space is used by the kernel. The default value is –1, indicating that the default system value is used.

--mount

@@ -600,17 +600,17 @@ The following table lists the parameters supported by the **run** command.

--no-healthcheck

-

Disables the health check configuration.

+

Disables health check configurations.

--name=NAME

-

Container name.

+

Sets a name for the container.

--net=none

-

Connects a container to a network.

+

Connects the container to a network.

--pids-limit

@@ -620,7 +620,7 @@ The following table lists the parameters supported by the **run** command.

--privileged

-

Grants container extension privileges.

+

Grants container extended privileges.

-R, --runtime

@@ -635,7 +635,7 @@ The following table lists the parameters supported by the **run** command.

--restart

-

Restart policy upon container exit.

+

Restart policy to apply upon container exit.

For a system container, --restart on-reboot is supported.

@@ -646,7 +646,7 @@ The following table lists the parameters supported by the **run** command.

--storage-opt

-

Configures the storage driver option for a container.

+

Configures the storage driver options for the container.

-t, --tty

@@ -656,7 +656,7 @@ The following table lists the parameters supported by the **run** command.

--ulimit

-

Sets the ulimit for a container.

+

Sets the ulimit options for the container.

-u, --user

@@ -677,10 +677,10 @@ The following table lists the parameters supported by the **run** command. - When the parent process of a container exits, the corresponding container automatically exits. - When a common container is created, the parent process cannot be initiated because the permission of common containers is insufficient. As a result, the container does not respond when you run the **attach** command though it is created successfully. - If **--net** is not specified when the container is running, the default host name is **localhost**. -- If the **--files-limit** parameter is to transfer a small value, for example, 1, when the container is started, iSulad creates a cgroup, sets the files.limit value, and writes the PID of the container process to the **cgroup.procs** file of the cgroup. At this time, the container process has opened more than one handle. As a result, a write error is reported, and the container fails to be started. -- If both** --mount** and **--volume** exist and their destination paths conflict, **--mount** will be run after **--volume** \(that is, the mount point in **--volume** will be overwritten\). +- If the **--files-limit** parameter is to transfer a small value, for example, 1, when the container is started, iSulad creates a cgroup, sets the **files.limit** value, and writes the PID of the container process to the **cgroup.procs** file of the cgroup. At this time, the container process has opened more than one handle. As a result, a write error is reported, and the container fails to be started. +- If both **--mount** and **--volume** exist and their destination paths conflict, **--mount** will be run after **--volume** \(that is, the mount point in **--volume** will be overwritten\). - Note: The value of the **type** parameter of lightweight containers can be **bind** or **squashfs**. When **type** is set to **squashfs**, **src** is the image path. The value of the **type** parameter of the native Docker can be **bind**, **volume**, and **tmpfs**. + Note: The value of the **type** parameter of lightweight containers can be **bind** or **squashfs**. When **type** is set to **squashfs**, `src` is the image path. The value of the **type** parameter of the native Docker can be **bind**, **volume**, and **tmpfs**. - The restart policy does not support **unless-stopped**. - The values returned for Docker and lightweight containers are 127 and 125 respectively in the following three scenarios: @@ -691,8 +691,8 @@ The following table lists the parameters supported by the **run** command. The entry point specified by **--entrypoint** does not exist. -- When the **--volume** parameter is used, /dev/ptmx will be deleted and recreated during container startup. Therefore, do not mount the **/dev** directory to that of the container. Use **--device** to mount the devices in **/dev** of the container. -- Do not use the echo option to input data to the standard input of the **run** command. Otherwise, the client will be suspended. The echo value should be directly transferred to the container as a command line parameter. +- When the **--volume** parameter is used, `/dev/ptmx` will be deleted and recreated during container startup. Therefore, do not mount the `/dev` directory to that of the container. Use **--device** to mount the devices in `/dev` of the container. +- Do not use the **echo** command to input data to the standard input of the **run** command. Otherwise, the client will be suspended. The value of **echo** should be directly transferred to the container as a command line parameter. ``` [root@localhost ~]# echo ls | isula run -i busybox /bin/sh @@ -702,7 +702,7 @@ The following table lists the parameters supported by the **run** command. [root@localhost ~]# ``` - The client is suspended when the preceding command is executed because the preceding command is equivalent to input **ls** to **stdin**. Then EOF is read and the client does not send data and waits for the server to exit. However, the server cannot determine whether the client needs to continue sending data. As a result, the server is suspended in reading data, and both parties are suspended. + The client is suspended when the preceding command is executed because the preceding command is equivalent to input **ls** to **STDIN**. Then EOF is read and the client does not send data and waits for the server to exit. However, the server cannot determine whether the client needs to continue sending data. As a result, the server is suspended in reading data, and both parties are suspended. The correct execution method is as follows: @@ -721,7 +721,7 @@ The following table lists the parameters supported by the **run** command. [root@localhost ~]# ``` -- If the root directory \(/\) of the host is used as the file system of the container, the following situations may occur during the mounting: +- If the root directory \(`/`\) of the host is used as the file system of the container, the following situations may occur during the mounting: **Table 2** Mounting scenarios @@ -746,8 +746,8 @@ The following table lists the parameters supported by the **run** command. >![](./public_sys-resources/icon-notice.gif) **NOTICE:** - >Scenario 1: Mount **/home/test1** and then **/home/test2**. In this case, the content in **/home/test1** overwrites the content in **/mnt**. As a result, the **abc** directory does not exist in **/mnt**, and mounting** /home/test2** to **/mnt/abc** fails. - >Scenario 2: Mount **/home/test2** and then **/home/test1**. In this case, the content of **/mnt** is replaced with the content of **/home/test1** during the second mounting. In this way, the content mounted during the first mounting from **/home/test2** to **/mnt/abc** is overwritten. + >Scenario 1: Mount `/home/test1` and then `/home/test2`. In this case, the content in `/home/test1` overwrites the content in `/mnt`. As a result, the `abc` directory does not exist in `/mnt`, and mounting `/home/test2` to `/mnt/abc` fails. + >Scenario 2: Mount `/home/test2` and then `/home/test1`. In this case, the content of `/mnt` is replaced with the content of `/home/test1` during the second mounting. In this way, the content mounted during the first mounting from `/home/test2` to `/mnt/abc` is overwritten. >The first scenario is not supported. For the second scenario, users need to understand the risk of data access failures. >![](./public_sys-resources/icon-notice.gif) **NOTICE:** @@ -804,7 +804,7 @@ The following table lists the parameters supported by the **stop** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-t, --time

@@ -872,7 +872,7 @@ The following table lists the parameters supported by the **kill** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-s, --signal

@@ -892,11 +892,11 @@ $ isula kill fd7376591a9c3d8ee9a14f5d2c2e5255b02cc44cddaabca82170efd4497510e1 fd7376591a9c3d8ee9a14f5d2c2e5255b02cc44cddaabca82170efd4497510e1 ``` -## Removing a Container +## Deleting a Container ### Description -To remove a container, run the **isula rm** command. +To delete a container, run the **isula rm** command. ### Usage @@ -922,17 +922,17 @@ The following table lists the parameters supported by the **rm** command.

-f, --force

-

Forcibly removes a running container.

+

Forcibly deletes a running container.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-v, --volume

-

Removes a volume mounted to a container. (Note: Currently, iSulad does not use this function.)

+

Deletes a volume mounted to a container. (Note: Currently, iSulad does not support this parameter.)

@@ -987,7 +987,7 @@ The following table lists the parameters supported by the **attach** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-D, --debug

@@ -1060,7 +1060,7 @@ $ isula rename my_container my_new_container ### Description -To execute a command in a running container, run the **isula exec** command. This command is executed in the default directory of the container. If a user-defined directory is specified for the basic image, the user-defined directory is used. +To execute a command in a running container, run the **isula exec** command. This command is executed in the default directory of the container. If a user-defined directory is specified for the base image, the user-defined directory is used. ### Usage @@ -1092,22 +1092,22 @@ The following table lists the parameters supported by the **exec** command.

-e, --env

-

Sets environment variables. (Note: Currently, iSulad does not use this function.)

+

Sets environment variables. (Note: Currently, iSulad does not support this parameter.)

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-i, --interactive

-

Enables the standard input though no connection is set up. (Note: Currently, iSulad does not use this function.)

+

Enables the standard input though no connection is set up. (Note: Currently, iSulad does not support this parameter.)

-t, --tty

-

Allocates a pseudo terminal. (Note: Currently, iSulad does not use this function.)

+

Allocates a pseudo terminal. (Note: Currently, iSulad does not support this parameter.)

-u, --user

@@ -1127,11 +1127,11 @@ The following table lists the parameters supported by the **exec** command. - After running the **isula exec** command to access the container process, do not run background programs. Otherwise, the system will be suspended. - To run the **isula exec** command to execute a background process, perform the following steps: + The **isula exec** command runs a background process as follows: - 1. Run the **isula exec container\_name bash** command to access the container. - 2. After entering the container, run the **script &** command. - 3. Run the **exit** command. The terminal stops responding. + 1. The **isula exec container\_name bash** command is executed to accesses the container terminal. + 2. After entering the container, the **script &** command is executed. + 3. The **exit** command is executed. The terminal stops responding. ``` After the isula exec command is executed to enter the container, the background program stops responding because the isula exec command is executed to enter the container and run the background while1 program. When the bash command is run to exit the process, the while1 program does not exit and becomes an orphan process, which is taken over by process 1. @@ -1141,17 +1141,17 @@ The following table lists the parameters supported by the **exec** command. - Do not run the **isula exec** command in the background. Otherwise, the system may be suspended. - Run the **isula exec** command in the background as follows: + The **isula exec** command runs in the background as follows: - Run the **isula exec script &** command in the background, for example, **isula exec container\_name script &,isula exec**. The command is executed in the background. The script continuously displays a file by running the **cat** command. Normally, there is output on the current terminal. If you press **Enter** on the current terminal, the client exits the stdout read operation due to the I/O read failure. As a result, the terminal does not output data. The server continues to write data to the buffer of the FIFO because the process is still displaying files by running the **cat** command. When the buffer is full, the process in the container is suspended in the write operation. + The **isula exec script &** command is used to run **exec** in the background, for example, **isula exec container\_name script &**. The **isula exec** command is executed in the background. The script continuously runs the **cat** command on a file. Normally, the file is concatenated to the current terminal. If you press **Enter** on the current terminal, the client exits the standard output read operation due to the I/O read failure. As a result, the terminal does not output data. The server continues to write data to the buffer of the FIFO because the process is still running the **cat** command on the file. When the buffer is full, the process in the container is suspended in the write operation. -- When a lightweight container uses the **exec** command to execute commands with pipe operations, you are advised to run the **/bin/bash -c** command. +- When a lightweight container uses the **exec** command to execute commands with pipe operations, you are advised to run the command using **/bin/bash -c**. Typical application scenarios: - Run the **isula exec container\_name -it ls /test | grep "xx" | wc -l** command to count the number of xx files in the test directory. The output is processed by **grep** and **wc** through the pipe because **ls /test** is executed with **exec**. The output of **ls /test** executed by **exec** contains line breaks. When the output is processed, the result is incorrect. + Run the **isula exec container\_name -it ls /test | grep "xx" | wc -l** command to count the number of xx files in the test directory. The **exec** command executes the **ls /test** command. The output is then processed by **grep** and **wc** through the pipe. Because the output of **ls /test** executed by **exec** contains line feed characters, when the output is processed, the result is incorrect. - Cause: Run the **ls /test** command using **exec**. The command output contains a line feed character. Run the** | grep "xx" | wc -l** command for the output. The processing result is 2 \(two lines\). + Cause: The **ls /test** command is executed by **exec**. The command output contains a line feed character. The output is then processced by the **| grep "xx" | wc -l** command. The processing result is 2 \(two lines\). ``` [root@localhost ~]# isula exec -it container ls /test @@ -1160,7 +1160,7 @@ The following table lists the parameters supported by the **exec** command. [root@localhost ~]# ``` - Suggestion: When running the **run/exec** command to perform pipe operations, run the **/bin/bash -c** command to perform pipe operations in the container. + Suggestion: When running the **run/exec** command to perform pipe operations, run the command using **/bin/bash -c** to perform pipe operations in the container. ``` [root@localhost ~]# isula exec -it container /bin/sh -c "ls /test | grep "xx" | wc -l" @@ -1168,7 +1168,7 @@ The following table lists the parameters supported by the **exec** command. [root@localhost ~]# ``` -- Do not use the **echo** option to input data to the standard input of the **exec** command. Otherwise, the client will be suspended. The echo value should be directly transferred to the container as a command line parameter. +- Do not use the **echo** option to input data to the standard input of the **exec** command. Otherwise, the client will be suspended. The value of **echo** should be directly transferred to the container as a command line parameter. ``` [root@localhost ~]# echo ls | isula exec 38 /bin/sh @@ -1178,7 +1178,7 @@ The following table lists the parameters supported by the **exec** command. [root@localhost ~]# ``` - The client is suspended when the preceding command is executed because the preceding command is equivalent to input **ls** to **stdin**. Then EOF is read and the client does not send data and waits for the server to exit. However, the server cannot determine whether the client needs to continue sending data. As a result, the server is suspended in reading data, and both parties are suspended. + The client is suspended when the preceding command is executed because the command is equivalent to input **ls** to the standard input. Then EOF is read and the client does not send data and waits for the server to exit. However, the server cannot determine whether the client needs to continue sending data. As a result, the server is suspended in reading data, and both parties are suspended. The correct execution method is as follows: @@ -1190,7 +1190,7 @@ The following table lists the parameters supported by the **exec** command. ### Example -Run the echo command in a running container. +Run the **echo** command in a running container. ``` $ isula exec c75284634bee echo "hello,world" @@ -1228,12 +1228,12 @@ The following table lists the parameters supported by the **inspect** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-f, --format

-

Output format.

+

Formats the output using a template.

-t, --time

@@ -1419,7 +1419,7 @@ The following table lists the parameters supported by the **ps** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-q, --quiet

@@ -1434,12 +1434,12 @@ The following table lists the parameters supported by the **ps** command.

--format

-

Output format.

+

Formats the output using a template.

--no-trunc

-

Do not truncate the container ID.

+

Does not truncate the container ID.

@@ -1490,7 +1490,7 @@ The following table lists the parameters supported by the **restart** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-t, --time

@@ -1505,7 +1505,7 @@ The following table lists the parameters supported by the **restart** command. - If the **t** parameter is specified and the value of **t** is less than 0, ensure that the application in the container can process the stop signal. - The restart command first calls the stop command to stop the container. Send the SIGTERM signal to the container, and then wait for a period of time \(**t** entered by the user\). If the container is still running after the period of time, the SIGKILL signal is sent to forcibly kill the container. + The restart command first calls the **stop** command to stop the container. Send the SIGTERM signal to the container, and then wait for a period of time \(**t** entered by the user\). If the container is still running after the period of time, the SIGKILL signal is sent to forcibly kill the container. - The meaning of the input parameter **t** is as follows: @@ -1515,7 +1515,7 @@ The following table lists the parameters supported by the **restart** command. **t** \> 0: Wait for a specified period and send **kill -9** to the container if the container does not stop within the specified period. - Therefore, if **t** is set to a value less than 0 \(for example, **t** = -1\), ensure that the container application correctly processes the SIGTERM signal. If the container ignores this signal, the container will be suspended when the **isula stop** command is run. + Therefore, if **t** is set to a value less than 0 \(for example, **t** = -1\), ensure that the container application correctly processes the SIGTERM signal. If the container ignores this signal, the container will be suspended when the **isula restart** command is run. ### Example @@ -1557,7 +1557,7 @@ The following table lists the parameters supported by the **wait** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

/

@@ -1608,7 +1608,7 @@ The following table lists the parameters supported by the **top** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

/

@@ -1661,7 +1661,7 @@ The following table lists the parameters supported by the **stats** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-a, --all

@@ -1671,7 +1671,7 @@ The following table lists the parameters supported by the **stats** command.

--no-stream

-

Display the first result only. Only statistics in non-stream mode are displayed.

+

Disables streaming stats and displays the first result only.

@@ -1717,7 +1717,7 @@ The following table lists the parameters supported by the **logs** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-f, --follow

@@ -1735,7 +1735,7 @@ The following table lists the parameters supported by the **logs** command. ### Constraints -- By default, the container log function is enabled. To disable this function, run the **isula create --log-opt disable-log=true** or **isula run --log-opt disable-log=true** command. +- By default, the container serial port log function is enabled. To disable this function, run the **isula create --log-opt disable-log=true** or **isula run --log-opt disable-log=true** command. ### Example @@ -1779,7 +1779,7 @@ The following table lists the parameters supported by the **cp** command.

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

@@ -1795,7 +1795,7 @@ The following table lists the parameters supported by the **cp** command. [root@localhost tmp]# ``` -- When decompressing a file, iSulad does not check the type of the file or folder to be overwritten in the file system. Instead, iSulad directly overwrites the file or folder. Therefore, if the source is a folder, the file with the same name is forcibly overwritten as a folder. If the source file is a file, the folder with the same name will be forcibly overwritten as a file. +- When decompressing files, iSulad does not check whether a file or folder is to be overwritten in the file system. Instead, iSulad directly overwrites the file or folder. Therefore, if the source is a folder, the file with the same name is forcibly overwritten as a folder. If the source is a file, the folder with the same name will be forcibly overwritten as a file. ``` [root@localhost tmp]# rm -rf /tmp/test_file_to_dir && mkdir /tmp/test_file_to_dir @@ -1810,13 +1810,13 @@ The following table lists the parameters supported by the **cp** command. ### Example -Copy the **/test/host** directory on the host to the **/test** directory on container 21fac8bb9ea8. +Copy the `/test/host` directory on the host to the `/test` directory on container 21fac8bb9ea8. ``` isula cp /test/host 21fac8bb9ea8:/test ``` -Copy the **/www** directory on container 21fac8bb9ea8 to the **/tmp** directory on the host. +Copy the `/www` directory on container 21fac8bb9ea8 to the `/tmp` directory on the host. ``` isula cp 21fac8bb9ea8:/www /tmp/ @@ -1848,7 +1848,7 @@ isula pause CONTAINER [CONTAINER...]

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

@@ -1856,7 +1856,7 @@ isula pause CONTAINER [CONTAINER...] ### Constraints -- Only containers in the running state can be paused. +- Only containers in the running status can be paused. - After a container is paused, other lifecycle management operations \(such as **restart**, **exec**, **attach**, **kill**, **stop**, and **rm**\) cannot be performed. - After a container with health check configurations is paused, the container status changes to unhealthy. @@ -1895,7 +1895,7 @@ isula unpause CONTAINER [CONTAINER...]

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

@@ -1903,7 +1903,7 @@ isula unpause CONTAINER [CONTAINER...] ### Constraints -- Only containers in the paused state can be unpaused. +- Only containers in the paused status can be unpaused. ### Example @@ -1916,7 +1916,7 @@ $ isula unpause 8fe25506fb5883b74c2457f453a960d1ae27a24ee45cdd78fb7426d2022a8bac ## Obtaining Event Messages from the Server in Real Time -### **Description** +### Description The **isula events** command is used to obtain event messages such as container image lifecycle and running event from the server in real time. Only containers whose runtime type is **lcr** are supported. @@ -1941,7 +1941,7 @@ isula events [OPTIONS]

-H, --host

-

Specifies the iSulad socket file path to be accessed.

+

Specifies the iSulad socket file path to be connected.

-n, --name

diff --git a/docs/en/docs/Container/container-tools.md b/docs/en/docs/Container/container-tools.md new file mode 100644 index 0000000000000000000000000000000000000000..5c4e83c56e68c023410f9ff1c9580a02b5f19274 --- /dev/null +++ b/docs/en/docs/Container/container-tools.md @@ -0,0 +1,3 @@ +# Container Tools + +To improve the management and use of containers, iSulad provides some container tools, including the container image building tool iSula-build and the container migration tool iSula-transform. This chapter describes how to install and use the container tools. \ No newline at end of file diff --git a/docs/en/docs/Container/image-management-2.md b/docs/en/docs/Container/image-management-4.md similarity index 58% rename from docs/en/docs/Container/image-management-2.md rename to docs/en/docs/Container/image-management-4.md index 2d7fa0077fa033caef470e3291f83ad279d39091..a6c4c9263903a97f89765dd68d1a2abe4cf16426 100644 --- a/docs/en/docs/Container/image-management-2.md +++ b/docs/en/docs/Container/image-management-4.md @@ -1,6 +1,6 @@ # Image Management -- [Image Management](#image-management-2) +- [Image Management](#image-management) - [build](#build) - [history](#history) - [images](#images) @@ -22,13 +22,13 @@ ## build -Syntax: **docker build \[**_options_**\]** _path_ **|** _URL_ **| -** +Syntax: **docker build** \[OPTIONS\] PATH | URL | - Function: Builds an image using the Dockerfile in the specified path. -Parameter description: Common parameters are as follows. For details about more parameters, see the **docker help build** command section. +Parameters: Common parameters are as follows. For details about more parameters, run the **docker help build** command. -**Table 1** Parameter description +**Table 4** Parameter description - - - - -

Parameter

@@ -44,12 +44,12 @@ Parameter description: Common parameters are as follows. For details about more

--no-cache=false

Builds cache without using cache.

+

Builds the image without using cache.

-q, --quiet=false

Prevents the redundant information generation during the build.

+

Suppresses the redundant information generated during the the build process.

--rm=true

@@ -59,7 +59,7 @@ Parameter description: Common parameters are as follows. For details about more

-t, --tag=""

Tag name of the image generated during the build.

+

Specifies the tag name of the image generated during the build.

--build-arg=[]

@@ -74,42 +74,42 @@ Parameter description: Common parameters are as follows. For details about more

--isolation

Container isolation method.

+

Specifies the container isolation method.

--pull

Obtains the latest image during the build.

+

Always attempts to obtain the latest version of the image during the build process.
-**Dockerfile Command** +**Dockerfile Description** -Dockerfile is used to describe how to build an image and automatically build a container. The format of all **Dockerfile** commands is _instruction_ _arguments_. +Dockerfile is used to automatically build a container by describing how to build an image. All Dockerfile instructions are in the **INSTRUCTION arguments** format.    -**FROM Command** +**FROM Instruction** -Syntax: **FROM** _image_ or **FROM** _image_:_tag_ +Syntax: **FROM** or **FROM** : -Function: Specifies a basic image, which is the first command for all Dockerfile files. If the tag of a basic image is not specified, the default tag name **latest** is used. +Function: Specifies a base image, which is the first instruction in all Dockerfiles. If the tag of the base image is not specified, the default tag name **latest** is used.    -**RUN Command** +**RUN Instruction** -Syntax: **RUN** _command_ \(for example, **run in a shell - \`/bin/sh -c\`**\) or +Syntax: **RUN** \(The **shell** form. The command is run in a shell which by default is `/bin/sh -c`) or -**RUN \[**_executable_, _param1_, _param2_ ... **\]** \(in the **exec** command format\) +**RUN** \["", "", "" ... \] \(The **exec** form\) -Function: Runs any command in the image specified by the **FROM** command and then commits the result. The committed image can be used in later commands. The **RUN** command is equivalent to: +Function: Executes any commands in the image specified by the **FROM** instruction and then commits the result. The committed image will be used in the next step in the Dockerfile. The **RUN** instruction is equivalent to: -**docker run** _image_ _command_ +**docker run** -**docker commit** _container\_id_ +**docker commit**    @@ -119,89 +119,89 @@ The number sign \(\#\) is used to comment out.    -**MAINTAINER Command** +**MAINTAINER Instruction** -Syntax: **MAINTAINER **_name_ +Syntax: **MAINTAINER** -Function: Specifies the name and contact information of the maintenance personnel. +Function: Specifies the name and contact information of the maintainer.    -**ENTRYPOINT Command** +**ENTRYPOINT Instruction** -Syntax: **ENTRYPOINT cmd **_param1 param2..._ or **ENTRYPOINT \[**_"cmd", "param1", "param2"..._**\]** +Syntax: **ENTRYPOINT** ... or **ENTRYPOINT** \["", "", ""...\] -Function: Configures the command to be executed during container startup. +Function: Configures the commands to be executed during container startup.    -**USER Command** +**USER Instruction** -Syntax: **USER **_name_ +Syntax: **USER** -Function: Specifies the running user of memcached. +Function: Specifies the user to run **memcached**.    -**EXPOSE Command** +**EXPOSE Instruction** -Syntax: **EXPOSE **_port_** \[**_port_**...\]** +Syntax: **EXPOSE** \[...\] -Function: Enables one or more ports for images. +Function: Exposes one or more ports of the image.    -**ENV Command** +**ENV Instruction** -Syntax: **ENV**_ key value_ +Syntax: **ENV** -Function: Configures environment variables. After the environment variables are configured, the **RUN** commands can be subsequently used. +Function: Configures environment variables. The configured environment variables can be used by the subsequent **RUN** instructions.    -**ADD Command** +**ADD Instruction** -Syntax: **ADD**_ src dst_ +Syntax: **ADD** -Function: Copies a file from the _src_ directory to the _dest_ directory of a container. _src_ indicates the relative path of the source directory to be built. It can be the path of a file or directory, or a remote file URL. _dest_ indicates the absolute path of the container. +Function: Copies a file from directory to directory of the container. is a relative path of the source directory to be built. It can be the path of a file or directory, or a remote file URL. is an absolute path of the container.    -**VOLUME Command** +**VOLUME Instruction** -Syntax: **VOLUME \["**_mountpoint_**"\]** +Syntax: **VOLUME** \[""\] -Function: Creates a mount point for sharing a directory. +Function: Creates a mount point for the shared directory.    -**WORKDIR Command** +**WORKDIR Instruction** -Syntax: **workdir **_path_ +Syntax: **WORKDIR** -Function: Runs the **RUN**, **CMD**, and **ENTRYPOINT** commands to set the current working path. The current working path can be set multiple times. If the current working path is a relative path, it is relative to the previous **WORKDIR** command. +Function: Sets the working path for the **RUN**, **CMD**, and **ENTRYPOINT** instructions. The working path can be set multiple times. If the working path is a relative path, it is relative to the previous **WORKDIR** instruction.    -**CMD command** +**CMD Instruction** -Syntax: **CMD \[**_"executable","param1","param2"_**\]** \(This command is similar to the **exec** command and is preferred.\) +Syntax: **CMD** \["","",""\] \(The **exec** form. This is the preferred form.\) -**CMD \["**_param1_**","**_param2_**"\]** \(The parameters are the default parameters for ENTRYPOINT.\) +**CMD** \["",""\] \(The arguments are the default arguments for **ENTRYPOINT**.\) -**CMD** _command_ _param1_ _param2_ \(This command is similar to the **shell** command.\) +**CMD** "" "" "" \(The **shell** form.\) -Function: A Dockerfile can contain only one CMD command. If there are multiple CMD commands, only the last one takes effect. +Function: A Dockerfile can contain only one CMD instruction. If there are multiple CMD instructions, only the last one takes effect.    -**ONBUILD Commands** +**ONBUILD Instruction** -Syntax: **ONBUILD \[**_other commands_**\]** +Syntax: **ONBUILD** \[other instructions\] -Function: This command is followed by other commands, such as the **RUN** and **COPY** commands. This command is not executed during image build and is executed only when the current image is used as the basic image to build the next-level image. +Function: This instruction is followed by other instructions, such as the **RUN** and **COPY** instructions. This instruction is not executed during image build and is executed only when the current image is used as the base image for another build. -The following is a complete example of the Dockerfile command that builds an image with the sshd service installed. +The following is a complete example of a Dockerfile that builds an image with the sshd service installed. 
FROM busybox
@@ -216,7 +216,7 @@ ENTRYPOINT /usr/sbin/sshd -D
-Example: +Example commands: 1. Run the following command to build an image using the preceding Dockerfile: @@ -233,17 +233,17 @@ Example: ## history -Syntax: **docker history \[**_options_**\]** _image_ +Syntax: **docker history** \[OPTIONS\] Function: Displays the change history of an image. -Parameter description: +Parameters: --H, --human=true +**-H**, **--human=true** -**--no-trunc=false**: Does not delete any output. +**--no-trunc=false**: Indicates that the output is not truncated. -**-q** and **--quiet=false**: Display only IDs. +**-q** and **--quiet=false**: Displays IDs only. Example: @@ -258,19 +258,19 @@ be4672959e8b 15 minutes ago bash 23B ## images -Syntax: **docker images \[**_options_**\] \[**_name_**\]** +Syntax: **docker images** \[OPTIONS\] \[NAME\] -Function: Lists existing images. The intermediate image is not displayed if no parameter is configured. +Function: Lists existing images. The intermediate images are not displayed if no parameter is added. -Parameter description: +Parameters: -**-a** and **--all=false**: Display all images. +**-a** and **--all=false**: Displays all images. -**-f** and **--filter=\[\]**: Specify a filtering value, for example, **dangling=true**. +**-f** and **--filter=\[\]**: Specifies a filter, for example, **dangling=true**. -**--no-trunc=false**: Does not delete any output. +**--no-trunc=false**: Indicates that the output is not truncated. -**-q** and **--quiet=false**: Display only IDs. +**-q** and **--quiet=false**: Displays IDs only. Example: @@ -284,15 +284,15 @@ busybox latest e02e811dd08f 2 years ago ## import -Syntax: **docker import URL|- \[**_repository_**\[**_:tag_**\]\]** +Syntax: **docker import URL|- \[REPOSITORY\[:TAG\]\]** -Function: Imports a .tar package that contains rootfs as an image. This parameter corresponds to the **docker export** command. +Function: Imports a `.tar` package that contains a rootfs as an image. This parameter corresponds to the **docker export** command. -Parameter description: none. +Parameters: none. Example: -Run the following command to generate a new image for **busybox.tar** exported using the **docker export** command: +Run the following command to generate a new image from the **busybox.tar** file exported using the **docker export** command: ``` $ sudo docker import busybox.tar busybox:test @@ -306,13 +306,13 @@ busybox test a79d8ae12403 2 seconds ago ## load -Syntax: **docker load \[**_options_**\]** +Syntax: **docker load** \[OPTIONS\] -Function: Reloads an image from .tar package obtained by running the **docker save** command. This parameter corresponds to the **docker save** command. +Function: Loads an image from `.tar` package obtained using the **docker save** command. This command corresponds to the **docker save** command. -Parameter description: +Parameters: -**-i** and **--input=""** can be used. +**-i** and **--input=""**. Example: @@ -326,17 +326,17 @@ busybox latest e02e811dd08f 2 years ago ## login -Syntax: **docker login \[**_options_**\] \[**_server_**\]** +Syntax: **docker login** \[OPTIONS\] \[SERVER\] -Function: Logs in to an image server. If no server is specified, the system logs in to **https://index.docker.io/v1/** by default. +Function: Logs in to an image registry. If no server is specified, the system logs in to https://index.docker.io/v1/ by default. -Parameter description: +Parameters: -**-e** and **--email=""**: Email address. +**-e** and **--email=""**: Email address. -**-p** and **--password=""**: Password. +**-p** and **--password=""**: Password. -**-u** and **--username=""**: User name. +**-u** and **--username=""**: User name. Example: @@ -346,11 +346,11 @@ $ sudo docker login ## logout -Syntax: **docker logout \[**_server_**\]** +Syntax: **docker logout** \[SERVER\] -Function: Logs out of an image server. If no server is specified, the system logs out of **https://index.docker.io/v1/** by default. +Function: Logs out from an image registry. If no server is specified, the system logs out from https://index.docker.io/v1/ by default. -Parameter description: none. +Parameters: none. Example: @@ -360,17 +360,17 @@ $ sudo docker logout ## pull -Syntax: **docker pull \[**_options_**\]** _name_**\[**_:tag_**\]** +Syntax: **docker pull** \[OPTIONS\] NAME\[:TAG\] -Function: Pulls an image from an official or private registry. +Function: Pulls an image from the official or private registry. -Parameter description: +Parameters: -**-a** and **--all-tags=false**: Download all images in a registry. \(A registry can be tagged with multiple tags. For example, a busybox registry may have multiple tags, such as **busybox:14.04**, **busybox:13.10**, **busybox:latest**. If **-a** is used, all busybox images with tags are pulled.\) +**-a** and **--all-tags=false**: Downloads all images in the registry. \(A registry can be tagged with multiple tags. For example, a BusyBox registry may have multiple tags, such as **busybox:14.04**, **busybox:13.10**, **busybox:latest**. If **-a** is used, all BusyBox images with tags are pulled.\) Example: -1. Run the following command to obtain the Nginx image from the official registry: +1. Run the following command to pull an Nginx image from the official registry: ``` $ sudo docker pull nginx @@ -383,11 +383,11 @@ Example: Status: Downloaded newer image for nginx:latest ``` - When an image is pulled, the system checks whether the dependent layer exists. If yes, the local layer is used. + When pulling the image, the system checks whether the dependent layer exists. If yes, the local layer is used. 2. Pull an image from a private registry. - Run the following command to pull the Fedora image from the private registry, for example, the address of the private registry is **192.168.1.110:5000**: + Run the following command to pull a Fedora image from the private registry, assuming the address of the private registry is **192.168.1.110:5000**: ``` $ sudo docker pull 192.168.1.110:5000/fedora @@ -396,16 +396,16 @@ Example: ## push -Syntax: **docker push** _name_**\[**_:tag_**\]** +Syntax: **docker push** NAME\[:TAG\] Function: Pushes an image to the image registry. -Parameter description: none. +Parameters: none. Example: -1. Run the following command to push an image to the private image registry at 192.168.1.110:5000. -2. Label the image to be pushed. \(The **docker tag** command is described in the following section.\) In this example, the image to be pushed is busybox:sshd. +1. Assume an image is to be push to the private image registry at 192.168.1.110:5000. +2. Label the image to be pushed. \(The **docker tag** command is described in the following section.\) In this example, the image to be pushed is **busybox:sshd**. ``` $ sudo docker tag ubuntu:sshd 192.168.1.110:5000/busybox:sshd @@ -422,13 +422,13 @@ Example: ## rmi -Syntax: **docker rmi \[**_options_**\] **_image _**\[**_image..._**\]** +Syntax: **docker rmi** \[OPTIONS\] IMAGE \[IMAGE...\] -Function: Deletes one or more images. If an image has multiple tags in the image library, only the untag operation is performed when the image is deleted. If the image has only one tag, the dependent layers are deleted in sequence. +Function: Deletes one or more images. If an image has multiple tags in the image library, the image is not deleted but only untagged. When an image with one tag is deleted, the dependent layers are deleted in sequence. -Parameter description: +Parameters: -**-f** and **--force=false**: Forcibly delete an image. +**-f** and **--force=false**: Forcibly deletes the images. **--no-prune=false**: Does not delete parent images without tags. @@ -440,13 +440,13 @@ $ sudo docker rmi 192.168.1.110:5000/busybox:sshd ## save -Syntax: **docker save \[**_options_**\] **_image _**\[**_image..._**\]** +Syntax: **docker save** \[OPTIONS\] IMAGE \[IMAGE...\] -Function: Saves an image to a TAR package. The output is **STDOUT** by default. +Function: Saves an image to a `.tar` package. The results are output to **STDOUT** by default. -Parameter description: +Parameters: -**-o** and **--output=""**: Save an image to a file rather than STDOUT. +**-o** and **--output=""**: Outputs the results to a file rather than **STDOUT**. Example: @@ -458,21 +458,21 @@ nginx.tar ## search -Syntax: **docker search **_options_ _TERM_ +Syntax: **docker search** \[OPTIONS\] TERM -Function: Searches for a specific image in the image registry. +Function: Searches for specific images in the image registry. -Parameter description: +Parameters: **--automated=false**: Displays the automatically built image. -**--no-trunc=false**: Does not delete any output. +**--no-trunc=false**: Indicates that output is not truncated. -**-s** and **--stars=0**: Display only images of a specified star level or higher. +**-s** and **--stars=0**: Displays only images that have a specific number of stars or more. Example: -1. Run the following command to search for Nginx in the official image library: +1. Run the following command to search for Nginx images in the official image library: ``` $ sudo docker search nginx @@ -487,7 +487,7 @@ Example:    -2. Run the following command to search for busybox in the private image library. The address of the private image library must be added during the search. +2. Run the following command to search for BusyBox images in the private image library. Add the address to search the private image library. ``` $ sudo docker search 192.168.1.110:5000/busybox @@ -496,13 +496,13 @@ Example: ## tag -Syntax: **docker tag \[**_options_**\] **_image_**\[**_:tag_**\] \[**_registry host/_**\]\[**_username/_**\]**_name_**\[**_:tag_**\]** +Syntax: **docker tag** \[OPTIONS\] IMAGE\[:TAG\] \[REGISTRY HOST/\]\[USERNAME/\]NAME\[:TAG\] -Function: Tags an image to a registry. +Function: Tags an image into a registry. -Parameter description: +Parameters: -**-f** or **--force=false**: Forcibly replaces the original image when the same tag name exists. +**-f** or **--force=false**: Forcibly replaces the original image when the tag names are the same. Example: diff --git a/docs/en/docs/Container/installation-and-deployment-1.md b/docs/en/docs/Container/installation-and-deployment-1.md index fc7f9f9add7f8efce8ea207abc9b81a383bd427b..73542755435915b4e80869e66e52dd19b76463ea 100644 --- a/docs/en/docs/Container/installation-and-deployment-1.md +++ b/docs/en/docs/Container/installation-and-deployment-1.md @@ -1,19 +1,18 @@ # Installation and Deployment -- [Installation and Deployment](#installation-and-deployment-1) - - [Installation Methods](#installation-methods-26) - - [Deployment Configuration](#deployment-configuration-27) - - [Configuring the Docker Engine](#configuring-the-docker-engine) - - [iSulad Configuration](#isulad-configuration) - - [Configuration.toml](#configuration-toml) +- [Installation and Deployment](#installation-and-deployment) + - [Installation Methods](#installation-methods) + - [Deployment Configuration](#deployment-configuration) ## Installation Methods ### Prerequisites -- For better performance experience, a secure container needs to run on the bare metal server and must not run on VMs. -- A secure container depends on the following components \(openEuler 1.0 version\). Ensure that the required components have been installed in the environment. To install iSulad, refer to [Installation Methods](#installation-methods.md). + +- **root** permissions are required for installing a secure container. +- For better performance, a secure container needs to run on the bare metal server and **must not run on VMs**. +- A secure container depends on the following components from the corresponding openEuler version. Ensure that the required components have been installed in the environment. To install iSulad, refer to [Installation Methods](#installation-methods.md). - docker-engine - qemu diff --git a/docs/en/docs/Container/managing-the-lifecycle-of-a-secure-container.md b/docs/en/docs/Container/managing-the-lifecycle-of-a-secure-container.md index c16a2ee9a8a087af3d2b3643aba0a162d85f8b2a..7db446e38f162a73e4e520991c44390c7f01fccf 100644 --- a/docs/en/docs/Container/managing-the-lifecycle-of-a-secure-container.md +++ b/docs/en/docs/Container/managing-the-lifecycle-of-a-secure-container.md @@ -16,7 +16,7 @@ You can use the Docker engine or iSulad as the container engine of the secure co To start a secure container, perform the following steps: 1. Ensure that the secure container component has been correctly installed and deployed. -2. Prepare the container image. If the container image is busybox, run the following commands to download the container image using the Docker engine or iSulad: +2. Prepare the container image. Assume that the container image is **busybox**. Run the following commands to download the container image using the Docker engine or iSulad: ``` docker pull busybox @@ -26,7 +26,7 @@ To start a secure container, perform the following steps: isula pull busybox ``` -3. Start a secure container. Run the following commands to start a secure container using the Docker engine and iSulad: +3. Start a secure container. Run the following commands to start a secure container using the Docker engine or iSulad: ``` docker run -tid --runtime kata-runtime --network none busybox @@ -37,10 +37,10 @@ To start a secure container, perform the following steps: ``` >![](./public_sys-resources/icon-note.gif) **NOTE:** - >The secure container supports the CNI network only and does not support the CNM network. The **-p** and **--expose** options cannot be used to expose container ports. When using a secure container, you need to specify the **--net=none** option. + >The secure container supports the CNI network only and does not support the CNM network. The **-p** and **--expose** options cannot be used to expose container ports. When using a secure container, you need to specify the **--net=none** option. 4. Start a pod. - 1. Start the pause container and obtain the sandbox ID of the pod based on the command output. Run the following commands to start a pause container using the Docker engine and iSulad: + 1. Start the pause container and obtain the sandbox ID of the pod based on the command output. Run the following commands to start a pause container using the Docker engine or iSulad: ``` docker run -tid --runtime kata-runtime --network none --annotation io.kubernetes.docker.type=podsandbox @@ -52,7 +52,7 @@ To start a secure container, perform the following steps:    - 1. Create a service container and add it to the pod. Run the following commands to create a service container using the Docker engine and iSulad: + 1. Create a service container and add it to the pod. Run the following commands to create a service container using the Docker engine or iSulad: ``` docker run -tid --runtime kata-runtime --network none --annotation io.kubernetes.docker.type=container --annotation io.kubernetes.sandbox.id= busybox @@ -62,7 +62,7 @@ To start a secure container, perform the following steps: isula run -tid --runtime kata-runtime --network none --annotation io.kubernetes.cri.container-type=container --annotation io.kubernetes.cri.sandbox-id= busybox ``` - **--annotation** is used to mark the container type, which is provided by the Docker engine and iSulad, but not provided by the open-source Docker engine in the upstream community. + **--annotation** is used to mark the container type, which is provided by the Docker engine and iSulad, but is not provided by the open-source Docker engine in the upstream community. @@ -81,27 +81,24 @@ To start a secure container, perform the following steps: ## Deleting a Secure Container -Ensure that the container has been stopped. - +Ensure that the container has been stopped. Run the following command to delete the container: ``` docker rm ``` -To forcibly delete a running container, run the **-f** command. - +To forcibly delete a running container, use the **-f** option: ``` docker rm -f ``` ## Running a New Command in the Container -The pause container functions only as a placeholder container. Therefore, if you start a pod, run a new command in the service container. The pause container does not execute the corresponding command. If only one container is started, run the following command directly: - +The pause container functions only as a placeholder container. Therefore, after a pod is started, run the new command in the service container. The pause container does not execute the corresponding command. If you need to start only one container, you can run the following command: ``` docker exec -ti ``` >![](./public_sys-resources/icon-note.gif) **NOTE:** ->1. If the preceding command has no response because another host runs the **docker restart** or **docker stop** command to access the same container, you can press **Ctrl**+**P**+**Q** to exit the operation. ->2. If the **-d** option is used, the command is executed in the background and no error information is displayed. The exit code cannot be used to determine whether the command is executed correctly. +>1. If the preceding command has no response because another host is running the **docker restart** or **docker stop** command to access the same container, you can press **Ctrl**+**P**+**Q** to exit the operation. +>2. If the **-d** option is used, the command is executed in the background and no error information is displayed. The exit code cannot be used to determine whether the command is executed correctly. diff --git a/docs/en/docs/desktop/DDE-User-Manual.md b/docs/en/docs/desktop/DDE-user-guide.md old mode 100755 new mode 100644 similarity index 99% rename from docs/en/docs/desktop/DDE-User-Manual.md rename to docs/en/docs/desktop/DDE-user-guide.md index 9f2c87632b6c7ca15e79ef39e5d8295272053e56..7406b3896136c6b2a3bc2b5b0410fe1e92cc2e8a --- a/docs/en/docs/desktop/DDE-User-Manual.md +++ b/docs/en/docs/desktop/DDE-user-guide.md @@ -1,6 +1,6 @@ -# DDE Desktop Environment User Manual +# DDE Desktop Environment [[toc]] ## Overview DDE desktop environment is an elegant, secure, reliable and easy to use GUI comprised of the desktop, dock, launcher and control center. Acting as the key basis for our operating system, its main interface is shown as below. @@ -17,7 +17,7 @@ When you enter DDE for the very first time, a welcome program will automatically ## Desktop -Desktop is the main screen you see after logging in. On the desktop, you can create a new file/folder, sort files, open in terminal, set wallpaper and screensaver and etc. You can also add shortcuts for applications on desktop by using [Send to desktop](#Set App Shortcut). +Desktop is the main screen you see after logging in. On the desktop, you can create a new file/folder, sort files, open in terminal, set wallpaper and screensaver and etc. You can also add shortcuts for applications on desktop by using [Send to desktop](#set-app-shortcut). ![0|contextmenu](./figures/41.png) diff --git a/docs/en/docs/desktop/install-DDE.md b/docs/en/docs/desktop/installing-DDE.md similarity index 96% rename from docs/en/docs/desktop/install-DDE.md rename to docs/en/docs/desktop/installing-DDE.md index 05a05125a3867f2b12897901f08bcddad9a24274..82388f86224263a18981c07fbae2d3fa290a4c8f 100644 --- a/docs/en/docs/desktop/install-DDE.md +++ b/docs/en/docs/desktop/installing-DDE.md @@ -1,31 +1,31 @@ -# DDE installation -#### Introduction - -DDE is a powerful desktop environment developed by UnionTech Team. Contains dozens of powerful desktop applications, which are truly self-developed desktop products. - -#### installation method - -1. [download](https://openeuler.org/zh/download/) openEuler ISO and install the OS. -2. update the software source -```bash -sudo dnf update -``` -3. install DDE -```bash -sudo dnf install dde -``` -4. set to start with a graphical interface -```bash -sudo systemctl set-default graphical.target -``` -5. reboot -```bash -sudo reboot -``` -6. After the restart is complete, use the user created during the installation process or the openeuler user to log in to the desktop. - - > dde cannot log in with root account - > dde has built-in openeuler user, the password of this user is openeuler - -Now you can use dde. - +# DDE installation +#### Introduction + +DDE is a powerful desktop environment developed by UnionTech Team. Contains dozens of powerful desktop applications, which are truly self-developed desktop products. + +#### installation method + +1. [download](https://openeuler.org/zh/download/) openEuler ISO and install the OS. +2. update the software source +```bash +sudo dnf update +``` +3. install DDE +```bash +sudo dnf install dde +``` +4. set to start with a graphical interface +```bash +sudo systemctl set-default graphical.target +``` +5. reboot +```bash +sudo reboot +``` +6. After the restart is complete, use the user created during the installation process or the openeuler user to log in to the desktop. + + > dde cannot log in with root account + > dde has built-in openeuler user, the password of this user is openeuler + +Now you can use dde. + diff --git a/docs/en/docs/desktop/install-UKUI.md b/docs/en/docs/desktop/installing-UKUI.md similarity index 97% rename from docs/en/docs/desktop/install-UKUI.md rename to docs/en/docs/desktop/installing-UKUI.md index da9c6af33e5fbcfb430168fd83ffd6f06ece42ba..4d60b1763be87546fed1a062e07a43fb6a262642 100644 --- a/docs/en/docs/desktop/install-UKUI.md +++ b/docs/en/docs/desktop/installing-UKUI.md @@ -1,21 +1,21 @@ -# UKUI installation -UKUI is a Linux desktop built by the KylinSoft software team over the years, primarily based on GTK and QT. Compared to other UI interfaces, UKUI is easy to use. The components of UKUI are small and low coupling, can run alone without relying on other suites. It can provide user a friendly and efficient experience. - -UKUI supports both x86_64 and aarch64 architectures. - -We recommend you create a new administrator user before install UKUI. - -1.download openEuler 20.03 LTS SP1 and update the software source. -``` -sudo dnf update -``` -2.install UKUI. -``` -sudo dnf install ukui -``` -3.If you want to start with graphical interface after confirming the installation, please run this code and reboot(`reboot`). -``` -systemctl set-default graphical.target -``` -At present, UKUI version is still constantly updated. Please check the latest installation method : -[https://gitee.com/openkylin/ukui-issues](https://gitee.com/openkylin/ukui-issues) +# UKUI installation +UKUI is a Linux desktop built by the KylinSoft software team over the years, primarily based on GTK and QT. Compared to other UI interfaces, UKUI is easy to use. The components of UKUI are small and low coupling, can run alone without relying on other suites. It can provide user a friendly and efficient experience. + +UKUI supports both x86_64 and aarch64 architectures. + +We recommend you create a new administrator user before install UKUI. + +1.download openEuler 20.03 LTS SP1 and update the software source. +``` +sudo dnf update +``` +2.install UKUI. +``` +sudo dnf install ukui +``` +3.If you want to start with graphical interface after confirming the installation, please run this code and reboot(`reboot`). +``` +systemctl set-default graphical.target +``` +At present, UKUI version is still constantly updated. Please check the latest installation method : +[https://gitee.com/openkylin/ukui-issues](https://gitee.com/openkylin/ukui-issues) diff --git a/docs/en/menu/index.md b/docs/en/menu/index.md index 6677cb7b29c21b4ced07ca53ab793d587d93f9b0..7b14344ddfbbee611af7df41fbe65516f190943a 100644 --- a/docs/en/menu/index.md +++ b/docs/en/menu/index.md @@ -114,16 +114,17 @@ headless: true - [Monitoring Secure Containers]({{< relref "./docs/Container/monitoring-secure-containers.md" >}}) - [Appendix]({{< relref "./docs/Container/appendix-2.md" >}}) - [Docker Container]({{< relref "./docs/Container/docker-container.md" >}}) - - [Installation and Deployment]({{< relref "./docs/Container/installation-and-deployment-2.md" >}}) + - [Installation and Deployment]({{< relref "./docs/Container/installation-and-deployment-1.md" >}}) - [Container Management]({{< relref "./docs/Container/container-management-1.md" >}}) - [Image Management]({{< relref "./docs/Container/image-management-1.md" >}}) - [Command Reference]({{< relref "./docs/Container/command-reference.md" >}}) - [Container Engine]({{< relref "./docs/Container/container-engine.md" >}}) - [Container Management]({{< relref "./docs/Container/container-management-2.md" >}}) - - [Image Management]({{< relref "./docs/Container/image-management-2.md" >}}) + - [Image Management]({{< relref "./docs/Container/image-management-4.md" >}}) - [Statistics]({{< relref "./docs/Container/statistics.md" >}}) - - [Image Building]({{< relref "./docs/Container/isula-build.md" >}}) - - [Container Migration]({{< relref "./docs/Container/isula-transform.md" >}}) + - [Container Tools]({{< relref "./docs/Container/container-tools.md" >}}) + - [Image Building]({{< relref "./docs/Container/isula-build.md" >}}) + - [Container Migration]({{< relref "./docs/Container/isula-transform.md" >}}) - [A-Tune User Guide]({{< relref "./docs/A-Tune/A-Tune.md" >}}) - [Getting to Know A-Tune]({{< relref "./docs/A-Tune/getting-to-know-a-tune.md" >}}) - [Installation and Deployment]({{< relref "./docs/A-Tune/installation-and-deployment.md" >}}) @@ -142,9 +143,9 @@ headless: true - [Guide to Porting Spring Framework to openEuler]({{< relref "./docs/thirdparty_migration/springframework.md" >}}) - [Desktop Environment User Guide]({{< relref "./docs/desktop/desktop.md" >}}) - [UKUI]({{< relref "./docs/desktop/ukui.md" >}}) - - [Installation UKUI]({{< relref "./docs/desktop/install-UKUI.md" >}}) + - [Installation UKUI]({{< relref "./docs/desktop/installing-UKUI.md" >}}) - [UKUI User Guide]({{< relref "./docs/desktop/UKUI-user-guide.md" >}}) - [DDE]({{< relref "./docs/desktop/dde.md" >}}) - - [install-DDE]({{< relref "./docs/desktop/install-DDE.md" >}}) - - [DDE User Guide]({{< relref "./docs/desktop/DDE-User-Manual.md" >}}) + - [install-DDE]({{< relref "./docs/desktop/installing-DDE.md" >}}) + - [DDE User Guide]({{< relref "./docs/desktop/DDE-user-guide.md" >}}) - [HA User Guide]({{< relref "./docs/desktop/HAuserguide.md" >}}) \ No newline at end of file