diff --git a/README.rst b/README.rst index 5f94fb26b7..a3058081e0 100644 --- a/README.rst +++ b/README.rst @@ -129,7 +129,7 @@ Directories - ``contrib`` - Contains demos scenarios for Heat and Murano and a development environment for Vagrant - ``doc`` - Contains documentation. -- ``docker`` - Contains jinja2 templates for the docker build system. +- ``docker`` - Contains jinja2 templates for the Docker build system. - ``etc`` - Contains a reference etc directory structure which requires configuration of a small number of configuration variables to achieve a working All-in-One (AIO) deployment. diff --git a/doc/image-building.rst b/doc/image-building.rst index 0776c01998..8de57f4b7a 100644 --- a/doc/image-building.rst +++ b/doc/image-building.rst @@ -4,7 +4,7 @@ Building Container Images ========================= -The ``kolla-build`` command is responsible for building docker images. +The ``kolla-build`` command is responsible for building Docker images. .. note:: @@ -95,7 +95,7 @@ Or put following line to ``DEFAULT`` section in ``kolla-build.conf`` :: ``kolla-build`` uses ``kolla`` as default Docker namespace. This is -controlled with the ``-n`` command line option. To push images to a dockerhub +controlled with the ``-n`` command line option. To push images to a Dockerhub repository named ``mykollarepo``:: kolla-build -n mykollarepo --push @@ -130,7 +130,7 @@ The locations of OpenStack source code are written in Now the source type supports ``url``, ``git``, and ``local``. The location of the ``local`` source type can point to either a directory containing the source code or to a tarball of the source. The ``local`` source type permits to make -the best use of the docker cache. +the best use of the Docker cache. ``etc/kolla/kolla-build.conf`` looks like:: @@ -350,9 +350,9 @@ follows:: Known issues ============ -#. Can't build base image because docker fails to install systemd or httpd. +#. Can't build base image because Docker fails to install systemd or httpd. - There are some issues between docker and AUFS. The simple workaround to + There are some issues between Docker and AUFS. The simple workaround to avoid the issue is that add ``-s devicemapper`` or ``-s btrfs`` to ``DOCKER_OPTS``. Get more information about `the issue from the Docker bug tracker `_ and `how to @@ -394,7 +394,7 @@ Now the Docker registry service is running. Docker Insecure Registry Config ------------------------------- -For docker to pull images, it is necessary to modify the Docker configuration. +For Docker to pull images, it is necessary to modify the Docker configuration. The guide assumes that the IP of the machine running Docker registry is 172.22.2.81. @@ -404,7 +404,7 @@ to ``DOCKER_OPTS`` in ``/etc/default/docker``. In CentOS, uncomment ``INSECURE_REGISTRY`` and set ``INSECURE_REGISTRY`` to ``--insecure-registry 172.22.2.81:4000`` in ``/etc/sysconfig/docker``. -And restart the docker service. +And restart the Docker service. To build and push images to local registry, use the following command:: diff --git a/doc/kuryr-guide.rst b/doc/kuryr-guide.rst index 32101bb826..eb47ef87a7 100644 --- a/doc/kuryr-guide.rst +++ b/doc/kuryr-guide.rst @@ -14,7 +14,7 @@ Requirements Preparation and Deployment -------------------------- -To allow docker daemon connect to the etcd, add the following in the +To allow Docker daemon connect to the etcd, add the following in the docker.service file. :: diff --git a/doc/multinode.rst b/doc/multinode.rst index 6383da9d66..a95aecfdd4 100644 --- a/doc/multinode.rst +++ b/doc/multinode.rst @@ -53,7 +53,7 @@ Edit ``/etc/default/docker`` and add: DOCKER_OPTS="--insecure-registry 192.168.1.100:4000" If Ubuntu is using systemd, additional settings needs to be configured. -Copy docker's systemd unit file to ``/etc/systemd/system/`` directory: +Copy Docker's systemd unit file to ``/etc/systemd/system/`` directory: :: @@ -77,7 +77,7 @@ section: EnvironmentFile=-/etc/default/docker ExecStart=/usr/bin/docker daemon -H fd:// $DOCKER_OPTS -Restart docker by executing the following commands: +Restart Docker by executing the following commands: :: diff --git a/doc/quickstart.rst b/doc/quickstart.rst index fa427ea34c..0b99f1f44a 100644 --- a/doc/quickstart.rst +++ b/doc/quickstart.rst @@ -141,9 +141,9 @@ following command: curl -sSL https://get.docker.io | bash This command will install the most recent stable version of Docker, but please -note that Kolla releases are not in sync with docker in any way, so some things +note that Kolla releases are not in sync with Docker in any way, so some things could stop working with new version. The latest release of Kolla is tested to -work with docker-engine >= 1.10.0. To check your docker version run this +work with docker-engine >= 1.10.0. To check your Docker version run this command: :: @@ -155,7 +155,7 @@ in the Docker daemon to launch with. This means setting up the following information in the ``docker.service`` file. If you do not set the MountFlags option correctly then ``kolla-ansible`` will fail to deploy the ``neutron-dhcp-agent`` container and throws APIError/HTTPError. After adding -the drop-in unit file as follows, reload and restart the docker service: +the drop-in unit file as follows, reload and restart the Docker service: :: @@ -168,7 +168,7 @@ the drop-in unit file as follows, reload and restart the docker service: MountFlags=shared EOF -Restart docker by executing the following commands: +Restart Docker by executing the following commands: :: @@ -404,7 +404,7 @@ Kolla, but if running from master, it is recommended to build images locally. Checkout the :doc:`image-building` for more advanced build configuration. -Before running the below instructions, ensure the docker daemon is running +Before running the below instructions, ensure the Docker daemon is running or the build process will fail. To build images using default parameters run: :: @@ -513,7 +513,7 @@ veth pair is listed here and the other end is in a bridge on the system. :: neutron_external_interface: "eth1" -If using a local docker registry, set the ``docker_registry`` information where +If using a local Docker registry, set the ``docker_registry`` information where the local registry is operating on IP address 192.168.1.100 and the port 4000. :: @@ -651,7 +651,7 @@ Any time the tags of a release change, it is possible that the container implementation from older versions won't match the Ansible playbooks in a new version. If running multinode from a registry, each node's Docker image cache must be refreshed with the latest images before a new deployment can occur. To -refresh the docker cache from the local Docker registry: +refresh the Docker cache from the local Docker registry: :: diff --git a/doc/vagrant-dev-env.rst b/doc/vagrant-dev-env.rst index adb7888fae..527a2839ca 100644 --- a/doc/vagrant-dev-env.rst +++ b/doc/vagrant-dev-env.rst @@ -116,7 +116,7 @@ All nodes have a local folder shared between the group and the hypervisor, and a folder shared between **all** nodes and the hypervisor. This mapping is lost after reboots, so make sure to use the command ``vagrant reload `` when reboots are required. Having this shared folder provides a method to supply -a different docker binary to the cluster. The shared folder is also used to +a different Docker binary to the cluster. The shared folder is also used to store the docker-registry files, so they are save from destructive operations like ``vagrant destroy``.