From 5220351e5459e355ba146e8efe0b43afa72edb4b Mon Sep 17 00:00:00 2001 From: Steve Wilkerson Date: Thu, 8 Dec 2016 07:29:06 -0600 Subject: [PATCH] Change 'docker' to 'Docker' in docs Changed occurences of 'docker' to 'Docker' to be in accordance with Docker Inc's trademark guidelines found here: https://www.docker.com/trademark-guidelines This was done due to a pending change that will append Docker Inc's trademark notice in the kolla docs TrivialFix Change-Id: I2a030232ca9ca7a040780402c0b73df0341ae253 --- README.rst | 2 +- doc/image-building.rst | 10 +++++----- doc/kuryr-guide.rst | 2 +- doc/multinode.rst | 4 ++-- doc/quickstart.rst | 14 +++++++------- doc/vagrant-dev-env.rst | 2 +- 6 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index da4926b21a..295b0048c6 100644 --- a/README.rst +++ b/README.rst @@ -140,7 +140,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 13df89bbee..9d067f6113 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:: @@ -91,7 +91,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 @@ -124,7 +124,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:: @@ -337,9 +337,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 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 2a003b4bd3..da624066b7 100644 --- a/doc/multinode.rst +++ b/doc/multinode.rst @@ -46,7 +46,7 @@ Edit ``/etc/default/docker`` and add: DOCKER_OPTS="--insecure-registry 192.168.1.100:5000" 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: :: @@ -70,7 +70,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 ebfbeca442..7ee7016a75 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: :: @@ -413,7 +413,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: :: @@ -520,7 +520,7 @@ For *all-in-one* deploys, the following commands can be run. These will setup all of the containers on the localhost. These commands will be wrapped in the kolla-script in the future. -.. note:: Even for all-in-one installs it is possible to use the docker +.. note:: Even for all-in-one installs it is possible to use the Docker registry for deployment, although not strictly required. First, check that the deployment targets are in a state where Kolla may deploy @@ -647,7 +647,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 17ab621e0b..8e43626451 100644 --- a/doc/vagrant-dev-env.rst +++ b/doc/vagrant-dev-env.rst @@ -115,7 +115,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``.