diff --git a/README.rst b/README.rst index 4a7db55c..72a8e8b3 100644 --- a/README.rst +++ b/README.rst @@ -65,7 +65,7 @@ to view the rendered documentation. If you want to build the documentation exactly as seen on the website, use ``make py`` followed by ``make htmlall``. This builds some -external dependenices and all supported languages. +external dependencies and all supported languages. Additional help *************** diff --git a/source/about.rst b/source/about.rst index f2c81637..ec75e492 100644 --- a/source/about.rst +++ b/source/about.rst @@ -44,7 +44,7 @@ Ease of Use environments without needing to be configured. * Being :ref:`stateless` means that configuration settings are easier to manage - and remain untouched when system sofware is updated. + and remain untouched when system software is updated. * :ref:`swupd-guide` simplifies managing software and maintaining compatibility. diff --git a/source/collaboration/structure-formatting.rst b/source/collaboration/structure-formatting.rst index 6391dccb..56f4c954 100644 --- a/source/collaboration/structure-formatting.rst +++ b/source/collaboration/structure-formatting.rst @@ -55,7 +55,7 @@ For example, the :ref:`collaboration` page toctree looks like: Additionally, each page must include a uniquely named reST label directly before the page title, to enable the `Sphinx ref role`_ for linking to a page. -For example, this page "Structure and formating" has the label +For example, this page "Structure and formatting" has the label ``.. _structure-formatting``: .. code-block:: rest diff --git a/source/collaboration/writing-guide.rst b/source/collaboration/writing-guide.rst index f69a0344..40c6830f 100644 --- a/source/collaboration/writing-guide.rst +++ b/source/collaboration/writing-guide.rst @@ -18,7 +18,7 @@ Use simple English Write using simple English: Be brief and communicate only the information that is needed. Be friendly and informative. Emphasize clarity and avoid -unecessary complicated or technical terms. Make the content accessible to +unnecessary complicated or technical terms. Make the content accessible to non-native speakers. Be brief @@ -93,7 +93,7 @@ what they need quickly, and to understand the information more efficiently. document first, and organize supporting information towards the end of the page. * **Write scannable headings.** Expect readers of documentation to skim and scan - the content, and to leave if they dont find what they need quickly. Good + the content, and to leave if they don't find what they need quickly. Good headings add organization to your content and help the reader to find and understand content more effectively. Follow our guidelines for writing effective `Headings`_. diff --git a/source/get-started/bare-metal-install-server.rst b/source/get-started/bare-metal-install-server.rst index f1a764b4..aa93bdd6 100644 --- a/source/get-started/bare-metal-install-server.rst +++ b/source/get-started/bare-metal-install-server.rst @@ -840,7 +840,7 @@ Optional: Skip to `Finish installation`_. Automatic OS Updates ==================== -Automatical OS updates are enabled by default. In the rare case that you +Automatic OS updates are enabled by default. In the rare case that you need to disable automatic software updates, follow the onscreen instructions, shown in Figure 32. @@ -943,4 +943,3 @@ entering :guilabel:`Configure Installation Media`: - macOS\* platform: :command:`diskutil list` .. _Downloads: https://clearlinux.org/downloads - diff --git a/source/get-started/compatibility-check.rst b/source/get-started/compatibility-check.rst index ff17e55e..4dc30b08 100644 --- a/source/get-started/compatibility-check.rst +++ b/source/get-started/compatibility-check.rst @@ -4,7 +4,7 @@ Check processor and EFI firmware compatibility ############################################## Before installing |CL-ATTR|, check your host system's processor and EFI firmware -compatibility. To check compatibilty, choose one of the following paths: +compatibility. To check compatibility, choose one of the following paths: * From a system with a Linux\* OS installed, follow the instructions to :ref:`check-compatibility-steps`. diff --git a/source/get-started/index.rst b/source/get-started/index.rst index aa365df7..02f4a15f 100644 --- a/source/get-started/index.rst +++ b/source/get-started/index.rst @@ -4,7 +4,7 @@ Get started ########### The Get Started section guides you through the requirements and installation of -|CL-ATTR|. Follow these step-by-step intructions to get started with |CL|, fast. +|CL-ATTR|. Follow these step-by-step instructions to get started with |CL|, fast. Pre-install *********** @@ -15,7 +15,7 @@ There are a couple of things to take care of before you install. * :ref:`compatibility-check` * :ref:`bootable-usb` -When installing |CL-ATTR| in a VM, consider which kernel to use. +When installing |CL-ATTR| in a VM, consider which kernel to use. * :ref:`Compatible VM kernels ` @@ -55,4 +55,4 @@ Deploy to the cloud :maxdepth: 1 :glob: - cloud-install/* \ No newline at end of file + cloud-install/* diff --git a/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst b/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst index bde9d583..04b123c9 100644 --- a/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst +++ b/source/get-started/virtual-machine-install/vmware-esxi-install-cl.rst @@ -44,45 +44,45 @@ For more information, refer to :ref:`download-verify-decompress`. Upload the |CL| installer ISO to the VMware server ************************************************** -#. Connect to the VMware server and log into an account with sufficient - permission to create and manage VMs. -#. Under the :guilabel:`Navigator` window, select :guilabel:`Storage`. +#. Connect to the VMware server and log into an account with sufficient + permission to create and manage VMs. +#. Under the :guilabel:`Navigator` window, select :guilabel:`Storage`. See Figure 1. -#. Under the :guilabel:`Datastores` tab, click the :guilabel:`Datastore browser` - button. - +#. Under the :guilabel:`Datastores` tab, click the :guilabel:`Datastore browser` + button. + .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-1.png :scale: 100 % - :alt: VMware ESXi - Navigator > Storage + :alt: VMware ESXi - Navigator > Storage - Figure 1: VMware ESXi - Navigator > Storage + Figure 1: VMware ESXi - Navigator > Storage #. Click the :guilabel:`Create directory` button and name the directory `ISOs`. See Figure 2. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-2.png :scale: 100 % - :alt: VMware ESXi - Datastore > Create directory + :alt: VMware ESXi - Datastore > Create directory + + Figure 2: VMware ESXi - Datastore > Create directory - Figure 2: VMware ESXi - Datastore > Create directory - #. Select the newly-created directory and click the :guilabel:`Upload` button. See Figure 3. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-3.png :scale: 100 % - :alt: VMware ESXi - Datastore > Upload ISO + :alt: VMware ESXi - Datastore > Upload ISO - Figure 3: VMware ESXi - Datastore > Upload ISO - -#. Select the decompressed |CL| installer ISO file :file:`clear-[version number]-installer.iso` + Figure 3: VMware ESXi - Datastore > Upload ISO + +#. Select the decompressed |CL| installer ISO file :file:`clear-[version number]-installer.iso` and upload it. Create and configure a new VM ***************************** -In this section, you will create a new VM, configure its basic parameters such -as drive size, number of CPUs, memory size, and then attach the |CL| installer ISO. +In this section, you will create a new VM, configure its basic parameters such +as drive size, number of CPUs, memory size, and then attach the |CL| installer ISO. #. Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`. See Figure 4. @@ -93,9 +93,9 @@ as drive size, number of CPUs, memory size, and then attach the |CL| installer I :alt: VMware ESXi - Navigator > Virtual Machines Figure 4: VMware ESXi - Navigator > Virtual Machines - + #. On the :guilabel:`Select creation type` step: - + #. Select the :guilabel:`Create a new virtual machine` option. See Figure 5. #. Click the :guilabel:`Next` button. @@ -105,11 +105,11 @@ as drive size, number of CPUs, memory size, and then attach the |CL| installer I :alt: VMware ESXi - Create a new virtual machine Figure 5: VMware ESXi - Create a new virtual machine - + #. On the :guilabel:`Select a name and guest OS` step: #. Give the new VM a name in the :guilabel:`Name` field. See Figure 6. - #. Set the :guilabel:`Compatability` option to :guilabel:`ESXi 6.5 virtual machine`. + #. Set the :guilabel:`Compatibility` option to :guilabel:`ESXi 6.5 virtual machine`. #. Set the :guilabel:`Guest OS family` option to :guilabel:`Linux`. #. Set the :guilabel:`Guest OS version` option to :guilabel:`Other 3.x or later Linux (64-bit)`. #. Click the :guilabel:`Next` button. @@ -126,15 +126,15 @@ as drive size, number of CPUs, memory size, and then attach the |CL| installer I #. Click the :guilabel:`Next` button. #. On the :guilabel:`Customize settings` step: - + #. Click the :guilabel:`Virtual Hardware` button. See Figure 7. - #. Expand the :guilabel:`CPU` setting and enable :guilabel:`Hardware virtualization` by + #. Expand the :guilabel:`CPU` setting and enable :guilabel:`Hardware virtualization` by checking :guilabel:`Expose hardware assisted virtualization to the guest OS`. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-7.png :scale: 100 % :alt: VMware ESXi - Enable hardware virtualization - + Figure 7: VMware ESXi - Enable hardware virtualization #. Set :guilabel:`Memory` size to 2048MB (2GB). See Figure 8. @@ -145,12 +145,12 @@ as drive size, number of CPUs, memory size, and then attach the |CL| installer I Figure 8: VMware ESXi - Set memory size - .. note:: + .. note:: The |CL| installer ISO needs a minimum of 2GB of RAM to work properly. - You can reduce the memory size after the installation completes if you want, + You can reduce the memory size after the installation completes if you want, because a minimum |CL| installation can function on as little as 128MB of RAM. - See :ref:`system-requirements` for more details. + See :ref:`system-requirements` for more details. #. Set :guilabel:`Hard disk 1` to the desired capacity. See Figure 9. @@ -162,12 +162,12 @@ as drive size, number of CPUs, memory size, and then attach the |CL| installer I .. note:: - A minimum |CL| installation can exist on 600MB of drive space. - See :ref:`system-requirements` for more details. + A minimum |CL| installation can exist on 600MB of drive space. + See :ref:`system-requirements` for more details. - #. Attach the |CL| installer ISO. For the :guilabel:`CD/DVD Drive 1` setting, + #. Attach the |CL| installer ISO. For the :guilabel:`CD/DVD Drive 1` setting, click the drop-down list to the right of it and select the :guilabel:`Datastore ISO file` - option. Then select the |CL| installer ISO :file:`clear-[version number]-installer.iso` + option. Then select the |CL| installer ISO :file:`clear-[version number]-installer.iso` that you previously uploaded to the VMware server. See Figure 10. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-10.png @@ -183,13 +183,13 @@ Install |CL| into the new VM **************************** #. Power on the VM. - + #. Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`. See Figure 11. #. In the right window, select the newly-created VM. - #. Click the :guilabel:`Power on` button. + #. Click the :guilabel:`Power on` button. #. Click on the icon representing the VM to bring it into view and maximize - its window. + its window. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-11.png :scale: 100 % @@ -197,23 +197,23 @@ Install |CL| into the new VM Figure 11: VMware ESXi - Navigator > Virtual Machines > Power on VM -#. Follow the :ref:`install-on-target-start` guide to complete the installation of +#. Follow the :ref:`install-on-target-start` guide to complete the installation of |CL|. -#. After the installation is complete, follow the |CL| instruction to reboot it. - This will restart the installer again. +#. After the installation is complete, follow the |CL| instruction to reboot it. + This will restart the installer again. Reconfigure the VM's settings to boot the newly-installed |CL| ************************************************************** After |CL| has been installed using the installer ISO, it must be detached so it will not run again. Also, in order to boot the newly-installed |CL|, you must -enable UEFI support. +enable UEFI support. #. Power off the VM. - #. Click the :guilabel:`Actions` button - located on the top-right corner - of the VM's windows - and go to the :guilabel:`Power` setting and - select the :guilabel:`Power off` option. See Figure 12. + #. Click the :guilabel:`Actions` button - located on the top-right corner + of the VM's windows - and go to the :guilabel:`Power` setting and + select the :guilabel:`Power off` option. See Figure 12. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-12.png :scale: 100 % @@ -223,7 +223,7 @@ enable UEFI support. #. Edit the VM settings. - #. Click the :guilabel:`Actions` button again and select :guilabel:`Edit settings`. + #. Click the :guilabel:`Actions` button again and select :guilabel:`Edit settings`. See Figure 13. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-13.png @@ -233,9 +233,9 @@ enable UEFI support. Figure 13: VMware ESXi - Actions > Edit settings #. Disconnect the CD/DVD to stop it from booting the |CL| installer ISO again. - + #. Click the :guilabel:`Virtual Hardware` button. See Figure 14. - #. For the :guilabel:`CD/DVD Drive 1` setting, uncheck the + #. For the :guilabel:`CD/DVD Drive 1` setting, uncheck the :guilabel:`Connect` checkbox. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-14.png @@ -248,7 +248,7 @@ enable UEFI support. #. Click the :guilabel:`VM Options` button. See Figure 15. #. Expand the :guilabel:`Boot Options` setting. - #. For the :guilabel:`Firmware` setting, click the drop-down list to the right + #. For the :guilabel:`Firmware` setting, click the drop-down list to the right of it and select the :guilabel:`EFI` option. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-15.png @@ -262,14 +262,14 @@ enable UEFI support. Power on the VM and boot |CL| ***************************** -After configuring the settings above, power on the VM. +After configuring the settings above, power on the VM. #. Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`. See Figure 16. #. In the right window, select the VM. -#. Click the :guilabel:`Power on` button. +#. Click the :guilabel:`Power on` button. #. Click on the icon representing the VM to bring it into view and maximize - its window. + its window. .. figure:: figures/vmware-esxi/vmware-esxi-install-cl-16.png :scale: 100 % diff --git a/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst b/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst index 80a06cce..6ceac052 100644 --- a/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst +++ b/source/get-started/virtual-machine-install/vmware-esxi-preconfigured-cl-image.rst @@ -20,7 +20,7 @@ and run |CL-ATTR| virtual machines at scale. We provide a pre-configured |CL| VMware image that can be run on a VMware ESXi 6.5 host. -If manuall installation is preferred, refer to :ref:`vmware-esxi-install-cl`. +If manual installation is preferred, refer to :ref:`vmware-esxi-install-cl`. .. note:: @@ -47,8 +47,8 @@ For more information, refer to :ref:`download-verify-decompress`. Upload the |CL| image to the VMware server ****************************************** -Once the |CL| VMware prebuilt image has been downloaded and -decompressed on your local system, it must be uploaded to a datastore +Once the |CL| VMware prebuilt image has been downloaded and +decompressed on your local system, it must be uploaded to a datastore on the VMware ESXi server. The steps in this section can also be referenced from the VMware documentation @@ -57,11 +57,11 @@ The steps in this section can also be referenced from the VMware documentation #. Connect to the VMware ESXi server and login to an account with sufficient permission to create and manage VMs. -#. Under the :guilabel:`Navigator` window on the left side, +#. Under the :guilabel:`Navigator` window on the left side, select :guilabel:`Storage`. See Figure 1 -#. Under the :guilabel:`Datastores` tab, click +#. Under the :guilabel:`Datastores` tab, click the :guilabel:`Datastore browser` button. .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-1.png @@ -95,8 +95,8 @@ Convert the |CL| image to an ESXi-supported format ************************************************** Once the |CL| VMware prebuilt image has been uploaded to the VMware ESXi -datastore, it must be converted to a format for use with VMware's ESXi -hypervisor. +datastore, it must be converted to a format for use with VMware's ESXi +hypervisor. The steps in this section can also be referenced from the VMware documentation on `Cloning and converting virtual machine disks with vmkfstools`_ @@ -105,11 +105,11 @@ The steps in this section can also be referenced from the VMware documentation o .. note:: - If there is no :abbr:`vMA (vSphere Management Assistant)` appliance or :abbr:`vCLI (vSphere CLI)` configured and available, + If there is no :abbr:`vMA (vSphere Management Assistant)` appliance or :abbr:`vCLI (vSphere CLI)` configured and available, you can temporarily enable SSH directly on the ESXi host by following the steps described in `Enable the Secure Shell (SSH) in the VMware Host Client`_. - As a security best practice, remember to disable SSH access after following the steps in this section. + As a security best practice, remember to disable SSH access after following the steps in this section. #. Locate the uploaded image, which is typically found in @@ -134,10 +134,10 @@ Create and configure a new VM ***************************** In this section, you will create a new VM, configure its basic parameters -such as number of CPUs, memory size, and then attach the converted |CL| -VMware image. Also, in order to boot |CL|, you must enable UEFI support. +such as number of CPUs, memory size, and then attach the converted |CL| +VMware image. Also, in order to boot |CL|, you must enable UEFI support. -#. Under the :guilabel:`Navigator` window, select +#. Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`. See Figure 4. #. In the right window, click the :guilabel:`Create / Register VM` button. @@ -165,10 +165,10 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. #. Give the new VM a name in the :guilabel:`Name` field. See Figure 6. -#. Set the :guilabel:`Compatability` option to +#. Set the :guilabel:`Compatibility` option to :guilabel:`ESXi 6.5 virtual machine`. #. Set the :guilabel:`Guest OS family` option to :guilabel:`Linux`. -#. Set the :guilabel:`Guest OS version` option to +#. Set the :guilabel:`Guest OS version` option to :guilabel:`Other 3.x or later Linux (64-bit)`. #. Click the :guilabel:`Next` button. @@ -186,8 +186,8 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. #. On the :guilabel:`Customize settings` step: #. Click the :guilabel:`Virtual Hardware` button. See Figure 7. - #. Expand the :guilabel:`CPU` setting and enable - :guilabel:`Hardware virtualization` by checking + #. Expand the :guilabel:`CPU` setting and enable + :guilabel:`Hardware virtualization` by checking :guilabel:`Expose hardware assisted virtualization to the guest OS`. .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-7.png @@ -205,8 +205,8 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. Figure 8: VMware ESXi - Remove hard drive - #. Since a pre-configured image will be used, - the :guilabel:`CD/DVD Drive 1` setting will not be needed. Disable it + #. Since a pre-configured image will be used, + the :guilabel:`CD/DVD Drive 1` setting will not be needed. Disable it by unchecking the :guilabel:`Connect` checkbox. See Figure 9. .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-9.png @@ -228,14 +228,14 @@ VMware image. Also, in order to boot |CL|, you must enable UEFI support. Figure 10: VMware ESXi - Add an existing hard drive #. Select the converted :file:`clear-[version number]-esxi.vmdk` - file. Do not use the original unconverted + file. Do not use the original unconverted :file:`clear-[version number]-vmware.vmdk` file. See Figure 11. .. figure:: figures/vmware-esxi/vmware-esxi-preconfigured-cl-image-11.png :scale: 100 % :alt: VMware ESXi - Select the converted `vmdk` file - Figure 11: VMware ESXi - Select the converted + Figure 11: VMware ESXi - Select the converted :file:`clear-[version number]-esxi.vmdk` file #. |CL| needs UEFI support in order to boot. Enable UEFI boot support. @@ -260,7 +260,7 @@ Power on the VM and boot |CL| After configuring the settings above, power on the VM. -#. Under the :guilabel:`Navigator` window, select +#. Under the :guilabel:`Navigator` window, select :guilabel:`Virtual Machines`. See Figure 13. #. In the right window, select the newly-created VM. #. Click the :guilabel:`Power on` button. diff --git a/source/guides/maintenance/architect-lifecycle.rst b/source/guides/maintenance/architect-lifecycle.rst index ed328711..3f3b9e69 100644 --- a/source/guides/maintenance/architect-lifecycle.rst +++ b/source/guides/maintenance/architect-lifecycle.rst @@ -34,7 +34,7 @@ Maintaining a |CL| derivative requires: * Integrating Quality Assurance for testing and validation Coordinated infrastructure is deployed to automate the life-cycle -of your |CL| derivative. We divide deployment of this infrastucture in two +of your |CL| derivative. We divide deployment of this infrastructure in two parts: *Content Workflow*; and *Release Workflow*, shown in Figure 1. .. figure:: figures/architect-lifecycle-1.png diff --git a/source/guides/maintenance/resource-limits.rst b/source/guides/maintenance/resource-limits.rst index c753992f..670aff68 100644 --- a/source/guides/maintenance/resource-limits.rst +++ b/source/guides/maintenance/resource-limits.rst @@ -8,7 +8,7 @@ service for system resources and contain rogue processes. These limits are layered at the system-level and user-level. If these limits need to be modified, it is useful to understand the different limit -configurations. +configurations. .. contents:: :local: :depth: 2 @@ -16,13 +16,13 @@ configurations. System-wide limits ================== - + Some global resource limits are implemented in the Linux kernel and are -controllable with kernel parameters. +controllable with kernel parameters. For example, a global limit for the maximum number of open files is set with the *fs.file-max* parameter. This limit applies to all processes and users an -cannot be exceeded other limit values. +cannot be exceeded other limit values. Checking limit ************** @@ -31,15 +31,15 @@ You can check a current value with :command:`sysctl -n `. For example: .. code:: bash - + sysctl -n fs.file-max - + This *fs.file-max* value is set intentionally high on |CL| systems by default. You can check the maximum value supported by the system with: .. code:: - + cat /proc/sys/fs/file-max @@ -52,7 +52,7 @@ example: .. code:: bash sudo sysctl -w fs.file-max= - + If needed permanently, the value can be set by creating a :file:`/etc/sysctl.d/*.conf` file (see :command:`man sysctl.d` for details). For example: @@ -84,16 +84,16 @@ number of open file descriptors for the current user: ulimit -S -n -See :command:`man limits.conf` for details. +See :command:`man limits.conf` for details. Service limits ============== Resource limits for services started with systemd units do not follow normal -user limits because the process is started in a seperate `Linux control group +user limits because the process is started in a separate `Linux control group (cgroup) `_ Linux -cgroups associate related process groups and provide resource accounting. +cgroups associate related process groups and provide resource accounting. Resource limits for individual systemd services can be controlled inside their unit files or its configuration drop-in directory with the resource Limit @@ -102,22 +102,13 @@ directives. See `process properties section of the systemd.exec man page Resource limits for all systemd services can be controlled with a file in the :file:`/etc/systemd/system.conf.d/` directory. For example, to have no -restriction on the number of open files: +restriction on the number of open files: .. code:: - + sudo mkdir -p /etc/systemd/system.conf.d/ sudo tee /etc/systemd/system.conf.d/50-nfiles.conf > /dev/null <<'EOF' [Manager] DefaultLimitNOFILE=infinity EOF - - - - - - - - - diff --git a/source/guides/network/openssh-server.rst b/source/guides/network/openssh-server.rst index a21032ba..ff0b1b38 100644 --- a/source/guides/network/openssh-server.rst +++ b/source/guides/network/openssh-server.rst @@ -155,7 +155,7 @@ Enable X11-forwarding ********************* X11 forwarding allows you to securely run graphical applications (that is, X -clients) over the SSH conection. This enables remote GUI apps without the need +clients) over the SSH connection. This enables remote GUI apps without the need for full VNC or remote desktop setup. To enable X11-forwarding via SSH, perform the following steps: diff --git a/source/guides/network/vnc.rst b/source/guides/network/vnc.rst index a734a782..6939cde2 100644 --- a/source/guides/network/vnc.rst +++ b/source/guides/network/vnc.rst @@ -59,18 +59,18 @@ your |CL| host: - The system administrator sets up a systemd service script for you with a pre-assigned display ID. You make a VNC connection and supply your pre-assigned display ID. - - The system adminstrator configures GDM to accept connection requests. + - The system administrator configures GDM to accept connection requests. When you make a VNC connection to the |CL| host, you see the GDM login screen and authenticate as if you are local. * - Who configures VNC settings? - You - - System adminstrator - - System adminstrator + - System administrator + - System administrator * - Who starts VNC session? - You - Set to start automatically on boot by system administrator - Set to start automatically on boot by system administrator - * - Who ends VNC sesssion? + * - Who ends VNC session? - You - You - System administrator can disable VNC service altogether diff --git a/source/guides/stacks/dbrs.rst b/source/guides/stacks/dbrs.rst index 26e2d490..e963f31e 100644 --- a/source/guides/stacks/dbrs.rst +++ b/source/guides/stacks/dbrs.rst @@ -507,7 +507,7 @@ In order to configure the Apache Cassandra PMEM cluster some variables and value * image.repository: The address of the container registry where the cassandra-pmem image should be pulled * image.tag: The tag of the image to be pulled during deployment * image.name: The name of the image to be pulled during deployment -* pmem.containerPmemAllocation: The size of the persistent volume claim to be used as heap, it uses the storage class `pmem-csi-sc-ext4` from pmem-csi The size of the fsdax pool to be created inside the persistent volume claim, in practice it shuld be `1G` less than pmem.containerPmemAllocation +* pmem.containerPmemAllocation: The size of the persistent volume claim to be used as heap, it uses the storage class `pmem-csi-sc-ext4` from pmem-csi The size of the fsdax pool to be created inside the persistent volume claim, in practice it should be `1G` less than pmem.containerPmemAllocation * pmem.fsdaxPoolSizeInGB: The size of the fsdax pool to be created inside the persistent volume claim, in practice it should be 1G less than pmem.containerPmemAllocation * enablePersistence: If set to `true`, K8s persistent volumes are deployed to store data and logs * persistentVolumes.logsVolumeSize: The size of the persistent volume used for storing logs on each node, the default is `4G` @@ -518,7 +518,7 @@ In order to configure the Apache Cassandra PMEM cluster some variables and value * exposeJmxPort: When set to `true` it exposes the JMX port as part of the Kubernetes headless service. It should be used together with `enableAdditionalFilesConfigMap` in order to provide authentication files needed for JMX when the remote connections are allowed. When set to `false` only local access through 127.0.0.1 is granted and no additional authentication is needed. * enableClientToolsPod: If set to `true`, an additional pod independent from the cluster is deployed, this pod contains various Cassandra client tools and mounts test profiles located under `/files/testProfiles` to `/testProfiles` inside the pod. This pod is useful to test and launch benchmarks * enableAdditionalFilesConfigMap: When set to true, it takes the files located in `/files/additionalFiles` and mount them in `/etc/cassandra` inside the pods, some additional files for cassandra can be stored here, such as JMX auth files -* jvmOpts.enabled: If set to `true` the environment variable `JVM_OPTS` is overriden with the value provided on jvmOpts.value +* jvmOpts.enabled: If set to `true` the environment variable `JVM_OPTS` is overridden with the value provided on jvmOpts.value * jvmOpts.value: Sets the value of the environment variable `JVM_OPTS`, in this way some java runtime configurations can be provided such as RAM heap usage * resources.enabled: if set to `true`, the resource constraints are set on each pod using the values under resources.requests and resources.limits * resources.requests.memory: Initial resource allocation for each pod in the cluster diff --git a/source/guides/stacks/dlrs.rst b/source/guides/stacks/dlrs.rst index 06d49686..843a87b5 100644 --- a/source/guides/stacks/dlrs.rst +++ b/source/guides/stacks/dlrs.rst @@ -387,7 +387,7 @@ Pre-requisites .. note:: - Instead of using Arrikto's configuration manifest as shown in the preceeding example, you should use the manifest provided by `Istio`_, for this example, as Seldon deployments depend on it. + Instead of using Arrikto's configuration manifest as shown in the preceding example, you should use the manifest provided by `Istio`_, for this example, as Seldon deployments depend on it. #. Install deployment tools @@ -531,7 +531,7 @@ In this example, you will: #. Run the Model Optimizer - Running the model optimizer is as simple as calling the appropriate script, however there are many configuration options that are explainedin the documentation + Running the model optimizer is as simple as calling the appropriate script, however there are many configuration options that are explained in the documentation .. code-block:: bash diff --git a/source/reference/image-types.rst b/source/reference/image-types.rst index cc5d1325..3529e5d6 100644 --- a/source/reference/image-types.rst +++ b/source/reference/image-types.rst @@ -21,7 +21,7 @@ The naming convention of a |CL| image filename is: file format. * The *[compression type]* field specifies the compression type. Two types of - compressions are used: GNU\* zip (*.gz*) and XZ (*.xz*). + compression methods are used: GNU\* zip (*.gz*) and XZ (*.xz*). .. _incl-image-filename-end: @@ -80,8 +80,7 @@ Table 2 lists the currently available images that are platform specific. - Image suitable for use with PXE server. * - vmware.vmdk - - Virtual Machine Disk for VMware\* platforms inclduing Player, Workstation, and ESXi. + - Virtual Machine Disk for VMware\* platforms including Player, Workstation, and ESXi. .. _images: https://clearlinux.org/downloads .. _`optimized kernel`: https://clearlinux.org/documentation/clear-linux/reference/compatible-kernels - diff --git a/source/tutorials/docker.rst b/source/tutorials/docker.rst index 5dc10dfc..3d459d0c 100644 --- a/source/tutorials/docker.rst +++ b/source/tutorials/docker.rst @@ -15,7 +15,7 @@ This tutorial covers: .. note:: - This tutorial focuses on the installaton of the Docker ecosystem. + This tutorial focuses on the installation of the Docker ecosystem. If you want to use |CL| as a Docker container image, refer to the official |CL| container image `published on Docker* Hub `_ @@ -146,7 +146,7 @@ typically located at :file:`/etc/docker/daemon.json`. |CL| features a Pulling and running an image from Docker Hub ******************************************** -`Docker Hub`_ is a publically available container image repository which +`Docker Hub`_ is a publicly available container image repository which comes pre-configured with Docker. In the example below we will pull and run an the official Docker image for nginx\*, an open source reverse proxy server. @@ -239,4 +239,4 @@ Related topics .. _OverlayFS storage driver: https://docs.docker.com/storage/storagedriver/overlayfs-driver/ -.. _Docker Device Mapper storage driver: https://docs.docker.com/storage/storagedriver/device-mapper-driver/ \ No newline at end of file +.. _Docker Device Mapper storage driver: https://docs.docker.com/storage/storagedriver/device-mapper-driver/