Fixes spell mistakes in Operations Guide
Operations Guide contains some formatting mistakes
in the following sections:
* Command line reference
* atop logs
* PostgreSQL database inconsistency
Change-Id: Ic78c4a910922e86fb17ab1ed237f6505d1716a95
Closes-Bug: 1420694
(cherry picked from commit f05c1d3069)
This commit is contained in:
committed by
Irina
parent
88ee475e7a
commit
3f6dc8ef0d
@@ -35,18 +35,18 @@ Below is a list of commands that are useful when managing LXC containers on the
|
||||
|
||||
Basic usage
|
||||
+++++++++++
|
||||
Get a list of available commands
|
||||
Get a list of available commands:
|
||||
::
|
||||
|
||||
docker help
|
||||
|
||||
|
||||
Get a list of all running containers
|
||||
Get a list of all running containers:
|
||||
::
|
||||
|
||||
docker ps
|
||||
|
||||
Get a list of all containers available
|
||||
Get a list of all containers available:
|
||||
::
|
||||
|
||||
docker ps -a
|
||||
@@ -55,7 +55,7 @@ Get a list of all containers available
|
||||
are usually in Exited state. Exited state means that the
|
||||
container exists, but no processes inside are running.
|
||||
|
||||
Start a new Docker container with specified commands.
|
||||
Start a new Docker container with the specified commands:
|
||||
::
|
||||
|
||||
docker run [options] imagename [command]
|
||||
@@ -67,7 +67,7 @@ This is useful for testing without impacting production containers.
|
||||
|
||||
docker run --rm -i -t fuel/postgres /bin/bash
|
||||
|
||||
Import a Docker image
|
||||
Import a Docker image:
|
||||
::
|
||||
|
||||
docker load -i (archivefile)
|
||||
@@ -75,7 +75,7 @@ Import a Docker image
|
||||
Loads in a Docker image in the following formats: .tar, .tar.gz, .tar.xz.
|
||||
lrz is not supported.
|
||||
|
||||
Save a Docker image to a file.
|
||||
Save a Docker image to a file:
|
||||
::
|
||||
|
||||
docker save image > image.tar
|
||||
@@ -83,49 +83,54 @@ Save a Docker image to a file.
|
||||
Dockerctl
|
||||
+++++++++
|
||||
|
||||
Build and run storage containers, then run application containers.
|
||||
Build and run storage containers, then run application containers:
|
||||
::
|
||||
|
||||
dockerctl build all
|
||||
|
||||
.. note:: This can take a few minutes, depending on your hardware
|
||||
.. note:: This can take a few minutes, depending on your hardware.
|
||||
|
||||
Launch a container from its image with the necessary options.
|
||||
If the container already exists,
|
||||
will ensure that this container is in a running state.
|
||||
will ensure that this container is in a running state:
|
||||
::
|
||||
|
||||
dockerctl start **appname** [--attach]
|
||||
dockerctl start <appname> [--attach]
|
||||
|
||||
Optionally, --attach can be used to monitor the process and view its stdout and
|
||||
Optionally, *--attach* option can be used to monitor the process and view its stdout and
|
||||
stderr.
|
||||
|
||||
|
||||
Display the entire container log for /app/. Useful for troubleshooting.
|
||||
Display the entire container log for /app/. Useful for troubleshooting:
|
||||
::
|
||||
|
||||
dockerctl logs **appname**
|
||||
dockerctl logs <appname>
|
||||
|
||||
Stop or restart a container
|
||||
Stop or restart a container:
|
||||
::
|
||||
|
||||
dockerctl stop|restart **appname**
|
||||
dockerctl stop|restart <appname>
|
||||
|
||||
Create a shell or run a command.
|
||||
Create a shell or run a command:
|
||||
::
|
||||
|
||||
dockerctl shell **appname** [command]
|
||||
dockerctl shell <appname> [command]
|
||||
|
||||
.. note:: The container must be running first in order to use this feature.
|
||||
Additionally, quotes must be escaped if your command requires them.
|
||||
|
||||
Stop and destroy a container
|
||||
Stop and destroy a container:
|
||||
::
|
||||
|
||||
dockerctl destroy **appname**
|
||||
dockerctl destroy <appname>
|
||||
|
||||
.. note:: This is not reversible, so use with caution.
|
||||
|
||||
Find containets names by running:
|
||||
::
|
||||
|
||||
dockerctl list
|
||||
|
||||
.. _fuel-docker-changes:
|
||||
|
||||
System changes for Docker affecting Fuel 5.0 and later
|
||||
|
||||
@@ -216,7 +216,7 @@ The implementation is:
|
||||
|
||||
To view the **atop** data,
|
||||
run the `atop(1) <http://manpages.ubuntu.com/manpages/utopic/man1/atop.1.html>`_
|
||||
command on the shell of the node you are analyzing.
|
||||
command on the shell of the node you are analyzing:
|
||||
|
||||
::
|
||||
|
||||
|
||||
@@ -187,7 +187,7 @@ You may want to make a PostgreSQL backup at this point:
|
||||
To recover a corrupted PostgreSQL database,
|
||||
you can import the dump to another PostgreSQL installation,
|
||||
where you can get a clean dump
|
||||
that you then import to your PostgreSQL container.
|
||||
that you then import to your PostgreSQL container:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
|
||||
Reference in New Issue
Block a user