From 8b1474ab75bb5563bbdecaf965f8fbb240bd93bf Mon Sep 17 00:00:00 2001 From: Matthew Vernon Date: Wed, 10 Mar 2021 16:53:45 +0000 Subject: [PATCH] Docs: fix some typos While working on the previous PR, I found a couple of typos in the docs. This fixes those. Signed-off-by: Matthew Vernon --- docs/source/day-2/upgrade.rst | 4 ++-- docs/source/dev/index.rst | 2 +- docs/source/index.rst | 4 ++-- docs/source/installation/methods.rst | 2 +- docs/source/installation/non-containerized.rst | 6 +++--- docs/source/osds/scenarios.rst | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/source/day-2/upgrade.rst b/docs/source/day-2/upgrade.rst index 47978321c..1ec658ccb 100644 --- a/docs/source/day-2/upgrade.rst +++ b/docs/source/day-2/upgrade.rst @@ -3,7 +3,7 @@ Upgrading the ceph cluster ceph-ansible provides a playbook in ``infrastructure-playbooks`` for upgrading a Ceph cluster: ``rolling_update.yml``. -This playbook could be used for both minor upgrade (X.Y to X.Z) or major upgrade (X to Y). +This playbook could be used for both minor upgrades (X.Y to X.Z) or major upgrades (X to Y). Before running a major upgrade you need to update the ceph-ansible version first. @@ -14,4 +14,4 @@ example: $ ansible-playbook -vv -i hosts infrastructure-playbooks/rolling_update.yml .. note:: - This playbook isn't intended to be run with the ``--limit`` ansible option. \ No newline at end of file + This playbook isn't intended to be run with the ``--limit`` ansible option. diff --git a/docs/source/dev/index.rst b/docs/source/dev/index.rst index 0ce3305ae..a3f56368f 100644 --- a/docs/source/dev/index.rst +++ b/docs/source/dev/index.rst @@ -84,7 +84,7 @@ If a change should be backported to a ``stable-*`` Git branch: ``git checkout --no-track -b my-backported-change origin/stable-5.0`` - Cherry-pick your change: ``git cherry-pick -x (your-sha1)`` - Create a new pull request against the ``stable-5.0`` branch. -- Ensure that your pull requests's title has the prefix "backport:", so it's clear +- Ensure that your pull request's title has the prefix "backport:", so it's clear to reviewers what this is about. - Add a comment in your backport pull request linking to the original (master) pull request. diff --git a/docs/source/index.rst b/docs/source/index.rst index 6e49224ce..c26b6b619 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -68,7 +68,7 @@ Releases ======== The following branches should be used depending on your requirements. The ``stable-*`` -branches have been QE tested and sometimes recieve backport fixes throughout their lifecycle. +branches have been QE tested and sometimes receive backport fixes throughout their lifecycle. The ``master`` branch should be considered experimental and used with caution. - ``stable-3.0`` Supports Ceph versions ``jewel`` and ``luminous``. This branch requires Ansible version ``2.4``. @@ -198,7 +198,7 @@ Configuration The configuration for your Ceph cluster will be set by the use of ansible variables that ``ceph-ansible`` provides. All of these options and their default values are defined in the ``group_vars/`` directory at the root of the ``ceph-ansible`` project. Ansible will use configuration in a ``group_vars/`` directory that is relative to your inventory file or your playbook. Inside of the ``group_vars/`` directory there are many sample Ansible configuration files that relate -to each of the Ceph daemon groups by their filename. For example, the ``osds.yml.sample`` contains all the default configuation for the OSD daemons. The ``all.yml.sample`` +to each of the Ceph daemon groups by their filename. For example, the ``osds.yml.sample`` contains all the default configuration for the OSD daemons. The ``all.yml.sample`` file is a special ``group_vars`` file that applies to all hosts in your cluster. .. note:: diff --git a/docs/source/installation/methods.rst b/docs/source/installation/methods.rst index 7a927fd6c..2c30943fa 100644 --- a/docs/source/installation/methods.rst +++ b/docs/source/installation/methods.rst @@ -9,4 +9,4 @@ ceph-ansible can deploy Ceph either in a non-containerized context (via packages non-containerized containerized -The difference here is that you don't have the rbd command on the host when using the containerized deployment so everything related to ceph needs to be executed within a container. So in the case there is software like e.g. Open Nebula which requires that the rbd command is accessible directly on the host (non-containerized) then you have to install the rbd command by yourself on those servers outside of containers. (Or make sure that this software somehow runs within containers as well and that it can access rbd. +The difference here is that you don't have the rbd command on the host when using the containerized deployment so everything related to ceph needs to be executed within a container. So in the case there is software like e.g. Open Nebula which requires that the rbd command is accessible directly on the host (non-containerized) then you have to install the rbd command by yourself on those servers outside of containers (or make sure that this software somehow runs within containers as well and that it can access rbd). diff --git a/docs/source/installation/non-containerized.rst b/docs/source/installation/non-containerized.rst index a00d66648..f56bdec2a 100644 --- a/docs/source/installation/non-containerized.rst +++ b/docs/source/installation/non-containerized.rst @@ -1,5 +1,5 @@ -Non containerized deployement -============================= +Non containerized deployment +============================ The following are all of the available options for the installing Ceph through different channels. @@ -54,7 +54,7 @@ Custom repository ~~~~~~~~~~~~~~~~~ If ``ceph_repository`` is set to ``custom``, packages you will be by default installed from a desired repository. -This repository is specifie with ``ceph_custom_repo``, e.g: ``ceph_custom_repo: https://server.domain.com/ceph-custom-repo``. +This repository is specified with ``ceph_custom_repo``, e.g: ``ceph_custom_repo: https://server.domain.com/ceph-custom-repo``. Origin: Distro diff --git a/docs/source/osds/scenarios.rst b/docs/source/osds/scenarios.rst index 210b07797..a4deb6ba0 100644 --- a/docs/source/osds/scenarios.rst +++ b/docs/source/osds/scenarios.rst @@ -17,7 +17,7 @@ At present (starting from stable-4.0), there is only one scenario, which default So there is no need to configure ``osd_scenario`` anymore, it defaults to ``lvm``. -The ``lvm`` scenario mentionned above support both containerized and non-containerized cluster. +The ``lvm`` scenario mentioned above support both containerized and non-containerized cluster. As a reminder, deploying a containerized cluster can be done by setting ``containerized_deployment`` to ``True``. @@ -223,4 +223,4 @@ Supported ``lvm_volumes`` configuration settings: journal: journal-lv2 journal_vg: journal-vg2 -.. note:: Volume groups and logical volumes must exist. \ No newline at end of file +.. note:: Volume groups and logical volumes must exist.