From: Ville Ojamo <14869000+bluikko@users.noreply.github.com> Date: Fri, 13 Mar 2026 06:51:38 +0000 (+0700) Subject: doc/cephadm: Fix spelling errors X-Git-Tag: v21.0.0~88^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F67770%2Fhead;p=ceph.git doc/cephadm: Fix spelling errors Signed-off-by: Ville Ojamo --- diff --git a/doc/cephadm/client-setup.rst b/doc/cephadm/client-setup.rst index 9ee1e92dcad1..4ca1e4c85ffe 100644 --- a/doc/cephadm/client-setup.rst +++ b/doc/cephadm/client-setup.rst @@ -34,7 +34,7 @@ Keyring Setup Most Ceph clusters run with authentication enabled. This means that the client needs keys in order to communicate with Ceph daemons. To generate a keyring file with credentials for ``client.fs``, -log into an running cluster member and run the following command: +log into a running cluster member and run the following command: .. prompt:: bash # diff --git a/doc/cephadm/host-management.rst b/doc/cephadm/host-management.rst index 686a085cb5ef..fc60681fd9a9 100644 --- a/doc/cephadm/host-management.rst +++ b/doc/cephadm/host-management.rst @@ -25,7 +25,7 @@ In commands of this form, the arguments ``host-pattern``, ``label``, and against name, label and status simultaneously, or to filter against any proper subset of name, label and status. -The ``detail`` parameter provides more host related information for cephadm-based +The ``detail`` parameter provides more host-related information for cephadm-based clusters. For example: .. prompt:: bash # @@ -152,7 +152,7 @@ cluster by running a command of the following form: Offline Host Removal -------------------- -If a host is offline and can not be recovered, it can be removed from the +If a host is offline and cannot be recovered, it can be removed from the cluster by running a command of the following form: .. prompt:: bash # @@ -171,7 +171,7 @@ Host Labels =========== The orchestrator supports assigning labels to hosts. Labels -are free-form and have no particular meaning by itself and each host +are free-form and have no particular meaning by themsevels. Each host can have multiple labels. They can be used to specify the placement of daemons. For more information, see :ref:`orch-placement-by-labels`. @@ -182,7 +182,7 @@ Labels can be added when adding a host with the ``--labels`` flag: ceph orch host add my_hostname --labels=my_label1 ceph orch host add my_hostname --labels=my_label1,my_label2 -To add a label a existing host, run: +To add a label to an existing host, run: .. prompt:: bash # @@ -226,7 +226,7 @@ The following host labels have a special meaning to cephadm. All start with ``_ bootstrap was originally run), and the ``client.admin`` key is set to be distributed to that host via the ``ceph orch client-keyring ...`` function. Adding this label to additional hosts will normally cause cephadm to deploy configuration and keyring files - in ``/etc/ceph``. Starting from versions 16.2.10 (Pacific) and 17.2.1 (Quincy) in + in ``/etc/ceph``. Starting from versions 16.2.10 (Pacific) and 17.2.1 (Quincy), in addition to the default location ``/etc/ceph/`` cephadm also stores config and keyring files in the ``/var/lib/ceph//config`` directory. @@ -371,7 +371,7 @@ cephadm control. Removal from the CRUSH map will fail if there are OSDs deployed on the host. If you would like to remove all the host's OSDs as well, please start - by using the ``ceph orch host drain`` command to do so. Once the OSDs + by using the ``ceph orch host drain`` command to do so. Once the OSDs have been removed, then you may direct cephadm to remove the CRUSH bucket along with the host using the ``--rm-crush-entry`` flag. diff --git a/doc/cephadm/operations.rst b/doc/cephadm/operations.rst index e592f5bcc769..6fb4c796e1c0 100644 --- a/doc/cephadm/operations.rst +++ b/doc/cephadm/operations.rst @@ -90,8 +90,8 @@ file but will not trigger a restart of the daemon. ceph orch daemon reconfig -Rotating a Daemon's Authenticate Key ------------------------------------- +Rotating a Daemon's Authentication Key +-------------------------------------- All Ceph and gateway daemons in the cluster have a secret key that is used to connect to and authenticate with the cluster. This key can be rotated (i.e., replaced with a @@ -355,7 +355,7 @@ means that those services cannot currently be managed by cephadm ``CEPHADM_STRAY_DAEMON`` ~~~~~~~~~~~~~~~~~~~~~~~~ -One or more Ceph daemons are running but not are not managed by +One or more Ceph daemons are running but are not managed by *cephadm*. This may be because they were deployed using a different tool, or because they were started manually. Those services cannot currently be managed by cephadm (e.g., restarted, @@ -424,7 +424,7 @@ Cluster Configuration Checks ---------------------------- Cephadm periodically scans each host in the cluster in order -to understand the state of the OS, disks, network interfacess etc. This information can +to understand the state of the OS, disks, network interfaces etc. This information can then be analyzed for consistency across the hosts in the cluster to identify any configuration anomalies. diff --git a/doc/cephadm/services/custom-container.rst b/doc/cephadm/services/custom-container.rst index 0c8210f25920..e8acc9d284f5 100644 --- a/doc/cephadm/services/custom-container.rst +++ b/doc/cephadm/services/custom-container.rst @@ -79,8 +79,8 @@ where the properties of a service specification are: exist. Use the `dirs` property to create them if necessary. * ``init_containers`` A list of "init container" definitions. An init container exists to - run prepratory steps before the primary container starts. Init containers - are optional. One or more container can be defined. + run preparatory steps before the primary container starts. Init containers + are optional. One or more containers can be defined. Each definition can contain the following fields: * ``image`` @@ -98,7 +98,7 @@ where the properties of a service specification are: * ``envs`` A list of environment variables. * ``privileged`` - A boolean indicate if the container should run with privileges or not. If + A boolean indicating whether the container should run with privileges or not. If left unspecified, the init container will inherit the primary container's value. diff --git a/doc/cephadm/services/monitoring.rst b/doc/cephadm/services/monitoring.rst index 63a91708fd67..f88b28507c49 100644 --- a/doc/cephadm/services/monitoring.rst +++ b/doc/cephadm/services/monitoring.rst @@ -102,7 +102,7 @@ few minutes until all components are fully operational. The updated secure confi #. Prometheus: basic authentication is required to access the web portal and TLS is enabled for secure communication. #. Alertmanager: basic authentication is required to access the web portal and TLS is enabled for secure communication. #. Node Exporter: TLS is enabled for secure communication. -#. Grafana: TLS is enabled and authentication is requiered to access the datasource information. +#. Grafana: TLS is enabled and authentication is required to access the datasource information. #. Cephadm service discovery endpoint: basic authentication is required to access service discovery information, and TLS is enabled for secure communication. In this secure setup, users will need to setup authentication diff --git a/doc/cephadm/services/smb.rst b/doc/cephadm/services/smb.rst index 0e39edb63ef6..7b7e74fe9336 100644 --- a/doc/cephadm/services/smb.rst +++ b/doc/cephadm/services/smb.rst @@ -8,7 +8,7 @@ SMB Service SMB support is under active development and many features may be missing or immature. A Ceph MGR module, named smb, is available to help - organize and manage SMB related featues. Unless the smb module + organize and manage SMB-related features. Unless the smb module has been determined to be unsuitable for your needs we recommend using that module over directly using the smb service spec. @@ -171,7 +171,7 @@ cluster_public_addrs High-Availability or "transparent state migration") the feature flag ``clustered`` is needed. If this flag is not specified cephadm may deploy multiple smb servers but they will lack the coordination needed of an actual - Highly-Avaiable cluster. When the ``clustered`` flag is specified cephadm + Highly-Available cluster. When the ``clustered`` flag is specified cephadm will deploy additional containers that manage this coordination. Additionally, the cluster_meta_uri and cluster_lock_uri values must be specified. The former is used by cephadm to describe the smb cluster layout @@ -196,7 +196,7 @@ of these configurations is out of scope for this document. You can refer to the `documentation for Samba `_ as well as the `samba server container `_ -and the `configuation file +and the `configuration file `_ it accepts. diff --git a/doc/cephadm/troubleshooting.rst b/doc/cephadm/troubleshooting.rst index 6303a6b3fc76..57301f29e8f3 100644 --- a/doc/cephadm/troubleshooting.rst +++ b/doc/cephadm/troubleshooting.rst @@ -128,7 +128,7 @@ form: cephadm logs --name -.. Note:: This works only when run on the same host that is running the daemon. +.. note:: This works only when run on the same host that is running the daemon. To get the logs of a daemon that is running on a different host, add the ``--fsid`` option to the command, as in the following example: @@ -369,7 +369,7 @@ If the Ceph Monitor (``mon``) daemons cannot form a quorum, ``cephadm`` will not be able to manage the cluster until quorum is restored. In order to restore the quorum, remove unhealthy monitors -form the monmap by following these steps: +from the monmap by following these steps: #. Stop all Monitors. Use ``ssh`` to connect to each Monitor's host, and then while connected to the Monitor's host use ``cephadm`` to stop the Monitor @@ -574,7 +574,7 @@ This creates a script that includes the container command that ``cephadm`` would use to create a shell. Modify the script by removing the ``--init`` argument and replace it with the argument that joins to the namespace used for a running running container. For example, assume we want to debug the Manager -and have determnined that the Manager is running in a container named +and have determined that the Manager is running in a container named ``ceph-bc615290-685b-11ee-84a6-525400220000-mgr-ceph0-sluwsk``. In this case, the argument ``--pid=container:ceph-bc615290-685b-11ee-84a6-525400220000-mgr-ceph0-sluwsk`` diff --git a/doc/cephadm/upgrade.rst b/doc/cephadm/upgrade.rst index 9c3eba8fbea4..4681ff63432f 100644 --- a/doc/cephadm/upgrade.rst +++ b/doc/cephadm/upgrade.rst @@ -56,7 +56,7 @@ Starting the Upgrade large-scale CephFS deployments because the cluster cannot quickly reduce active MDS(s) to `1` and a single active MDS cannot easily handle the load of all clients even for a short time. Therefore, to upgrade MDS(s) without reducing ``max_mds``, - the ``fail_fs`` option can to be set to ``true`` (default value is ``false``) prior + the ``fail_fs`` option can be set to ``true`` (default value is ``false``) prior to initiating the upgrade: .. prompt:: bash #