[Fuego] [PATCH] ssh: document the SSH_KEY variable

[Bird, Timothy]

> -----Original Message-----
> From: fuego-bounces at lists.linuxfoundation.org [mailto:fuego-
> bounces at lists.linuxfoundation.org] On Behalf Of Daniel Sangorrin
> Sent: Thursday, December 21, 2017 7:03 PM
> To: fuego at lists.linuxfoundation.org
> Subject: [Fuego] [PATCH] ssh: document the SSH_KEY variable
> 
> The documentation should also probably go to the wiki.

I added some documentation to the wiki, on the following pages:
http://fuegotest.org/wiki/Adding_a_board
and
http://fuegotest.org/wiki/Test_variables

> I have added a commented definition for each board file
> just for the users to notice that they can login without
> password.
> 
> Signed-off-by: Daniel Sangorrin <daniel.sangorrin at toshiba.co.jp>
> ---
>  docs/source/board_config.tex            | 1 +
>  fuego-ro/boards/bbb.board               | 1 +
>  fuego-ro/boards/beaglebone-serial.board | 1 +
>  fuego-ro/boards/docker.board            | 1 +
>  fuego-ro/boards/lager.board             | 1 +
>  fuego-ro/boards/minnow.board            | 1 +
>  fuego-ro/boards/qemu-arm.board          | 1 +
>  fuego-ro/boards/raspberrypi3.board      | 1 +
>  fuego-ro/boards/template-dev.board      | 1 +
>  9 files changed, 9 insertions(+)
> 
> diff --git a/docs/source/board_config.tex b/docs/source/board_config.tex
> index 8fc1145..3e247e6 100644
> --- a/docs/source/board_config.tex
> +++ b/docs/source/board_config.tex
> @@ -25,6 +25,7 @@ The following is the step-by-step description of all
> mandatory environment varia
>  \item[\texttt{SSH\_PORT}:]  ssh port number of board;
>  \item[\texttt{LOGIN}:]  user name for ssh login;
>  \item[\texttt{PASSWORD}:] password for ssh login;
> +\item[\texttt{SSH_KEY}:] path to ssh private key for login in without
> PASSWORD;
>  \item[\texttt{FUEGO\_HOME}:] path to the directory on device the tests will
> run from;
>  \item[\texttt{PLATFORM}:] architecture of the board.
>    Currently \texttt{ia32}, \texttt{arm} and \texttt{mips} are supported. Used
> by some of tests during compilation.
> diff --git a/fuego-ro/boards/bbb.board b/fuego-ro/boards/bbb.board
> index 793d38a..96275a9 100644
> --- a/fuego-ro/boards/bbb.board
> +++ b/fuego-ro/boards/bbb.board
> @@ -6,6 +6,7 @@ SRV_IP="192.168.7.1"
>  LOGIN="root"
>  BOARD_TESTDIR="/home/a"
>  PASSWORD="root"
> +#SSH_KEY="path/to/id_rsa"
>  PLATFORM="emdebian-armhf"
>  TRANSPORT="ssh"
>  ARCHITECTURE="arm"
> diff --git a/fuego-ro/boards/beaglebone-serial.board b/fuego-
> ro/boards/beaglebone-serial.board
> index 1237e71..7dc53c2 100644
> --- a/fuego-ro/boards/beaglebone-serial.board
> +++ b/fuego-ro/boards/beaglebone-serial.board
> @@ -7,6 +7,7 @@ BAUD="115200"
>  LOGIN="root"
>  BOARD_TESTDIR="/home/a"
>  PASSWORD=""
> +#SSH_KEY="path/to/id_rsa"
>  PLATFORM="poky-qemuarm"
>  TRANSPORT="serial"
>  IO_TIME_SERIAL="0.1"
> diff --git a/fuego-ro/boards/docker.board b/fuego-ro/boards/docker.board
> index 55386fb..a25dfe5 100644
> --- a/fuego-ro/boards/docker.board
> +++ b/fuego-ro/boards/docker.board
> @@ -5,6 +5,7 @@ IPADDR="127.0.0.1"
>  SRV_IP="127.0.0.1"
>  #LOGIN="root"
>  #PASSWORD="root"
> +#SSH_KEY="path/to/id_rsa"
>  BOARD_TESTDIR="$FUEGO_RW/tests"
>  PLATFORM="x86_64"
>  TRANSPORT="local"
> diff --git a/fuego-ro/boards/lager.board b/fuego-ro/boards/lager.board
> index 519c00c..c359745 100644
> --- a/fuego-ro/boards/lager.board
> +++ b/fuego-ro/boards/lager.board
> @@ -7,6 +7,7 @@ SSH_PORT="22"
>  LOGIN="root"
>  BOARD_TESTDIR="/home/a"
>  PASSWORD=""
> +#SSH_KEY="path/to/id_rsa"
>  PLATFORM="lager"
>  TRANSPORT="ssh"
>  ARCHITECTURE="arm"
> diff --git a/fuego-ro/boards/minnow.board b/fuego-
> ro/boards/minnow.board
> index af8ceea..d5042cc 100644
> --- a/fuego-ro/boards/minnow.board
> +++ b/fuego-ro/boards/minnow.board
> @@ -4,6 +4,7 @@ include "base-params"
>  IPADDR="10.0.1.80"
>  LOGIN="root"
>  PASSWORD="fuego"
> +#SSH_KEY="path/to/id_rsa"
>  BOARD_TESTDIR="/home/fuego"
>  PLATFORM="x86_64"
>  TRANSPORT="ssh"
> diff --git a/fuego-ro/boards/qemu-arm.board b/fuego-ro/boards/qemu-
> arm.board
> index bebe571..caaebc9 100644
> --- a/fuego-ro/boards/qemu-arm.board
> +++ b/fuego-ro/boards/qemu-arm.board
> @@ -6,6 +6,7 @@ SSH_PORT=5555
>  LOGIN="root"
>  BOARD_TESTDIR="/home/a"
>  PASSWORD="adm"
> +#SSH_KEY="path/to/id_rsa"
>  PLATFORM="emdebian-armhf"
>  TRANSPORT="ssh"
>  ARCHITECTURE="arm"
> diff --git a/fuego-ro/boards/raspberrypi3.board b/fuego-
> ro/boards/raspberrypi3.board
> index 2681b40..b2e93be 100644
> --- a/fuego-ro/boards/raspberrypi3.board
> +++ b/fuego-ro/boards/raspberrypi3.board
> @@ -9,6 +9,7 @@ SRV_IP="10.0.0.40"
>  LOGIN="root"
>  BOARD_TESTDIR="/root/"
>  PASSWORD=""
> +#SSH_KEY="path/to/id_rsa"
>  PLATFORM="qemu-armv7hf"
>  TRANSPORT="ssh"
>  ARCHITECTURE="arm"
> diff --git a/fuego-ro/boards/template-dev.board b/fuego-
> ro/boards/template-dev.board
> index dbd7363..7ea0d43 100644
> --- a/fuego-ro/boards/template-dev.board
> +++ b/fuego-ro/boards/template-dev.board
> @@ -5,6 +5,7 @@ IPADDR="set_ip_here"
>  LOGIN="root"
>  BOARD_TESTDIR="/home/a"
>  PASSWORD=""
> +#SSH_KEY="path/to/id_rsa"
>  PLATFORM="set platform here (see tools.sh)"
>  TRANSPORT="ssh"
>  ARCHITECTURE="set_ia32_x86_64_or_arm_or_arm64_here"
> --
> 2.7.4

Accepted and pushed.
 -- Tim