From 7b38556041049b88384200418bc39b344dcee016 Mon Sep 17 00:00:00 2001 From: denmaloyreb <60424108+denmaloyreb@users.noreply.github.com> Date: Wed, 15 Jan 2025 16:36:52 +0300 Subject: [PATCH] [docs] Fix Managing nodes examples section design (#11504) Signed-off-by: Denis.Rebenok Signed-off-by: denmaloyreb <60424108+denmaloyreb@users.noreply.github.com> Co-authored-by: Denis.Rebenok Co-authored-by: Ekaterina Matseevska --- modules/040-node-manager/docs/EXAMPLES.md | 14 ++++----- modules/040-node-manager/docs/EXAMPLES_RU.md | 30 ++++++++++---------- 2 files changed, 22 insertions(+), 22 deletions(-) diff --git a/modules/040-node-manager/docs/EXAMPLES.md b/modules/040-node-manager/docs/EXAMPLES.md index 66418abef2..ac5fd6331d 100644 --- a/modules/040-node-manager/docs/EXAMPLES.md +++ b/modules/040-node-manager/docs/EXAMPLES.md @@ -3,7 +3,7 @@ title: "Managing nodes: examples" description: Examples of managing Kubernetes cluster nodes. Examples of creating a node group. Examples of automating the execution of arbitrary settings on a node. --- -Below are some examples of `NodeGroup` description, as well as installing the cert-manager plugin for kubectl and setting the sysctl parameter. +Below are some examples of NodeGroup description, as well as installing the cert-manager plugin for `kubectl` and setting the `sysctl` parameter. ## Examples of the `NodeGroup` configuration @@ -101,7 +101,7 @@ Follow the steps below to add a new static node (e.g., VM or bare metal server) - Add all the necessary mount points to the `/etc/fstab` file (NFS, Ceph, etc.); - Install the necessary packages (e.g., `ceph-common`); - Configure network connectivity between the new node and the other nodes of the cluster. -1. Connect to the new node over SSH and run the following command, inserting the Base64 string you got in step 2: +1. Connect to the new node over SSH and run the following command, inserting the Base64 string you got in step 3: ```shell echo | base64 -d | bash @@ -299,11 +299,11 @@ This example shows how you can use filters in the StaticInstance [label selector During the process of transferring instances between node groups, the instance will be cleaned and re-bootstrapped, and the `Node` object will be recreated. {% endalert %} -This section describes the process of moving static instances between different node groups (`NodeGroup`) using the Cluster API Provider Static (CAPS). The process involves modifying the `NodeGroup` configuration and updating the labels (`labels`) of the corresponding `StaticInstance`. +This section describes the process of moving static instances between different node groups (NodeGroup) using the Cluster API Provider Static (CAPS). The process involves modifying the NodeGroup configuration and updating the labels of the corresponding StaticInstance. #### Initial Configuration -Assume that there is already a `NodeGroup` named `worker` in the cluster, configured to manage one static instance with the label `role: worker`. +Assume that there is already a NodeGroup named `worker` in the cluster, configured to manage one static instance with the label `role: worker`. **`NodeGroup` worker:** @@ -341,7 +341,7 @@ spec: ##### 1. Create a New `NodeGroup` for the Target Node Group -Create a new `NodeGroup` resource, for example, named `front`, which will manage a static instance with the label `role: front`. +Create a new NodeGroup resource, for example, named `front`, which will manage a static instance with the label `role: front`. ```shell kubectl create -f - < @@ -87,7 +87,7 @@ spec: - [Для AWS](../cloud-provider-aws/faq.html#добавление-cloudstatic-узлов-в-кластер) - [Для GCP](../cloud-provider-gcp/faq.html#добавление-cloudstatic-узлов-в-кластер) - [Для YC](../cloud-provider-yandex/faq.html#добавление-cloudstatic-узлов-в-кластер) -1. Используйте существующий или создайте новый custom resource [NodeGroup](cr.html#nodegroup) ([пример](#статические-узлы) `NodeGroup` с именем `worker`). Параметр [nodeType](cr.html#nodegroup-v1-spec-nodetype) в custom resource NodeGroup для статических узлов должен быть `Static` или `CloudStatic`. +1. Используйте существующий или создайте новый ресурс [NodeGroup](cr.html#nodegroup) ([пример](#статические-узлы) NodeGroup с именем `worker`). Параметр [nodeType](cr.html#nodegroup-v1-spec-nodetype) в ресурсе NodeGroup для статических узлов должен быть `Static` или `CloudStatic`. 1. Получите код скрипта в кодировке Base64 для добавления и настройки узла. Пример получения кода скрипта в кодировке Base64 для добавления узла в NodeGroup `worker`: @@ -101,7 +101,7 @@ spec: - добавьте необходимые точки монтирования в файл `/etc/fstab` (NFS, Ceph и т. д.); - установите необходимые пакеты (например, `ceph-common`); - настройте сетевую связанность между новым узлом и остальными узлами кластера. -1. Зайдите на новый узел по SSH и выполните следующую команду, вставив полученную в п. 2 Base64-строку: +1. Зайдите на новый узел по SSH и выполните следующую команду, вставив полученную в п. 3 Base64-строку: ```shell echo | base64 -d | bash @@ -134,7 +134,7 @@ spec: ssh-keygen -t rsa -f caps-id -C "" -N "" ``` - Публичный и приватный ключи пользователя `caps` будут сохранены в файлах `caps-id.pub` и `caps-id` в текущей папке на сервере. + Публичный и приватный ключи пользователя `caps` будут сохранены в файлах `caps-id.pub` и `caps-id` в текущей директории на сервере. * Добавьте полученный публичный ключ в файл `/home/caps/.ssh/authorized_keys` пользователя `caps`, выполнив в директории с ключами **на сервере** следующие команды: @@ -199,7 +199,7 @@ spec: EOF ``` - > Поле `labelSelector` в ресурсе `NodeGroup` является неизменным. Чтобы обновить labelSelector, нужно создать новую NodeGroup и перенести в неё статические узлы, изменив их метки (labels). + > Поле `labelSelector` в ресурсе `NodeGroup` является неизменным. Чтобы обновить labelSelector, нужно создать новую NodeGroup и перенести в неё статические узлы, изменив их лейблы (labels). 1. Создайте в кластере ресурс [NodeGroup](cr.html#nodegroup): @@ -227,7 +227,7 @@ spec: 1. Создайте в кластере два ресурса [NodeGroup](cr.html#nodegroup) (здесь и далее используйте `kubectl`, настроенный на управление кластером): - > Поле `labelSelector` в ресурсе `NodeGroup` является неизменным. Чтобы обновить labelSelector, нужно создать новую NodeGroup и перенести в неё статические узлы, изменив их метки (labels). + > Поле `labelSelector` в ресурсе `NodeGroup` является неизменным. Чтобы обновить labelSelector, нужно создать новую NodeGroup и перенести в неё статические узлы, изменив их лейблы (labels). ```shell kubectl create -f - <