xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-06-23 14:35:38 +00:00
Code Issues Releases Wiki Activity

Merge pull request #6324 from gurevichmark/remove_docker_docs

Browse Source 
Remove docker man pages
This commit is contained in:
zet809
2019-05-22 10:13:35 +08:00
committed by GitHub
parent 2285bf6150 7b4f221740
commit d9d99d3396
10 changed files with 4 additions and 575 deletions
Download Patch File Download Diff File Expand all files Collapse all files

102
docs/source/guides/admin-guides/references/man1/lsdocker.1.rst
View File

@ -1,102 +0,0 @@
##########
lsdocker.1
##########
.. highlight:: perl
****
NAME
****
\ **lsdocker**\ - List docker instance.
********
SYNOPSIS
********
\ **lsdocker**\ \ *noderange*\ [\ **-l | -**\ **-logs**\ ]
\ **lsdocker**\ \ *dockerhost*\
\ **lsdocker**\ [\ **-h | -**\ **-help**\ ]
\ **lsdocker**\ {\ **-v | -**\ **-version**\ }
***********
DESCRIPTION
***********
\ **lsdocker**\ To list docker instance info or all the running docker instance info if dockerhost is specified.
*******
OPTIONS
*******
\ **-l|-**\ **-logs**\
To return the logs of docker instance. Only works for docker instance.
********
EXAMPLES
********
1. To get info for docker instance "host01c01"
.. code-block:: perl
lsdocker host01c01
Output is similar to:
.. code-block:: perl
host01c01: 50800dfd8b5f ubuntu /bin/bash 2016-01-13T06:32:59 running /host01c01
2. To get info for running docker instance on dockerhost "host01"
.. code-block:: perl
lsdocker host01
Output is similar to:
.. code-block:: perl
host01: 50800dfd8b5f ubuntu /bin/bash 2016-1-13 - 1:32:59 Up 12 minutes /host01c01
host01: 875ce11d5987 ubuntu /bin/bash 2016-1-21 - 1:12:37 Up 5 seconds /host01c02
********
SEE ALSO
********
mkdocker(1)|mkdocker.1, rmdocker(1)|rmdocker.1

169
docs/source/guides/admin-guides/references/man1/mkdocker.1.rst
View File

@ -1,169 +0,0 @@
##########
mkdocker.1
##########
.. highlight:: perl
****
NAME
****
\ **mkdocker**\ - Create docker instance.
********
SYNOPSIS
********
\ **mkdocker**\ \ *noderange*\ [\ **image**\ =\ *image_name*\ [\ **command**\ =\ *command*\ ]] [\ **dockerflag**\ =\ *flags_to_create_instance*\ ]
\ **mkdocker**\ [\ **-h | -**\ **-help**\ ]
\ **mkdocker**\ {\ **-v | -**\ **-version**\ }
***********
DESCRIPTION
***********
\ **mkdocker**\ To create docker instances with the specified image, command and/or dockerflags.
*******
OPTIONS
*******
\ **image**\
The docker image name that the instance will use.
\ **command**\
The command that the instance will run based on the \ **image**\ specified. The \ **image**\ option must be specified in order to use this option.
\ **dockerflag**\
A JSON string which will be used as parameters to create a docker. Reference https://docs.docker.com/engine/reference/api/docker_remote_api_v1.22/ for more information about which parameters can be specified.
Some useful flags are:
\ **AttachStdin**\ =\ **true | false**\
Whether attaches to stdin.
\ **AttachStdout**\ =\ **true | false**\
Whether attaches to stdout.
\ **AttachStderr**\ =\ **true | false**\
Whether attaches to stderr.
\ **OpenStdin**\ =\ **true | false**\
Whether opens stdin.
\ **Tty**\ =\ **true | false**\
Attach standard streams to a tty, including stdin if it is not closed.
\ **ExposedPorts**\
An object mapping ports to an empty object in the form of:
.. code-block:: perl
"ExposedPorts": { "<port>/\<tcp|udp>: {}" }
\ **HostConfig: {"Binds"}**\
A list of volume bindings for this docker instance, the form will be:
.. code-block:: perl
"HostConfig": {"Binds":["<dir_on_dockerhost>:<dir_in_instance>"]}
********
EXAMPLES
********
1. To create a basic docker instance with stdin opened
.. code-block:: perl
mkdocker host01c01 image=ubuntu command=/bin/bash dockerflag="{\"AttachStdin\":true,\"AttachStdout\":true,\"AttachStderr\":true,\"OpenStdin\":true}"
Output is similar to:
.. code-block:: perl
host01c01: Pull image ubuntu start
host01c01: Pull image ubuntu done
host01c01: Remove default network connection
host01c01: Connecting customized network 'mynet0'
host01c01: success
2. To create a docker instance which have dir "destdir" in docker instance bind from "srcdir" on dockerhost, and have "Tty" opened with which the docker instance can be attached after started to check the files under "destdir".
.. code-block:: perl
mkdocker host01c01 image=ubuntu command=/bin/bash dockerflag="{\"AttachStdin\":true,\"AttachStdout\":true,\"AttachStderr\":true,\"OpenStdin\":true,\"Tty\":true,\"HostConfig\":{\"Binds\":[\"/srcdir:/destdir\"]}}"
Output is similar to:
.. code-block:: perl
host01c01: Remove default network connection
host01c01: Connecting customized network 'mynet0'
host01c01: success
********
SEE ALSO
********
rmdocker(1)|rmdocker.1, lsdocker(1)|lsdocker.1

4
docs/source/guides/admin-guides/references/man1/rflash.1.rst
View File

@ -63,7 +63,7 @@ OpenPOWER OpenBMC specific :
\ **rflash**\ \ *noderange*\ \ *tar_file_path*\ {[\ **-c | -**\ **-check**\ ] | [\ **-a | -**\ **-activate**\ ] | [\ **-u | -**\ **-upload**\ ]}
\ **rflash**\ \ *noderange*\ \ *tar_file_directory*\ [\ **-d**\ ] [\ **-**\ **-no-host-reboot**\ ]
\ **rflash**\ \ *noderange*\ \ *tar_file_directory*\ [\ **-d**\ ]
\ **rflash**\ \ *noderange*\ \ *image_id*\ {[\ **-a | -**\ **-activate**\ ] | [\ **-**\ **-delete**\ ]}
@ -172,8 +172,6 @@ To apply the firmware level, a reboot is required to BMC and HOST.
This option steamlines the update, activate, reboot BMC and reboot HOST procedure. It expects a directory containing both BMC and Host .tar files. When BMC and Host tar files are provided, the command will upload and activate firmware. After BMC becomes activate, it will reboot BMC. If BMC state is Ready, the command will reboot the HOST. If BMC state is NotReady, the command will exit.
\ **Note:**\ When using \ **-**\ **-no-host-reboot**\ , it will not reboot the host after BMC is reboot.
\ **-**\ **-delete**\ :
This delete option will delete update image from BMC. It expects an ID as the input.

62
docs/source/guides/admin-guides/references/man1/rmdocker.1.rst
View File

@ -1,62 +0,0 @@
##########
rmdocker.1
##########
.. highlight:: perl
********
SYNOPSIS
********
\ **rmdocker**\ \ *noderange*\ [\ **-f | -**\ **-force**\ ]
\ **rmdocker**\ [\ **-h | -**\ **-help**\ ]
\ **rmdocker**\ {\ **-v | -**\ **-version**\ }
***********
DESCRIPTION
***********
\ **rmdocker**\ To remove docker instances with the specified node name
*******
OPTIONS
*******
\ **-f|-**\ **-force**\
Force to removal of a running container or failed to disconnect customized network
********
EXAMPLES
********
.. code-block:: perl
rmdocker host01c01
host01c01: Disconnect customized network 'mynet0' done
host01c01: success
********
SEE ALSO
********
mkdocker(1)|mkdocker.1, lsdocker(1)|lsdocker.1

25
docs/source/guides/admin-guides/references/man1/rpower.1.rst
View File

@ -120,13 +120,6 @@ zVM specific:
\ **rpower**\ \ *noderange*\ [\ **on | off | reset | stat | softoff**\ ]
docker specific:
================
\ **rpower**\ \ *noderange*\ [\ **start | stop | restart | pause | unpause | state**\ ]
pdu specific:
=============
@ -350,24 +343,6 @@ OPTIONS
\ **start**\
To start a created docker instance.
\ **stop**\
To stop a created docker instance.
\ **restart**\
To restart a created docker instance.
\ **pause**\
To pause all processes in the instance.

7
docs/source/guides/admin-guides/references/man5/site.5.rst
View File

@ -465,10 +465,9 @@ site Attributes:
xcatlport: The port used by xcatd command log writer process to collect command output.
xcatsslversion: The SSL_version option xcatd used and passed to
IO::Socket::SSL->start_SSL(). By default, this value is
set to empty. In this case, xcatd will use
'SSLv23:!SSLv2:!SSLv3:!TLSv1' internally.
xcatsslversion: This is the SSL_version option xcatd used and passed to
IO::Socket::SSL->start_SSL(). By default, this value is set to empty.
In this case, xcatd will use SSLv23:!SSLv2:!SSLv3:!TLSv1 internally.
For more detail, see https://metacpan.org/pod/IO::Socket::SSL
xcatsslciphers: The ssl cipher by xcatd. Default is 3DES.

57
xCAT-client/pods/man1/lsdocker.1.pod
View File

@ -1,57 +0,0 @@
=head1 NAME
B<lsdocker> - List docker instance.
=head1 SYNOPSIS
B<lsdocker> I<noderange> [B<-l>|B<--logs>]
B<lsdocker> I<dockerhost>
B<lsdocker> [B<-h>|B<--help>]
B<lsdocker> {B<-v>|B<--version>}
=head1 DESCRIPTION
B<lsdocker> To list docker instance info or all the running docker instance info if dockerhost is specified.
=head1 OPTIONS
=over 3
=item B<-l|--logs>
=back
To return the logs of docker instance. Only works for docker instance.
=head1 EXAMPLES
=over 3
=item 1.
To get info for docker instance "host01c01"
lsdocker host01c01
Output is similar to:
host01c01: 50800dfd8b5f ubuntu /bin/bash 2016-01-13T06:32:59 running /host01c01
=item 2.
To get info for running docker instance on dockerhost "host01"
lsdocker host01
Output is similar to:
host01: 50800dfd8b5f ubuntu /bin/bash 2016-1-13 - 1:32:59 Up 12 minutes /host01c01
host01: 875ce11d5987 ubuntu /bin/bash 2016-1-21 - 1:12:37 Up 5 seconds /host01c02
=back
=head1 SEE ALSO
L<mkdocker(1)|mkdocker.1>, L<rmdocker(1)|rmdocker.1>

100
xCAT-client/pods/man1/mkdocker.1.pod
View File

@ -1,100 +0,0 @@
=head1 NAME
B<mkdocker> - Create docker instance.
=head1 SYNOPSIS
B<mkdocker> I<noderange> [B<image>=I<image_name> [B<command>=I<command>]] [B<dockerflag>=I<flags_to_create_instance>]
B<mkdocker> [B<-h>|B<--help>]
B<mkdocker> {B<-v>|B<--version>}
=head1 DESCRIPTION
B<mkdocker> To create docker instances with the specified image, command and/or dockerflags.
=head1 OPTIONS
=over 3
=item B<image>
The docker image name that the instance will use.
=item B<command>
The command that the instance will run based on the B<image> specified. The B<image> option must be specified in order to use this option.
=item B<dockerflag>
A JSON string which will be used as parameters to create a docker. Reference https://docs.docker.com/engine/reference/api/docker_remote_api_v1.22/ for more information about which parameters can be specified.
Some useful flags are:
=over 3
=item B<AttachStdin>=B<true>|B<false>
Whether attaches to stdin.
=item B<AttachStdout>=B<true>|B<false>
Whether attaches to stdout.
=item B<AttachStderr>=B<true>|B<false>
Whether attaches to stderr.
=item B<OpenStdin>=B<true>|B<false>
Whether opens stdin.
=item B<Tty>=B<true>|B<false>
Attach standard streams to a tty, including stdin if it is not closed.
=item B<ExposedPorts>
An object mapping ports to an empty object in the form of:
"ExposedPorts": { "<port>/\<tcp|udp>: {}" }
=item B<HostConfig: {"Binds"}>
A list of volume bindings for this docker instance, the form will be:
"HostConfig": {"Binds":["<dir_on_dockerhost>:<dir_in_instance>"]}
=back
=back
=head1 EXAMPLES
1. To create a basic docker instance with stdin opened
mkdocker host01c01 image=ubuntu command=/bin/bash dockerflag="{\"AttachStdin\":true,\"AttachStdout\":true,\"AttachStderr\":true,\"OpenStdin\":true}"
Output is similar to:
host01c01: Pull image ubuntu start
host01c01: Pull image ubuntu done
host01c01: Remove default network connection
host01c01: Connecting customized network 'mynet0'
host01c01: success
2. To create a docker instance which have dir "destdir" in docker instance bind from "srcdir" on dockerhost, and have "Tty" opened with which the docker instance can be attached after started to check the files under "destdir".
mkdocker host01c01 image=ubuntu command=/bin/bash dockerflag="{\"AttachStdin\":true,\"AttachStdout\":true,\"AttachStderr\":true,\"OpenStdin\":true,\"Tty\":true,\"HostConfig\":{\"Binds\":[\"/srcdir:/destdir\"]}}"
Output is similar to:
host01c01: Remove default network connection
host01c01: Connecting customized network 'mynet0'
host01c01: success
=head1 SEE ALSO
L<rmdocker(1)|rmdocker.1>, L<lsdocker(1)|lsdocker.1>

37
xCAT-client/pods/man1/rmdocker.1.pod
View File

@ -1,37 +0,0 @@
=head1 NAME
B<rmdocker> - Remove docker instance.
=head1 SYNOPSIS
B<rmdocker> I<noderange> [B<-f>|B<--force>]
B<rmdocker> [B<-h>|B<--help>]
B<rmdocker> {B<-v>|B<--version>}
=head1 DESCRIPTION
B<rmdocker> To remove docker instances with the specified node name
=head1 OPTIONS
=over 3
=item B<-f|--force>
=back
Force to removal of a running container or failed to disconnect customized network
=head1 EXAMPLES
rmdocker host01c01
host01c01: Disconnect customized network 'mynet0' done
host01c01: success
=head1 SEE ALSO
L<mkdocker(1)|mkdocker.1>, L<lsdocker(1)|lsdocker.1>

16
xCAT-client/pods/man1/rpower.1.pod
View File

@ -66,10 +66,6 @@ B<rpower> I<noderange> [B<on>|B<off>|B<reset>|B<boot>|B<reseat>]
B<rpower> I<noderange> [B<on>|B<off>|B<reset>|B<stat>|B<softoff>]
=head2 docker specific:
B<rpower> I<noderange> [B<start>|B<stop>|B<restart>|B<pause>|B<unpause>|B<state>]
=head2 pdu specific:
B<rpower> I<noderange> [B<stat>|B<off>|B<on>|B<reset>]
@ -227,18 +223,6 @@ To specify that the target node will be power down if B<suspend> action failed.
To specify that the target node will be reset if B<suspend> action failed.
=item B<start>
To start a created docker instance.
=item B<stop>
To stop a created docker instance.
=item B<restart>
To restart a created docker instance.
=item B<pause>
To pause all processes in the instance.