big-data/hadoop
big-data/hadoop
1
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

YARN-8801. Fixed header comments for docker utility functions.

Browse Source 
Contributed by Zian Chen
This commit is contained in:
Eric Yang 2018-09-20 13:08:59 -04:00
parent 429a07e08c
commit aa4bd493c3
1 changed files with 10 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
hadoop-yarn-project/hadoop-yarn/hadoop-yarn-server/hadoop-yarn-server-nodemanager/src/main/native/container-executor/impl/utils/docker-util.h
View File

@ -81,8 +81,7 @@ char *get_docker_binary(const struct configuration *conf);
* Get the Docker command line string. The function will inspect the params file to determine the command to be run. * Get the Docker command line string. The function will inspect the params file to determine the command to be run.
* @param command_file File containing the params for the Docker command * @param command_file File containing the params for the Docker command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the Docker command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_command(const char* command_file, const struct configuration* conf, args *args);
@ -98,8 +97,7 @@ int get_use_entry_point_flag();
* inspect command. * inspect command.
* @param command_file File containing the params for the Docker inspect command * @param command_file File containing the params for the Docker inspect command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the inspect command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_inspect_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_inspect_command(const char* command_file, const struct configuration* conf, args *args);
@ -108,8 +106,7 @@ int get_docker_inspect_command(const char* command_file, const struct configurat
* Get the Docker load command line string. The function will verify that the params file is meant for the load command. * Get the Docker load command line string. The function will verify that the params file is meant for the load command.
* @param command_file File containing the params for the Docker load command * @param command_file File containing the params for the Docker load command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the load command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_load_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_load_command(const char* command_file, const struct configuration* conf, args *args);
@ -118,8 +115,7 @@ int get_docker_load_command(const char* command_file, const struct configuration
* Get the Docker pull command line string. The function will verify that the params file is meant for the pull command. * Get the Docker pull command line string. The function will verify that the params file is meant for the pull command.
* @param command_file File containing the params for the Docker pull command * @param command_file File containing the params for the Docker pull command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the pull command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_pull_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_pull_command(const char* command_file, const struct configuration* conf, args *args);
@ -128,8 +124,7 @@ int get_docker_pull_command(const char* command_file, const struct configuration
* Get the Docker rm command line string. The function will verify that the params file is meant for the rm command. * Get the Docker rm command line string. The function will verify that the params file is meant for the rm command.
* @param command_file File containing the params for the Docker rm command * @param command_file File containing the params for the Docker rm command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the rm command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_rm_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_rm_command(const char* command_file, const struct configuration* conf, args *args);
@ -138,8 +133,7 @@ int get_docker_rm_command(const char* command_file, const struct configuration*
* Get the Docker run command line string. The function will verify that the params file is meant for the run command. * Get the Docker run command line string. The function will verify that the params file is meant for the run command.
* @param command_file File containing the params for the Docker run command * @param command_file File containing the params for the Docker run command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the run command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_run_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_run_command(const char* command_file, const struct configuration* conf, args *args);
@ -148,8 +142,7 @@ int get_docker_run_command(const char* command_file, const struct configuration*
* Get the Docker stop command line string. The function will verify that the params file is meant for the stop command. * Get the Docker stop command line string. The function will verify that the params file is meant for the stop command.
* @param command_file File containing the params for the Docker stop command * @param command_file File containing the params for the Docker stop command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the stop command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_stop_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_stop_command(const char* command_file, const struct configuration* conf, args *args);
@ -158,8 +151,7 @@ int get_docker_stop_command(const char* command_file, const struct configuration
* Get the Docker kill command line string. The function will verify that the params file is meant for the kill command. * Get the Docker kill command line string. The function will verify that the params file is meant for the kill command.
* @param command_file File containing the params for the Docker kill command * @param command_file File containing the params for the Docker kill command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the kill command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_kill_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_kill_command(const char* command_file, const struct configuration* conf, args *args);
@ -169,8 +161,7 @@ int get_docker_kill_command(const char* command_file, const struct configuration
* params file is meant for the volume command. * params file is meant for the volume command.
* @param command_file File containing the params for the Docker volume command * @param command_file File containing the params for the Docker volume command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the volume command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_volume_command(const char *command_file, const struct configuration *conf, args *args); int get_docker_volume_command(const char *command_file, const struct configuration *conf, args *args);
@ -179,8 +170,7 @@ int get_docker_volume_command(const char *command_file, const struct configurati
* Get the Docker start command line string. The function will verify that the params file is meant for the start command. * Get the Docker start command line string. The function will verify that the params file is meant for the start command.
* @param command_file File containing the params for the Docker start command * @param command_file File containing the params for the Docker start command
* @param conf Configuration struct containing the container-executor.cfg details * @param conf Configuration struct containing the container-executor.cfg details
* @param out Buffer to fill with the start command * @param args Buffer to construct argv
* @param outlen Size of the output buffer
* @return Return code with 0 indicating success and non-zero codes indicating error * @return Return code with 0 indicating success and non-zero codes indicating error
*/ */
int get_docker_start_command(const char* command_file, const struct configuration* conf, args *args); int get_docker_start_command(const char* command_file, const struct configuration* conf, args *args);