starlingx/docs
Code Issues Proposed changes

Modified the controllerfs command (pick 'r5'; 'r6', 'dsR6' (for downstream picks)

Browse Source 
Removed the Delete step for docker fs from "Increase Worker Filesystem Storage Allotments Using the CLI" as it not supported
Deleted increase-storage-filesystem-allotments-using-the-cli-8e069a797870
Updated Patchset 7 comments
Added new topics for Worker / Storage Hosts
Updated comments on Patchset 5
Updated comments on Patchset 4
Updated Topic "Increase Controller Filesystem Storage Allotments Using the CLI"

Signed-off-by: Juanita-Balaraj <juanita.balaraj@windriver.com>
Change-Id: Ia3130e97cf7d7bd7a953dd08b730d7f88f4d9fd5
This commit is contained in:
Juanita-Balaraj
2022-04-07 12:42:51 -04:00
parent 2d93905e8d
commit 131b04063f
4 changed files with 187 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/source/shared/abbrevs.txt
View File

@@ -68,6 +68,7 @@
.. |LDAP| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)` .. |LDAP| replace:: :abbr:`LDAP (Lightweight Directory Access Protocol)`
.. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity Check)` .. |LDPC| replace:: :abbr:`LDPC (Low-Density Parity Check)`
.. |LLDP| replace:: :abbr:`LLDP (Link Layer Discovery Protocol)` .. |LLDP| replace:: :abbr:`LLDP (Link Layer Discovery Protocol)`
.. |LVG| replace:: :abbr:`LVG (Local Volume Groups)`
.. |MAC| replace:: :abbr:`MAC (Media Access Control)` .. |MAC| replace:: :abbr:`MAC (Media Access Control)`
.. |MEC| replace:: :abbr:`MEC (Multi-access Edge Computing)` .. |MEC| replace:: :abbr:`MEC (Multi-access Edge Computing)`
.. |MLD| replace:: :abbr:`MLD (Multicast Listener Discovery)` .. |MLD| replace:: :abbr:`MLD (Multicast Listener Discovery)`

115
doc/source/storage/kubernetes/increase-controller-filesystem-storage-allotments-using-the-cli.rst
View File

@@ -30,24 +30,38 @@ Controller Filesystem Storage Allotments Using Horizon
.. rubric:: |proc| .. rubric:: |proc|
.. _increase-controller-filesystem-storage-allotments-using-the-cli-steps-ims-sxx-mcb: #. To review the existing host filesystems on a controller, use the
:command:`system host-fs-list <hostname>` command. For example:
#. To review the existing storage configuration, use the .. code-block:: none
~(keystone_admin)$ system host-fs-list controller-0
+--------------------------------------+---------+-------------+----------------+
| UUID | FS Name | Size in GiB | Logical Volume |
+--------------------------------------+---------+-------------+----------------+
| 1875cd0e-aee2-4646-b397-298348acf424 | backup | 25 | backup-lv |
| cee6df98-9222-4594-b25f-469c625c5975 | docker | 60 | docker-lv |
| c53be87c-bbcf-4d11-8cf5-93f350f8d027 | kubelet | 10 | kubelet-lv |
| efdddf39-7a0d-48f1-a14d-fc734e5b8675 | scratch | 16 | scratch-lv |
+--------------------------------------+---------+-------------+----------------+
#. To review the existing controller filesystems that are synchronized between
controllers on two controller (|AIO-DX| and standard) systems, use the
:command:`system controllerfs-list` command. :command:`system controllerfs-list` command.
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system controllerfs-list ~(keystone_admin)$ system controllerfs-list
+-------------+-----------+------+--------------+------------+-----------+ +-------------+-------------+------+--------------+------------+-----------+
| UUID | FS Name | Size | Logical | Replicated | State | | UUID | FS Name | Size | Logical | Replicated | State |
| | | in | Volume | | | | | | in | Volume | | |
| | | GiB | | | | | | | GiB | | | |
| | | | | | | | | | | | | |
+-------------+-----------+------+--------------+------------+-----------+ +-------------+-------------+------+--------------+------------+-----------+
| aa9c7eab... | database | 10 | pgsql-lv | True | available | | aa9c7eab... | database | 10 | pgsql-lv | True | available |
| | | | | | | | | | | | | |
| 173cbb02... | docker- | 16 | docker | | | | 173cbb02... | docker- | 16 | docker | | |
| | | | distribution | True | available | | | distribution| | distribution | True | available |
| | | |-lv | | | | | | |-lv | | |
| | | | | | | | | | | | | |
| 448f77b9... | etcd | 5 | etcd-lv | True | available | | 448f77b9... | etcd | 5 | etcd-lv | True | available |
@@ -55,7 +69,7 @@ Controller Filesystem Storage Allotments Using Horizon
| 9eadf06a... | extension | 1 | extension-lv | True | available | | 9eadf06a... | extension | 1 | extension-lv | True | available |
| | | | | | | | | | | | | |
| afcb9f0e... | platform | 10 | platform-lv | True | available | | afcb9f0e... | platform | 10 | platform-lv | True | available |
+-------------+-----------+------+--------------+------------+-----------+ +-------------+-------------+------+--------------+------------+-----------+
.. note:: .. note::
The values shown by :command:`system controllerfs-list` are not The values shown by :command:`system controllerfs-list` are not
@@ -63,41 +77,74 @@ Controller Filesystem Storage Allotments Using Horizon
agree with the output of the Linux :command:`df` command. Also, agree with the output of the Linux :command:`df` command. Also,
they are rounded compared to the :command:`df` output. they are rounded compared to the :command:`df` output.
#. Modify the backup filesystem size on controller-0. #. Modify, for example, the docker host filesystem size on controller-0.
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system host-fs-modify controller-0 backup=35 ~(keystone_admin)$ system host-fs-modify controller-0 docker=60
+-------------+---------+---------+----------------+ +--------------------------------------+---------+-------------+----------------+
| UUID | FS Name | Size in | Logical Volume | | UUID | FS Name | Size in GiB | Logical Volume |
| | | GiB | | +--------------------------------------+---------+-------------+----------------+
+-------------+---------+---------+----------------+ | 910844e9-f763-4426-8b92-9b44693ee8a7 | backup | 35 | backup-lv |
| bf0ef915... | backup | 35 | backup-lv | | 3bb38311-00b3-49c7-8b53-9178aeef2233 | docker | 60 | docker-lv |
| e8b087ea... | docker | 30 | docker-lv | | 44dd07e8-b4bf-4751-b76b-dd96b5bea9cc | kubelet | 10 | kubelet-lv |
| 4cac1020... | kubelet | 10 | kubelet-lv | | b2ab5c8e-a26a-4460-b960-552c636cfe43 | scratch | 16 | scratch-lv |
| 9c5a53a8... | scratch | 8 | scratch-lv | +--------------------------------------+---------+-------------+----------------+
+-------------+---------+---------+----------------+
#. On a non AIO-Simplex system, modify the backup filesystem size on .. note::
controller-1.
The backup filesystem is not replicated across controllers. You must When you use the :command:`system host-fs-modify` to increase
repeat the previous step on the other controller. the filesystem size, you may not have enough space in the |LVG| due to
additional services running on the controller host. To increase the size
from the default size of 30G to 60G for example, the docker filesystem,
see below:
For example: .. code-block:: bash
# check existing size of docker fs
system host-fs-list controller-0
# check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
system host-lvg-list controller-0
# if existing docker fs size + cgts-vg available space is less than
# 80G, you will need to add a new disk partition to cgts-vg.
# There must be at least 20GB of available space after the docker
# filesystem is increased.
# Assuming you have unused space on ROOT DISK, add partition to ROOT DISK.
# ( if not use another unused disk )
# Get device path of ROOT DISK
system host-show controller-0 --nowrap | fgrep rootfs
# Get UUID of ROOT DISK by listing disks
system host-disk-list controller-0
# Create new PARTITION on ROOT DISK, and take note of new partition's 'uuid' in response
# Use a partition size such that you'll be able to increase docker fs size from 30G to 60G
PARTITION_SIZE=30
system hostdisk-partition-add -t lvm_phys_vol controller-0 <root-disk-uuid> ${PARTITION_SIZE}
# Add new partition to 'cgts-vg' local volume group
system host-pv-add controller-0 cgts-vg <NEW_PARTITION_UUID>
sleep 2 # wait for partition to be added
# Increase docker filesystem to 60G
system host-fs-modify controller-0 docker=60
#. Modify, for example, the extensions controller filesystem on the
controller(s).
.. code-block:: none .. code-block:: none
~(keystone_admin)$ system host-fs-modify controller-1 backup=35 ~(keystone_admin)]$ system controllerfs-modify extension=2
+-------------+---------+------+----------------+ +--------------------------------------+---------------------+---------+-----------------------+------------+------------------------------+
| UUID | FS Name | Size | Logical Volume | | UUID | FS Name | Size in | Logical Volume | Replicated | State |
| | | in | | | | | GiB | | | |
| | | GiB | | +--------------------------------------+---------------------+---------+-----------------------+------------+------------------------------+
+-------------+---------+------+----------------+ | 176b8e7b-e38c-4829-b16f-023465360e52 | extension | 2 | extension-lv | True | drbd_fs_resizing_in_progress |
| 45f22520... | backup | 35 | backup-lv | | 6efb7069-6eef-49d1-aaca-771164e129f3 | docker-distribution | 16 | dockerdistribution-lv | True | available |
| 173cbb02... | docker | 30 | docker-lv | | a0b10f6d-21f6-4e3c-a0f7-166f96672d93 | database | 10 | pgsql-lv | True | available |
| 4120d512... | kubelet | 10 | kubelet-lv | | db43909e-8389-4372-8914-4018166f5eca | etcd | 5 | etcd-lv | True | available |
| 8885ad63... | scratch | 8 | scratch-lv | | f9b55e7c-468e-46bd-8ae7-5ca817e3e250 | platform | 10 | platform-lv | True | available |
+-------------+---------+------+----------------+ +--------------------------------------+---------------------+---------+-----------------------+------------+------------------------------+

90
doc/source/storage/kubernetes/increase-worker-filesystem-storage-allotments-using-the-cli-da92e5d15a69.rst Normal file
View File

@@ -0,0 +1,90 @@
.. _increase-worker-filesystem-storage-allotments-using-the-cli-da92e5d15a69:
===========================================================
Increase Worker Filesystem Storage Allotments Using the CLI
===========================================================
You can use the |CLI| to list or increase the allotments for worker-based
storage at any time after installation.
.. caution::
Decreasing the filesystem size is not supported, and can result in
synchronization failures requiring system re-installation. Do not
attempt to decrease the size of the filesystem.
.. rubric:: |proc|
#. To review the existing host filesystems on a worker host, use the
:command:`system host-fs-list <hostname>` command. For example:
.. code-block:: none
~(keystone_admin)$ system host-fs-list worker-0
#. To add a filesystem use the :command:`host-fs-add` CLI command.
.. code-block:: none
~(keystone_admin)$ system host-fs-add worker-0 docker=60
The syntax is:
.. code-block:: none
system host-fs-add <hostname or id> <fs-name=size>
Where:
* ``hostname or id`` is the location where the file system will be added.
* ``fs-name`` is the filesystem name.
* ``size`` is an integer indicating the file system size in Gigabytes.
#. Modify, for example, the docker host filesystem size on worker-0, use the
:command:`system host-fs-modify <hostname> docker=60` command.
.. code-block:: none
~(keystone_admin)$ system host-fs-modify worker-0 docker=60
.. note::
When you use the :command:`system host-fs-modify` to increase
the filesystem size, you may not have enough space in the |LVG| due to
additional services running on the worker host. To increase the size
from the default size of 30G to 60G for example, the docker filesystem,
see below:
.. code-block:: bash
# check existing size of docker fs
system host-fs-list worker-0
# check available space (Avail Size (GiB)) in cgts-vg LVG where docker fs is located
system host-lvg-list worker-0
# if existing docker fs size + cgts-vg available space is less than
# 80G, you will need to add a new disk partition to cgts-vg.
# There must be at least 20GB of available space after the docker
# filesystem is increased.
# Assuming you have unused space on ROOT DISK, add partition to ROOT DISK.
# ( if not use another unused disk )
# Get device path of ROOT DISK
system host-show worker-0 --nowrap | fgrep rootfs
# Get UUID of ROOT DISK by listing disks
system host-disk-list worker-0
# Create new PARTITION on ROOT DISK, and take note of new partition's 'uuid' in response
# Use a partition size such that you'll be able to increase docker fs size from 30G to 60G
PARTITION_SIZE=30
system hostdisk-partition-add -t lvm_phys_vol worker-0 <root-disk-uuid> ${PARTITION_SIZE}
# Add new partition to 'cgts-vg' local volume group
system host-pv-add worker-0 cgts-vg <NEW_PARTITION_UUID>
sleep 2 # wait for partition to be added
# Increase docker filesystem to 60G
system host-fs-modify worker-0 docker=60
For more information on Host FileSystems, see :ref:`Host FileSystems <storage-planning-storage-on-controller-hosts>`

1
doc/source/storage/kubernetes/index-storage-kub-e797132c87a8.rst
View File

@@ -94,6 +94,7 @@ Worker Hosts
:maxdepth: 1 :maxdepth: 1
storage-configuration-storage-on-worker-hosts storage-configuration-storage-on-worker-hosts
increase-worker-filesystem-storage-allotments-using-the-cli-da92e5d15a69
------------- -------------
Storage Hosts Storage Hosts