From 3f97fbf48952ed010c478a592c5062a417132abd Mon Sep 17 00:00:00 2001 From: Lisa Pettyjohn Date: Wed, 31 May 2023 09:46:34 -0400 Subject: [PATCH] Adding storage gloss terms --- .../general_conventions/a.adoc | 35 ++++ .../general_conventions/b.adoc | 81 ++++++++- .../general_conventions/c.adoc | 93 +++++++++- .../general_conventions/d.adoc | 125 ++++++++++++++ .../general_conventions/e.adoc | 50 +++++- .../general_conventions/f.adoc | 24 +++ .../general_conventions/g.adoc | 22 +++ .../general_conventions/h.adoc | 22 +++ .../general_conventions/i.adoc | 34 ++++ .../general_conventions/l.adoc | 33 ++++ .../general_conventions/m.adoc | 22 +++ .../general_conventions/n.adoc | 35 +++- .../general_conventions/o.adoc | 22 +++ .../general_conventions/p.adoc | 96 ++++++++++- .../general_conventions/r.adoc | 24 ++- .../general_conventions/s.adoc | 161 +++++++++++++++++- .../general_conventions/t.adoc | 48 +++++- .../general_conventions/u.adoc | 13 +- .../general_conventions/v.adoc | 33 ++++ .../general_conventions/w.adoc | 11 ++ 20 files changed, 965 insertions(+), 19 deletions(-) diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc index 1ae7a642..bd0ab91b 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc @@ -65,6 +65,17 @@ _Specify the system architecture of your cluster, such as `x86_64` or `aarch64`. *See also*: +[[access-mode]] +==== image:images/yes.png[yes] access mode (noun) +*Description*: _Access mode_ is the concurrency method used when accessing a storage component, such as `readwriteonce` or `readwritemany`. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[access-token]] ==== image:images/yes.png[yes] access token *Description*: An _access token_ is a token that can be provided as part of an HTTP request that grants access to the service being invoked on. This is part of the OpenID Connect and OAuth 2.0 specification. @@ -588,6 +599,30 @@ The term "autodetect" is in the Vale rules and should trigger a GitHub error rep *See also*: +[[availability]] +==== image:images/caution.png[with caution] availability (adjective) +*Description*: _Availability_ is the state of being available to perform work in a system, in the context of high availability or availability zones. + +Ensure that "availability" is not erroneously used to indicate that a server or disk is online or available. For example, do not say "the server has availability". + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:high-availability[high-availability], xref:availability-zone[availability zone] + +[[availability-zone]] +==== image:images/yes.png[yes] availability zone (noun) +*Description*: A logical context or geographical region used to provide high availability. This grouping can be defined by a technology or according to unique use cases. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:high-availability[high-availability] + [[cli]] ==== image:images/yes.png[yes] Azure CLI 2.0 (noun) *Description*: In Microsoft Azure, the _Azure CLI 2.0_ is a set of open source commands for managing Microsoft Azure platform resources. Typing `az` at the CLI command prompt lists each of the many Microsoft Azure subcommands. Azure CLI 2.0 is the most current command-line interface and is replacing Microsoft Azure Xplat-CLI. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/b.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/b.adoc index 93c450e6..e504b30e 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/b.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/b.adoc @@ -64,6 +64,17 @@ *See also*: xref:bare-metal-n[bare metal (noun)] +[[bare-metal-service]] +==== image:images/yes.png[yes] Bare Metal service (noun) +*Description*: The _Bare Metal service_ is a Red{nbsp}Hat OpenStack Platform product that provisions bare metal machines. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[base-dn]] ==== image:images/yes.png[yes] base DN (noun) *Description*: In an LDAP directory, the _base distinguished name (DN)_ defines the starting point for operations, such as searches. @@ -178,6 +189,17 @@ The practice of having both modes together is often referred to as _hybrid_, _ag *See also*: +[[bind-v]] +==== image:images/yes.png[yes] bind (verb) +*Description*: To _bind_ is to associate two or more objects in a particular scope. For example, in OpenShift Container Storage, when a persistent volume claim is created, a persistent volume that matches the claim's requirements is bound to the persistent volume claim. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:bind[BIND (noun)] + [[bind-dn]] ==== image:images/yes.png[yes] bind DN (noun) *Description*: A _distinguished name (DN)_ defines the unique location of an entry in the LDAP directory. You can use the DN of an entry to bind (authenticate) to an LDAP directory. The bind DN is similar to a user name in other systems. @@ -187,7 +209,7 @@ The practice of having both modes together is often referred to as _hybrid_, _ag [.vale-ignore] *Incorrect forms*: -*See also*: xref:distinguished-name[distinguished name] +*See also*: xref:distinguished-name[distinguished name], xref:bind-v[bind (verb)] [[bios]] ==== image:images/caution.png[with caution] BIOS (noun) @@ -213,6 +235,39 @@ Do not use "BIOS" as a generic term for computer firmware. Instead, write "firmw *See also*: +[[block-device]] +==== image:images/caution.png[with caution] block device (noun) +*Description*: A _block device_ is a physical storage device that supports reading and writing data in groups (blocks) of bytes in any order. Do not confuse this term with "block storage" (cloud storage) or "block volume" (OpenShift Virtualization). + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: block storage, block volume + +*See also*: xref:block-storage[block storage], xref:block-volume[block volume] + +[[block-storage]] +==== image:images/caution.png[with caution] block storage (noun) +*Description*: _Block storage_, as distinct from file storage and object storage, breaks data into chunks that are arbitrarily organized and distributed. These chunks can then be further partitioned and treated as individual storage devices. Do not confuse this term with "block device" (generic) or "block volume" (OpenShift Virtualization). + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: block device, block volume + +*See also*: xref:block-device[block device], xref:block-volume[block volume] + +[[block-volume]] +==== image:images/caution.png[with caution] block volume (noun) +*Description*: A _block volume_ is a physical volume that supports `Block` as opposed to `Filesystem` data formats. Block data are raw chunks of data that are not compatible with any predefined file system mechanism, such as NFS. Do not confuse this term with "block device" (generic) or "block storage" (cloud storage). + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: block device, block storage + +*See also*: xref:block-device[block device], xref:block-storage[block storage] + [[blueprint]] ==== image:images/yes.png[yes] blueprint (noun) *Description*: In Red{nbsp}Hat Enterprise Linux, _blueprints_ are simple text files in Tom's Obvious Minimal Language (TOML) format that describe which packages, and what versions, to install into the image. They can also define a limited set of customizations that can be used to build the final image. @@ -268,6 +323,17 @@ Do not use "BIOS" as a generic term for computer firmware. Instead, write "firmw *See also*: +[[boot-source]] +==== image:images/yes.png[yes] boot source (noun) +*Description*: A _boot source_ is a system image containing a bootable operating system (OS) and all of the configuration settings for the OS, such as drivers. Boot sources can be used to create virtual machine templates with specific configurations. These templates can be used to create any number of available virtual machines. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: bootsource, boot-source + +*See also*: + [[bottleneck]] ==== image:images/yes.png[yes] bottleneck (noun) *Description*: A _bottleneck_ is a limitation in the capacity of software or hardware caused by a single component. @@ -312,6 +378,17 @@ Do not use "BIOS" as a generic term for computer firmware. Instead, write "firmw *See also*: xref:Bps[Bps] +[[brick]] +==== image:images/yes.png[yes] brick (noun) +*Description*: A _brick_ is an exported directory on a server that is in a trusted storage pool. It is the basic unit of storage in Red{nbsp}Hat Gluster Storage. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[broadcast-n]] ==== image:images/yes.png[yes] broadcast (noun) *Description*: When used as a noun, a _broadcast_ is a message sent simultaneously to multiple recipients. Broadcasting is a useful feature in email systems. It is also supported by some fax systems. In networking, a distinction is made between broadcasting and multicasting. Broadcasting sends a message to everyone on the network, whereas multicasting sends a message to a select list of recipients. @@ -391,7 +468,7 @@ Do not use "BIOS" as a generic term for computer firmware. Instead, write "firmw [[bucket]] ==== image:images/yes.png[yes] bucket (noun) -*Description*: 1) A _bucket_ in the S3 API contains objects. A bucket also defines access control lists (ACLs). Unlike folders or directories, buckets cannot contain other buckets. A bucket in the S3 API is synonymous with a _container_ in the Swift API. 2) The term "bucket" is also sometimes used in the context of a _CRUSH hierarchy_, but CRUSH buckets and S3 buckets are mutually exclusive concepts. +*Description*: (1) A _bucket_ in the S3 API contains objects. A bucket also defines access control lists (ACLs). Unlike folders or directories, buckets cannot contain other buckets. A bucket in the S3 API is synonymous with a _container_ in the Swift API. (2) The term "bucket" is also sometimes used in the context of a _CRUSH hierarchy_, but CRUSH buckets and S3 buckets are mutually exclusive concepts. *Use it*: yes diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/c.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/c.adoc index f3bb2945..8b43ca21 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/c.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/c.adoc @@ -301,7 +301,11 @@ [[client]] ==== image:images/yes.png[yes] client -*Description*: In Red{nbsp}Hat Single Sign-On, a _client_ is an entity that can request Red{nbsp}Hat Single Sign-On to authenticate a user. Most often, clients are applications and services that want to use Red{nbsp}Hat Single Sign-On to secure themselves and provide a single sign-on solution. Clients are also entities that request identity information or an access token so that they can securely invoke other services on the network that are secured by Red{nbsp}Hat Single Sign-On. +*Description*: _Client_ has multiple meanings, depending on the context: + +* Generically, a _client_ is an entity, such as a machine, process, service, or application, that uses a service provided by a server. Avoid using "client" to refer to an application that manages configuration of such clients or to refer to applications, tools, and so on. + +* In Red{nbsp}Hat Single Sign-On, a _client_ is an entity that can request Red{nbsp}Hat Single Sign-On to authenticate a user. Most often, clients are applications and services that want to use Red{nbsp}Hat Single Sign-On to secure themselves and provide a single sign-on solution. Clients are also entities that request identity information or an access token so that they can securely call other services on the network that are secured by Red{nbsp}Hat Single Sign-On. *Use it*: yes @@ -354,6 +358,28 @@ *See also*: +[[clone-n]] +==== image:images/yes.png[yes] clone (noun) +*Description*: A _clone_ is a full data copy from an existing volume or disk drive to a new volume or disk drive. This process is not the same as a virtual machine clone, which copies both storage and configuration. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:clone-v[clone (verb)] + +[[clone-v]] +==== image:images/yes.png[yes] clone (verb) +*Description*: _Cloning_ is the process of making a full data copy from an existing volume or disk drive to a new volume or disk drive. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:clone-n[clone (noun)] + [[cloudbursting]] ==== image:images/yes.png[yes] cloudbursting (verb) *Description*: _Cloudbursting_ is an event where a private cloud exceeds its capacity and _bursts_ into and uses public cloud resources. @@ -365,6 +391,17 @@ *See also*: +[[cloud-storage]] +==== image:images/yes.png[yes] cloud storage (noun) +*Description*: _Cloud storage_ refers to data or objects that are saved, accessed, and managed remotely, such as over a network. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[cloudwashing]] ==== image:images/yes.png[yes] cloudwashing (verb) *Description*: _Cloudwashing_ is the process of rebranding legacy products to include the term "cloud" to increase their appeal to the cloud market. @@ -378,7 +415,7 @@ [[cluster]] ==== image:images/yes.png[yes] cluster (noun) -*Description*: 1) A _cluster_ is a collection of interconnected computers working together as an integrated computing resource. Clusters are referred to as the _High Availability Add-On_ in Red{nbsp}Hat Enterprise Linux 6 and later. 2) In OpenShift context, a _cluster_ is the collection of controllers, pods, and services and related DNS and networking routing configuration that are defined on the system. Typically, a cluster is made up of multiple OpenShift hosts (masters, nodes, etc.) working together, across which the aforementioned components are distributed or running. +*Description*: (1) A _cluster_ is a collection of interconnected computers working together as an integrated computing resource. Clusters are referred to as the _High Availability Add-On_ in Red{nbsp}Hat Enterprise Linux 6 and later. (2) In OpenShift context, a _cluster_ is the collection of controllers, pods, and services and related DNS and networking routing configuration that are defined on the system. Typically, a cluster is made up of multiple OpenShift hosts (masters, nodes, etc.) working together, across which the aforementioned components are distributed or running. *Use it*: yes @@ -530,6 +567,17 @@ *See also*: +[[compression]] +==== image:images/caution.png[with caution] compression (noun) +*Description*: Use _compression_ by itself only after first referring to the specific type of compression, for example, network compression. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[compute-node]] ==== image:images/yes.png[yes] compute node (noun) *Description*: A _compute node_ is a node that is responsible for executing workloads for cluster users. Also known as _worker nodes_. @@ -554,7 +602,7 @@ [[connection]] ==== image:images/yes.png[yes] connection (noun) -*Description*: 1) In Red{nbsp}Hat AMQ, a _connection_ is a channel for communication between two peers on a network. For AMQ, connections can be made between containers (clients, brokers, and routers). These are sometimes also called network connections. 2) In Red{nbsp}Hat Fuse Online, you create a connection using a Fuse Online connector. You can then use the connection in a Fuse Online integration. For example, using the Twitter connector, you can create multiple connections to Twitter, each of which could require unique login credentials. +*Description*: (1) In Red{nbsp}Hat AMQ, a _connection_ is a channel for communication between two peers on a network. For AMQ, connections can be made between containers (clients, brokers, and routers). These are sometimes also called _network connections_. (2) In Red{nbsp}Hat Fuse Online, you create a connection using a Fuse Online connector. You can then use the connection in a Fuse Online integration. For example, using the Twitter connector, you can create multiple connections to Twitter, each of which could require unique login credentials. *Use it*: yes @@ -587,7 +635,7 @@ [[connector]] ==== image:images/yes.png[yes] connector (noun) -*Description*: 1) In Red{nbsp}Hat AMQ, a _connector_ is a configurable entity for AMQ brokers and routers. They define an outgoing connection from either a router to another endpoint, or from a broker to another endpoint. 2) In Red{nbsp}Hat Fuse Online, a connector provides a template for creating any number of connections to a particular application or service, each of which can perform a different operation. A Camel component provides the foundation for a connector. For example, the Twitter connector, built on the Camel Twitter component, enables you to create multiple connections to Twitter. +*Description*: (1) In Red{nbsp}Hat AMQ, a _connector_ is a configurable entity for AMQ brokers and routers. They define an outgoing connection from either a router to another endpoint, or from a broker to another endpoint. (2) In Red{nbsp}Hat Fuse Online, a connector provides a template for creating any number of connections to a particular application or service, each of which can perform a different operation. A Camel component provides the foundation for a connector. For example, the Twitter connector, built on the Camel Twitter component, enables you to create multiple connections to Twitter. *Use it*: yes @@ -609,7 +657,7 @@ [[consumer]] ==== image:images/yes.png[yes] consumer (noun) -*Description*: 1) In an LDAP replication environment, _consumers_ receive data from suppliers or hubs. 2) In Red{nbsp}Hat AMQ, a _consumer_ is a client that receives messages. 3) In Red{nbsp}Hat Fuse, a _consumer_ is an endpoint that acts as the source of message exchanges entering a route. It wraps received messages in an exchange and then sends the exchange to the next node in the route. A route can have only one consumer. +*Description*: (1) In an LDAP replication environment, _consumers_ receive data from suppliers or hubs. (2) In Red{nbsp}Hat AMQ, a _consumer_ is a client that receives messages. (3) In Red{nbsp}Hat Fuse, a _consumer_ is an endpoint that acts as the source of message exchanges entering a route. It wraps received messages in an exchange and then sends the exchange to the next node in the route. A route can have only one consumer. *Use it*: yes @@ -620,7 +668,7 @@ [[container]] ==== image:images/yes.png[yes] container (noun) -*Description*: 1) A _container_ is the fundamental piece of an OpenShift application. A container is a way to isolate and limit process interactions with minimal overhead and footprint. In most cases, a container is limited to a single process providing a specific service (for example web server, database). 2) A container in the Swift API contains objects. A container also defines access control lists (ACLs). Unlike folders or directories, a container cannot contain other containers. A container in the Swift API is synonymous with a "bucket" in the S3 API. 3) In Red{nbsp}Hat AMQ, a container is a top-level application, such as a broker or client. Connections are established between containers. +*Description*: (1) A _container_ is the fundamental piece of an OpenShift application. A container is a way to isolate and limit process interactions with minimal overhead and footprint. In most cases, a container is limited to a single process providing a specific service (for example web server, database). (2) A container in the Swift API contains objects. A container also defines access control lists (ACLs). Unlike folders or directories, a container cannot contain other containers. A container in the Swift API is synonymous with a "bucket" in the S3 API. (3) In Red{nbsp}Hat AMQ, a container is a top-level application, such as a broker or client. Connections are established between containers. *Use it*: yes @@ -708,6 +756,17 @@ image repository contains one or more tagged images. *See also*: xref:api-server[API server], xref:scheduler[scheduler] +[[control-plane-node]] +==== image:images/yes.png[yes] control plane node (noun) +*Description*: In OpenShift Container Platform, _control plane node_ refers to the node that manages other nodes in its Kubernetes cluster and schedules pods to run on nodes. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: master node + +*See also*: xref:primary-node[primary node] + [[control-program]] ==== image:images/yes.png[yes] control program (noun) *Description*: A _control program_ refers to a program that enhances an operating system by creating an environment in which you can run other programs. @@ -730,6 +789,17 @@ image repository contains one or more tagged images. *See also*: +[[controller-node]] +==== image:images/yes.png[yes] controller node (noun) +*Description*: A _controller node_ is the Ansible node from which jobs are executed. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: master node + +*See also*: xref:primary-node[primary node] + [[conversion]] ==== image:images/yes.png[yes] conversion (noun) *Description*: In Red{nbsp}Hat Enterprise Linux, an operating system _conversion_ is when you convert your operating system from a different Linux distribution to Red{nbsp}Hat Enterprise Linux. @@ -774,6 +844,17 @@ image repository contains one or more tagged images. *See also*: +[[copy-v]] +==== image:images/yes.png[yes] copy (verb) +*Description*: In a data storage context, _copying_ is the process of creating a duplicate of a file in a different location. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[core-api]] ==== image:images/yes.png[yes] Core API (noun) *Description*: The _Core API_ is an API for the ActiveMQ Artemis Core protocol. It is not supported by AMQ Broker. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/d.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/d.adoc index 0c3c79e0..9aa4bfd8 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/d.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/d.adoc @@ -20,6 +20,23 @@ *See also*: xref:daisy-chain-n[daisy chain (noun)] +[[data-compression]] +==== image:images/caution.png[with caution] data compression (noun) +*Description*: _Data compression_ is a method of encoding data using fewer bits than the original data. How compression is achieved differs across products and should always be clarified. + +In Red{nbsp}Hat Enterprise Linux and solutions built on top of it, Virtual Disk Optimization (VDO) uses HIOPS compression, which operates on blocks that have not been identified as duplicates. When unique data is seen for the first time, it is compressed. Subsequent copies of data that have already been stored are then deduplicated without requiring an additional compression step. + +Migration compression is specific to Red{nbsp}Hat Virtualization, and is the compression of virtual machine image information while a running virtual machine is moved from one server to another. It uses Xor Based Zero Run Length Encoding (XBZRLE) as the compression mechanism. + +LZO compression and LZ4 compression are specific compression algorithms, so they are specific enough. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[data-enumeration]] ==== image:images/yes.png[yes] data enumeration (noun) *Description*: In Red{nbsp}Hat JBoss BRMS and Red{nbsp}Hat JBoss BPM Suite, _data enumeration_ is an optional type of asset that can be configured to provide drop-down lists for the guided decision table editor. @@ -141,6 +158,17 @@ *See also*: xref:debug-adj[debug (adjective)] +[[deduplication]] +==== image:images/yes.png[yes] deduplication (noun) +*Description*: _Deduplication_ is a feature of virtual disk optimization (VDO) that helps conserve storage space by eliminating multiple copies of duplicate blocks. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[decision-table]] ==== image:images/yes.png[yes] decision table (noun) *Description*: A _decision table_ is a collection of rules stored in either a spreadsheet or in the Red{nbsp}Hat JBoss BRMS user interface. @@ -342,6 +370,17 @@ The API object for a deployment can be either a Kubernetes-native `Deployment` o *See also*: +[[directory]] +==== image:images/yes.png[yes] directory (noun) +*Description*: A _directory_ is a special type of file in a Linux file system that contains a list of objects and their inodes. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[directory-manager]] ==== image:images/yes.png[yes] Directory Manager (noun) *Description*: In Red{nbsp}Hat Directory Server, the privileged administrative user is called the _Directory Manager_. The distinguished name (DN) of this user is cn=Directory Manager. @@ -376,6 +415,17 @@ Red{nbsp}Hat Directory Server conforms to LDAP standards. *See also*: xref:red-hat-directory-server[Red{nbsp}Hat Directory Server] +[[disaster-recovery]] +==== image:images/yes.png[yes] disaster recovery (adjective) +*Description*: _Disaster recovery_ refers to processes or methods used to ensure data integrity and the operational continuity of an environment or infrastructure during any malicious or accidental interruption. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[disconnected]] ==== image:images/yes.png[yes] disconnected (adjective) *Description*: In Red{nbsp}Hat OpenShift, use "disconnected" when discussing installing a cluster in an environment that does not have an active connection to the internet. Use "disconnected" regardless of whether the restriction is physical or logical. @@ -400,6 +450,17 @@ Red{nbsp}Hat Directory Server conforms to LDAP standards. *See also*: +[[disk-encryption]] +==== image:images/yes.png[yes] disk encryption (noun) +*Description*: _Disk encryption_ is a security feature to protect access to sensitive information stored on a disk by using mathematical functions to convert disk data into a format that cannot be deciphered easily by unauthorized processes or users. Disk encryption is also known as _block device encryption_ or _encryption at rest_. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[disk-label]] ==== image:images/yes.png[yes] disk label (noun) *Description*: A _disk label_ is a record that contains information about the location of the partitions on a disk. @@ -422,6 +483,17 @@ Red{nbsp}Hat Directory Server conforms to LDAP standards. *See also*: xref:amq-interconnect[AMQ Interconnect] +[[dispersed-volume]] +==== image:images/yes.png[yes] dispersed volume (noun) +*Description*: A _dispersed volume_ is a Gluster volume that uses erasure coding to write data across three or more bricks to ensure that data remains available even when a certain number of bricks is not available. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:brick[brick] + [[distinguished-name]] ==== image:images/yes.png[yes] distinguished name (noun) *Description*: A _distinguished name (DN)_ is a sequence of relative distinguished names (RDN) connected by commas. A DN defines the unique location of an entry in the LDAP directory. Use "distinguished name" on the first usage and then the abbreviation "DN" subsequently. @@ -442,6 +514,48 @@ Red{nbsp}Hat Directory Server conforms to LDAP standards. [.vale-ignore] *Incorrect forms*: DNF automatic, dnf automatic +[[distributed-file-system]] +==== image:images/yes.png[yes] distributed file system (noun) +*Description*: A _distributed file system_ is a file system that presents files from several different storage devices, potentially on many different machines and in many different locations, as a single interface to an end user or consuming service. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[[distributed-volume]] +==== image:images/yes.png[yes] distributed volume (noun) +*Description*: A _distributed volume_ is a Gluster volume that distributes data across one or more bricks. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[distributed-dispersed-volume]] +==== image:images/yes.png[yes] distributed-dispersed volume (noun) +*Description*: A _distributed-dispersed volume_ is a Gluster volume that distributes and erasure codes data across one or more bricks. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[[distributed-replicated-volume]] +==== image:images/yes.png[yes] distributed-replicated volume (noun) +*Description*: A _distributed-replicated volume_ is a Gluster volume that distributes and replicates data across multiple bricks. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + *See also*: [[dns]] @@ -619,3 +733,14 @@ Red{nbsp}Hat Directory Server conforms to LDAP standards. *Incorrect forms*: DVD burner, burner *See also*: + +[[dynamically-provisioned-storage]] +==== image:images/caution.png[with caution] dynamically provisioned storage (noun) +*Description*: _Dynamically provisioned storage_ is a data repository that changes in size depending on the current demand of the application or the user. In OpenShift Container Platform and OpenShift Data Foundation, use "dynamic volume provisioning" to refer to the related `StorageClass` configuration parameter. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/e.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/e.adoc index 4f3252e3..b2f59462 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/e.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/e.adoc @@ -84,9 +84,31 @@ If referring to the program, use "Emacs", for example, "Source-Navigator support *See also*: +[[encrypted-disk]] +==== image:images/yes.png[yes] encrypted disk (noun) +*Description*: An _encrypted disk_ contains data that has been encoded for the purpose of ensuring data security. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[[encryption]] +==== image:images/yes.png[yes] encryption (noun) +*Description*: _Encryption_ is the encoding of data, either at-rest or in-transit, for the purpose of ensuring data security. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[endpoint]] ==== image:images/caution.png[with caution] endpoint (noun) -*Description*: 1) The servers that back a service. 2) In Red{nbsp}Hat Fuse, an _endpoint_ provides the starting and terminal ends of a Camel route through which an external system or service can send or receive messages. You use Camel components to create and configure endpoints. +*Description*: (1) The servers that back a service. (2) In Red{nbsp}Hat Fuse, an _endpoint_ provides the starting and terminal ends of a Camel route through which an external system or service can send or receive messages. You use Camel components to create and configure endpoints. *Use it*: with caution @@ -128,6 +150,17 @@ If referring to the program, use "Emacs", for example, "Source-Navigator support *See also*: +[[ephemeral-storage]] +==== image:images/yes.png[yes] ephemeral storage (noun) +*Description*: _Ephemeral storage_ is a temporary storage location that only exists while an individual pod exists, and that cannot be shared by multiple pods. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[essentially]] ==== image:images/no.png[no] essentially (adverb) *Description*: Do not use "essentially". It does not add anything to the sentence. @@ -141,7 +174,7 @@ If referring to the program, use "Emacs", for example, "Source-Navigator support [[event]] ==== image:images/yes.png[yes] event (noun) -*Description*: 1) An _event_ is an action or occurrence detected by a program. Events can be user actions, such as clicking a mouse button or pressing a key, or system occurrences, such as running out of memory. 2) An event is an audit stream that administrators view and connect to. +*Description*: (1) An _event_ is an action or occurrence detected by a program. Events can be user actions, such as clicking a mouse button or pressing a key, or system occurrences, such as running out of memory. (2) An event is an audit stream that administrators view and connect to. *Use it*: yes @@ -226,3 +259,16 @@ Capitalize "extranet" only at the beginning of a sentence. *Incorrect forms*: Extranet *See also*: + +[[external-mode]] +==== image:images/caution.png[with caution] external mode (noun) +*Description*: In the context of externally hosted storage services, _external mode_ refers to a deployment of Red{nbsp}Hat OpenShift Container Storage that uses externally hosted Red{nbsp}Hat Ceph Storage (RHCS) clusters to provide storage. This OpenShift Container Storage deployment type is supported for bare metal and user-provisioned VMware environments. + +Use this term only in OpenShift Container Storage. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/f.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/f.adoc index f99ce6e1..cd05a5bb 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/f.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/f.adoc @@ -80,6 +80,17 @@ Use the hyphenated "fault-tolerant" when using it as an adjective. *See also*: +[[file-storage]] +==== image:images/yes.png[yes] file storage (noun) +*Description*: _File storage_ refers to a repository of files and directories organized in a hierarchical way, as distinct from block storage or object storage. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:block-storage[block storage], xref:object-storage[object storage] + [[filestore]] ==== image:images/yes.png[yes] FileStore (noun) *Description*: In Red{nbsp}Hat Ceph Storage, _FileStore_ is an OSD back end responsible for the OSD data that writes objects as files on a file system. @@ -203,6 +214,19 @@ Do not use "Firewire" or "firewire". Although FireWire is a trademark of Apple C *See also*: +[[fuse]] +==== image:images/caution.png[with caution] FUSE +*Description*: _FUSE_ (File system in USEr Space) is a software interface for Linux and Linux-like systems that lets non-privileged users create and configure their own file systems without interacting directly with kernel code. + +Use with caution. It is more typical to refer to _FUSE-compatible_ or _FUSE-compliant_ systems rather than FUSE itself. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[fuse-online]] ==== image:images/yes.png[yes] Fuse Online (noun) *Description*: _Fuse Online_ is the short product name for "Red{nbsp}Hat Fuse Online". diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/g.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/g.adoc index e6ca480d..a2ced151 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/g.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/g.adoc @@ -122,6 +122,17 @@ When referring to the command, use pass:q[`g++`], marked up appropriately. *See also*: xref:gdb[GDB], xref:insight[Insight] +[[geo-replication]] +==== image:images/caution.png[with caution] geo-replication (noun) +*Description*: (1) In Red{nbsp}Hat Gluster Storage and related solutions, _geo-replication_ refers to asynchronous replication of data in a Gluster file system from one location to another across a network. (2) In Red{nbsp}Hat Quay, _geo-replication_ refers to replication of data from one central storage engine to other storage engines. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[gid]] ==== image:images/yes.png[yes] GID (noun) *Description*: _GID_ is an abbreviation for "Group ID". Do not use "gid". @@ -166,6 +177,17 @@ When referring to the command, use pass:q[`g++`], marked up appropriately. *See also*: +[[gluster-volume]] +==== image:images/yes.png[yes] gluster volume (noun) +*Description*: A _gluster volume_ is a logical collection of bricks across one or more servers in a trusted storage pool. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:brick[brick] + [[gnome]] ==== image:images/yes.png[yes] GNOME (noun) *Description*: _GNOME_ is an open source desktop environment for operating systems that are similar to the UNIX system. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/h.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/h.adoc index afc634ca..157c3aa8 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/h.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/h.adoc @@ -111,6 +111,17 @@ Hidden replicas are primarily designed for services such as backups, bulk import *See also*: xref:high-availability-noun[high availability] +[[high-availability-cluster]] +==== image:images/yes.png[yes] high-availability cluster (noun) +*Description*: A _high-availability cluster_ is a group of physical or virtual machines that can share work between themselves in order to allow services and resources to be available even if one or more machines in the cluster is offline. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:availability[availability] + [[high-performance-computing]] ==== image:images/yes.png[yes] high-performance computing (noun) *Description*: _High-performance computing_ is the use of parallel processing to obtain more efficient processing of complex programs. Use standard hyphenation guidelines to maintain clarity. @@ -309,6 +320,17 @@ Hidden replicas are primarily designed for services such as backups, bulk import *See also*: +[[hyperconverged-cluster]] +==== image:images/yes.png[yes] hyperconverged cluster (noun) +*Description*: A _hyperconverged cluster_ is a generic phrase that refers to the set of physical machines providing compute and storage capabilities in a Red{nbsp}Hat Hyperconverged Infrastructure for Virtualization (RHHI-V) or Red{nbsp}Hat Hyperconverged Infrastructure for Cloud (RHHI-C) cluster. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: hyper converged cluster, hyper-converged cluster + +*See also*: + [[hypervisor]] ==== image:images/yes.png[yes] hypervisor (noun) *Description*: A _hypervisor_ is software that runs virtual machines. Only capitalize the initial "H" at the beginning of a sentence or as part of Red{nbsp}Hat Enterprise Virtualization Hypervisor. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc index acdb5266..f4c292df 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc @@ -381,6 +381,17 @@ There is no functional difference between the first server that was installed an *See also*: +[[infrastructure-node]] +==== image:images/yes.png[yes] infrastructure node (noun) +*Description*: An _infrastructure node_ is a node that is labeled to run pieces of the OpenShift Container Platform environment, as distinct from a node intended to run applications. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[ingress]] ==== image:images/yes.png[yes] ingress (noun, adjective) *Description*: In Red{nbsp}Hat OpenShift, _Ingress_ is a Kubernetes API object that developers can use to expose services within the cluster through an HTTP(S) load balancer and a proxy layer by using a public DNS entry. The `Ingress` resource defines the cluster-wide configuration for ingress traffic, and provides the ability to specify TLS options, a certificate, or a public CNAME that the OpenShift `IngressController` object can accept for HTTP(S) traffic. Additionally, _ingress_ can also be used to describe the incoming direction of network traffic. In Red{nbsp}Hat OpenShift, for example, this traffic is described as entering (ingress) or leaving (egress) an OpenShift cluster. @@ -416,6 +427,17 @@ Always use `Ingress` with markup when referencing the `Ingress` resource or `Ing *See also*: +[[initiator]] +==== image:images/yes.png[yes] initiator (noun) +*Description*: An _initiator_ is the consumer of storage from a target. An initiator is typically a server with an adapter card. The initiator starts a connection over the network fabric to one or more target ports on a storage system. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[inject]] ==== image:images/yes.png[yes] inject (verb) *Description*: When data is _injected_, an object or function receives other required objects or functions from external code instead of creating them internally. To _inject_ can also mean to populate application input fields with embedded control or command sequences. @@ -424,6 +446,7 @@ Red{nbsp}Hat Trusted Application Pipeline users can configure secrets to inject *Use it*: yes +[.vale-ignore] *Incorrect forms*: *See also*: @@ -588,6 +611,17 @@ _This feature can run only on Intel 64 processors_ *See also*: +[[internal-mode]] +==== image:images/yes.png[yes] internal mode (noun) +*Description*: _Internal-mode_ describes using Red{nbsp}Hat OpenShift Container Storage where all components of OpenShift Container Storage are deployed within a cluster managed by OpenShift Container Platform and benefit from Operator-based deployment and management. For example, this situation can occur when you are using internally hosted services. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[interpreted-code]] ==== image:images/yes.png[yes] interpreted code (noun) *Description*: In Red{nbsp}Hat Enterprise Linux, _interpreted code_ is source code that runs step-by-step, without prior transformations by a language interpreter or a language virtual machine. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/l.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/l.adoc index 4a1cebbc..62b4fcb5 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/l.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/l.adoc @@ -185,6 +185,17 @@ *See also*: +[[local-storage]] +==== image:images/yes.png[yes] local storage (noun) +*Description*: _Local storage_ is a method to save, access, and manage data or objects on hardware devices that are part of or closely connected to the machine accessing the data, such as hard drives, solid state drives, or external storage devices. In OpenShift Container Storage, local storage affects scheduling, as local storage can only be accessed by processes running on the node that the storage is physically attached to. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[logging]] ==== image:images/yes.png[yes] logging subsystem (noun) *Description*: In Red{nbsp}Hat JBoss Enterprise Application Platform, the _logging subsystem_ is used to configure logging at the system and application levels. Write in lowercase in general text. Use "Logging subsystem" when referring to the logging subsystem in titles and headings. @@ -196,6 +207,17 @@ *See also*: +[[logical-cache]] +==== image:images/yes.png[yes] logical cache (noun) +*Description*: A _logical cache_ is a caching mechanism used to improve the performance of a logical volume. Typically, a smaller and faster device is used to improve I/O performance of a larger and slower logical volume. A logical cache is also known as a _virtual cache_ or _LVM cache_. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[logical-topology]] ==== image:images/yes.png[yes] logical topology (noun) *Description*: Every LAN has a topology, or the way that the devices on a network are arranged and how they communicate with each other. The _logical topology_ (or _signal topology_) is the way that the signals act on the network media, or the way that the data passes through the network from one device to the next without regard to the physical interconnection of the devices. @@ -207,6 +229,17 @@ *See also*: xref:physical-topology[physical topology], xref:signal-topology[signal-topology] +[[logical-volume]] +==== image:images/yes.png[yes] logical volume (noun) +*Description*: A _logical volume_ is a virtual, block storage device that a file system, database, or application can use. To create a logical volume, physical volumes are combined into a volume group (VG). This process creates a pool of disk space out of which logical volumes (LVs) can be allocated. Note that Logical Volume Manager (LVM) is the device mapper framework that provides logical volume management for the Linux kernel. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[loopback-address]] ==== image:images/yes.png[yes] loopback address (noun) *Description*: The _loopback address_ is a special IP address (127.0.0.1 for IPv4, ::1 for IPv6) that is designated for the software loopback interface of a machine. The loopback interface has no hardware associated with it, and it is not physically connected to a network. The loopback interface allows IT professionals to test IP software without worrying about broken or corrupted drivers or hardware. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/m.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/m.adoc index 3b9dc748..39fdbafb 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/m.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/m.adoc @@ -339,6 +339,17 @@ *See also*: xref:messaging-activemq-management[Messaging - ActiveMQ], xref:messaging-subsystem[messaging subsystem] +[[metadata]] +==== image:images/yes.png[yes] metadata (noun) +*Description*: _Metadata_ is a generic term for data that provides information about one or more other pieces of data. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[metadata-server]] ==== image:images/yes.png[yes] Metadata Server (noun) *Description*: In Red{nbsp}Hat Ceph Storage, "Metadata Server" is another name for the `ceph-mds` daemon. @@ -585,6 +596,17 @@ Azure CLI 2.0 is the most current command-line interface and is replacing Xplat- *See also*: +[[multipath]] +==== image:images/caution.png[with caution] multipath (noun) +*Description*: Device Mapper _Multipath_ Input Output (DM-MPIO), also known as DM _Multipathing_ or _multipath_, is a Linux utility that enables multiple input/output paths between server nodes and storage arrays to be configured into a single device path to provide redundancy and improve performance. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[multiprocessing]] ==== image:images/yes.png[yes] multiprocessing (noun) *Description*: _Multiprocessing_ is the use of two or more central processing units within a single computer system. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc index b4265991..496a4ebf 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc @@ -131,6 +131,17 @@ *See also*: +[[network-encryption]] +==== image:images/yes.png[yes] network encryption (noun) +*Description*: _Network encryption_ refers to the encoding of data that is in transit across a network, for the purpose of ensuring data security. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[network-interface-card]] ==== image:images/no.png[no] network interface card *Description*: Do not use "network interface card" for the acronym "NIC". Use "network interface controller" instead. @@ -164,6 +175,17 @@ *See also*: +[[network-time-configuration]] +==== image:images/yes.png[yes] Network Time Configuration (noun) +*Description*: _Network Time Configuration_ refers to using NTP (Network Time Protocol) to synchronize time settings across all storage servers. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[network-transparency]] ==== image:images/yes.png[yes] network transparency (noun) @@ -190,7 +212,7 @@ [[node]] ==== image:images/yes.png[yes] node (noun) -*Description*: 1) In networks, a _node_ is a processing location. A node can be a computer or other device, such as a printer. Every node has a unique network address, sometimes called a Data Link Control (DLC) address or Media Access Control (MAC) address. In tree structures, a _node_ is a point where two or more lines meet. 2) In the context of OpenShift, a _node_ provides the runtime environments for containers. 3) In the context of OpenStack, a _node_ is a machine running a particular OpenStack service, for example, "a Networking node". Exceptions: In a virtualization use case where the machine resources are being used to host virtual machines, use "host" instead of "node", for example, "a Compute host". +*Description*: (1) In networks, a _node_ is a processing location. A node can be a computer or other device, such as a printer. Every node has a unique network address, sometimes called a Data Link Control (DLC) address or Media Access Control (MAC) address. In tree structures, a _node_ is a point where two or more lines meet. (2) In the context of OpenShift, a _node_ provides the runtime environments for containers. (3) In the context of OpenStack, a _node_ is a machine running a particular OpenStack service, for example, "a Networking node". Exceptions: In a virtualization use case where the machine resources are being used to host virtual machines, use "host" instead of "node", for example, "a Compute host". *Use it*: yes @@ -211,3 +233,14 @@ If your release notes are based on the templates in this guide's xref:release-no *Incorrect forms*: right now *See also*: xref:release-notes[Release notes] + +[[n-way-replication]] +==== image:images/yes.png[yes] n-way replication (noun) +*Description*: In Red{nbsp}Hat Gluster Storage, the term _n-way replication_ is a generic phrase that refers to data being copied to multiple storage devices so that _n_ copies are available in the storage cluster as a whole. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/o.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/o.adoc index dd71b79e..0de81c08 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/o.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/o.adoc @@ -42,6 +42,17 @@ *See also*: xref:objectclass[objectClass] +[[object-storage]] +==== image:images/yes.png[yes] object storage (noun) +*Description*: _Object storage_ is a repository of data objects stored in an unstructured way, as distinct from block storage or file storage. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:block-storage[block storage], xref:file-storage[file storage] + [[object-storage-device]] ==== image:images/yes.png[yes] Object Storage Device (noun) *Description*: In Red{nbsp}Hat Ceph Storage, _Object Storage Device_ is a storage drive in a Ceph Storage Cluster. Do not confuse "Object Storage Device" with the "Ceph OSD", which is the `ceph-osd` daemon and the underlying data disk. @@ -219,6 +230,17 @@ *See also*: xref:o-ran[O-RAN], xref:openran[OpenRAN] +[[ocp-cluster]] +==== image:images/yes.png[yes] OpenShift Container Platform cluster (noun) +*Description*: An _OpenShift Container Platform cluster_ is a group of physical machines that contains the controllers, pods, services, and configurations required to build and run containerized applications. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[open-source]] ==== image:images/yes.png[yes] open source (noun) *Description*: "Open source" means that the source code of a program or utility can be viewed, modified, and shared. See https://opensource.com/resources/what-open-source[What is Open Source] for details. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc index 1aa29bd7..1165fd9e 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc @@ -106,7 +106,7 @@ When combined with privileges, permissions define a user's or resource's overall [[persistent-volume]] ==== image:images/yes.png[yes] persistent volume (noun) -*Description*: A _persistent volume_ (PV) is a piece of storage in the cluster that an administrator provisions or uses storage classes to dynamically provision. +*Description*: (1) Generically, a _persistent volume_ (PV) is a piece of storage in the cluster that an administrator provisions or uses storage classes to dynamically provision. (2) A storage volume for data in an Red{nbsp}Hat OpenShift cluster that remains available and usable after the pod that created it has been destroyed. A persistent volume provides persistent storage to Red{nbsp}Hat OpenShift applications, as distinct from the ephemeral storage provided by default. This term is sometimes abbreviated as _PV_, so it is important to clearly distinguish this term from _physical volume_ in contexts where logical volume management is discussed, such as when discussing storage for both Red{nbsp}Hat Enterprise Linux and OpenShift Container Platform. *Use it*: yes @@ -137,6 +137,17 @@ When combined with privileges, permissions define a user's or resource's overall *See also*: xref:placement-group[placement group] +[[phase]] +==== image:images/yes.png[yes] phase (noun) +*Description*: In Red{nbsp}Hat OpenShift, a _phase_ is the state of an object (storage or otherwise). For example, an object's phase can be `available`, `bound`, `released`, or `failed`. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[php]] ==== image:images/yes.png[yes] PHP (noun) *Description*: Use _PHP_ when referring to the programming language in general. Use `php` when referring to the specific command or some other literal use. See http://www.php.net/ for specific PHP language information. See http://en.wikipedia.org/wiki/PHP for more general information. @@ -148,6 +159,17 @@ When combined with privileges, permissions define a user's or resource's overall *See also*: +[[physical-disk]] +==== image:images/yes.png[yes] physical disk (noun) +*Description*: A _physical disk_ is a hardware component that stores data, such as a hard disk or solid-state drive. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:virtual-disk[virtual disk] + [[physical-topology]] ==== image:images/yes.png[yes] physical topology (noun) *Description*: Every LAN has a topology, or the way that the devices on a network are arranged and how they communicate with each other. The _physical topology_ is the way that the workstations are connected to the network through the actual cables that transmit data. @@ -159,6 +181,17 @@ When combined with privileges, permissions define a user's or resource's overall *See also*: xref:logical-topology[logical topology], xref:signal-topology[signal topology] +[[physical-volume]] +==== image:images/yes.png[yes] physical volume (noun) +*Description*: A _physical volume_ is a storage unit, a partition, or a whole disk that has been configured for use by Logical Volume Manager. Before this configuration, the physical volume is just a block device. This term is sometimes abbreviated as _PV_, so be sure that you clearly distinguish this term from _persistent volume_ in contexts where Red{nbsp}Hat OpenShift is discussed, such as when discussing storage for both Red{nbsp}Hat Enterprise Linux and OpenShift Container Platform. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[picketlink-federation]] ==== image:images/yes.png[yes] picketlink-federation subsystem (noun) *Description*: In Red{nbsp}Hat JBoss Enterprise Application Platform, the `picketlink-federation` subsystem is used to configure single sign-on (SSO) using security assertion markup language (SAML). In general text, write in lowercase as two words separated by a hyphen. Use "PicketLink Federation subsystem" when referring to the picketlink-federation subsystem in titles and headings. When writing the term in its heading form, ensure that you include an uppercase "L". @@ -236,6 +269,17 @@ When combined with privileges, permissions define a user's or resource's overall *See also*: +[[platform]] +==== image:images/caution.png[with caution] platform (noun) +*Description*: A _platform_ is a set of technological building blocks, such as hardware and an operating system, that is used to develop and run applications, software, services, workflows, and so forth. Use with caution, because this term is vague. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[playbook]] ==== image:images/yes.png[yes] playbook (noun) *Description*: _Playbooks_ are the configuration, deployment, and orchestration language for Ansible Automation Platform. @@ -410,6 +454,34 @@ If your release notes are based on the templates in this guide's xref:release-no *See also*: xref:release-notes[Release notes] +[[primary-cluster]] +==== image:images/yes.png[yes] primary cluster (noun) +*Description*: In Red{nbsp}Hat Gluster Storage, a _primary cluster_ is the storage cluster in active or production use. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[[primary-node]] +==== image:images/yes.png[yes] primary node (noun) +*Description*: Generically, a _primary node_ is the machine that contains or runs the main components of a product. + +Use "control plane node" for the OpenShift Container Platform node that manages other nodes in its Kubernetes cluster and schedules pods to run on nodes. + +Use "controller node" for the Ansible node from which jobs are executed. + +Use "source node" for the node in the active cluster when discussing geo-replication in Red{nbsp}Hat Gluster Storage. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: master node + +*See also*: xref:control-plane-node[control plane node], xref:controller-node[controller node], xref:source-node[source node] + [[processor]] ==== image:images/yes.png[yes] processor (noun) *Description*: In Red{nbsp}Hat Fuse, a _processor_ is a node that is capable of using, creating, or modifying an incoming message exchange in a Camel route. Processors are typically implementations of EIPs, but can be custom made. @@ -515,6 +587,17 @@ When combined with permissions, privileges define an agent's overall access to a *See also*: +[[provision]] +==== image:images/caution.png[with caution] provision (verb) +*Description*: To _provision_ is to create, configure, and assign a resource for use. For example, you can provision more storage to ensure you have sufficient storage space in a cluster. Use with caution; this term can have different meanings in different contexts. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[provisioning]] ==== image:images/yes.png[yes] provisioning (verb) *Description*: When discussing virtual machines (VMs), "provisioning" refers to a set of actions to prepare a VM with appropriate configuration options, data, and software to make it ready for operating in a cloud environment. In Microsoft Azure, RHEL VMs are provisioned using Azure CLI 2.0 or using the Azure Resource Manager (ARM) in the Microsoft Azure portal. @@ -526,6 +609,17 @@ When combined with permissions, privileges define an agent's overall access to a *See also*: +[[proxy]] +==== image:images/caution.png[with caution] proxy (noun) +*Description*: A _proxy_ is a production environment that denies direct access to the Internet and provides an available HTTP or HTTPS proxy instead. Use with caution; support levels vary, so the exact method and limitations must be explained clearly. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[pseries]] ==== image:images/no.png[no] pSeries (noun) *Description*: This is a former product name; instead use the official product name "IBM Power". diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/r.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/r.adoc index 2efdeb92..67485423 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/r.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/r.adoc @@ -620,6 +620,17 @@ Always use the approved product name _Red{nbsp}Hat build of OpenJDK_ instead. *See also*: +[[replicated-volume]] +==== image:images/yes.png[yes] replicated volume (noun) +*Description*: A _replicated volume_ is a Red{nbsp}Hat Gluster Storage volume that clones data on one brick to one or more other bricks. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[replication-agreement]] ==== image:images/yes.png[yes] replication agreement (noun) *Description*: In Red{nbsp}Hat Enterprise Linux, a _replication agreement_ is an agreement between two IdM servers in the same IdM deployment. The replication agreement ensures that the data and configuration is continuously replicated between the two servers. @@ -711,6 +722,17 @@ IdM uses two types of replication agreements: _domain replication_ agreements, w *See also*: +[[restore]] +==== image:images/yes.png[yes] restore (verb) +*Description*: In Red{nbsp}Hat OpenShift, to _restore_ is to correct or replace data that was lost or corrupted after a problem occurred in the cluster. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[return]] ==== image:images/yes.png[yes] return (verb) @@ -859,7 +881,7 @@ IdM uses two types of replication agreements: _domain replication_ agreements, w [[route]] ==== image:images/yes.png[yes] route (noun) -*Description*: 1) In Red{nbsp}Hat OpenShift, a _route_ exposes a service at a hostname, like www.example.com, so that external clients can reach it by name. 2) In Red{nbsp}Hat Fuse, routes specify paths through which messages move. A _route_ is basically a chain of processors that execute actions on messages as they move between the route's consumer and producer endpoints. A routing context can contain multiple routes. +*Description*: (1) In Red{nbsp}Hat OpenShift, a _route_ exposes a service at a hostname, like www.example.com, so that external clients can reach it by name. (2) In Red{nbsp}Hat Fuse, routes specify paths through which messages move. A _route_ is basically a chain of processors that execute actions on messages as they move between the route's consumer and producer endpoints. A routing context can contain multiple routes. *Use it*: yes diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/s.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/s.adoc index 6a0e907a..6b63ff80 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/s.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/s.adoc @@ -70,6 +70,28 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. *See also*: +[[scale-out]] +==== image:images/yes.png[yes] scale out (verb) +*Description*: To _scale out_ is to improve the ability of a cluster to do work by adding more machines. _Scaling out_ refers to increasing the amount of load that the system can handle at one time by increasing the number of servers doing work. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:scale-up[scale up] + +[[scale-up]] +==== image:images/yes.png[yes] scale up (verb) +*Description*: To _scale up_ is to improve the ability of a specific machine or cluster to do work by adding more resources to the machines. _Scaling up_ refers to increasing the amount of load that the system can handle by increasing the resources available to its components. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:scale-out[scale out] + [[scheduler]] ==== image:images/yes.png[yes] scheduler (noun) *Description*: In Red{nbsp}Hat OpenShift, the _scheduler_ is a control plane component that manages the state of the system, places pods on nodes, and ensures that all containers that are expected to be running are actually running. @@ -136,6 +158,17 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. *See also*: +[[secondary-cluster]] +==== image:images/yes.png[yes] secondary cluster (noun) +*Description*: In Red{nbsp}Hat Gluster Storage, a _secondary cluster_ is a cluster that exists as a backup if the primary cluster becomes unavailable. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[security-elytron]] ==== image:images/yes.png[yes] Security - Elytron (noun) *Description*: In Red{nbsp}Hat JBoss Enterprise Application Platform, use "Security - Elytron" when describing the `elytron` subsystem in the management console. Write as two capitalized words separated by two spaces and a hyphen. @@ -191,6 +224,17 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. *See also*: +[[self-heal]] +==== image:images/yes.png[yes] self-healing (noun) +*Description*: After an error has occurred in a Red{nbsp}Hat Gluster Storage cluster, _self-healing_ refers to the ability of the system to determine automatically which data is most correct and then to copy the correct data to the correct location in the cluster. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[selinux]] ==== image:images/yes.png[yes] SELinux (noun) *Description*: _SELinux_ is an abbreviation for "Security-Enhanced Linux". SELinux uses Linux Security Modules (LSM) in the Linux kernel to provide a range of minimum-privilege-required security policies. Do not use alternatives such as "SE-Linux", "S-E Linux", or "SE Linux". @@ -213,6 +257,17 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. *See also*: xref:producer[producer], xref:target[target], xref:receiver[receiver] +[[server]] +==== image:images/yes.png[yes] server (noun) +*Description*: A _server_ is a physical or virtual machine that runs software that provides the primary features of a product. Do not use "server" by itself unless you have previously qualified it with another defined term, such as storage server, metadata server, or database server. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[server-cluster]] ==== image:images/yes.png[yes] server cluster (noun) *Description*: A _server cluster_ is a group of networked servers housed in one location. This organization of servers streamlines internal processes by distributing the workload between the individual components of the group. It also expedites computing processes by harnessing the power of multiple servers. The clusters rely on load-balancing software that accomplishes tasks such as tracking demand for processing power from different machines, prioritizing the tasks, and scheduling and rescheduling them, depending on priority and demand on the network. When one server in the cluster fails, another server can serve as a backup. @@ -237,7 +292,7 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. [[service]] ==== image:images/yes.png[yes] service (noun) -*Description*: In Red{nbsp}Hat OpenShift, a _service_ functions as a load balancer and proxy to underlying pods. Services are assigned IP addresses and ports and delegate requests to an appropriate pod that can field it. The API object for a service is `Service`. +*Description*: (1) Generically, software that performs automated tasks and listens to and responds to hardware events and requests from other software. (2) In Red{nbsp}Hat OpenShift, a _service_ functions as a load balancer and proxy to underlying pods. Services are assigned IP addresses and ports and delegate requests to an appropriate pod that can field it. The API object for a service is `Service`. *Use it*: yes @@ -259,7 +314,7 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. [[session]] ==== image:images/caution.png[with caution] session (noun) -*Description*: 1) In Red{nbsp}Hat Single Sign-On, when a user logs in, a _session_ is created to manage the login session. A session contains information such as when the user logged in and what applications have participated within single sign-on during that session. Both administrators and users can view session information. 2) In Red{nbsp}Hat AMQ, a _session_ is a serialized context for producing and consuming messages. Sessions are established between AMQ peers over connections. Sending and receiving links are established over sessions. Use this term with caution, as users typically do not need to understand it to use AMQ. +*Description*: (1) In Red{nbsp}Hat Single Sign-On, when a user logs in, a _session_ is created to manage the login session. A session contains information such as when the user logged in and what applications have participated within single sign-on during that session. Both administrators and users can view session information. (2) In Red{nbsp}Hat AMQ, a _session_ is a serialized context for producing and consuming messages. Sessions are established between AMQ peers over connections. Sending and receiving links are established over sessions. Use this term with caution, as users typically do not need to understand it to use AMQ. *Use it*: with caution @@ -347,7 +402,7 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. [[shard-n]] ==== image:images/yes.png[yes] shard (noun) -*Description*: A database _shard_ is a horizontal partition of data in a database or search engine. Each individual partition is referred to as a shard or database shard. Each shard is held on a separate database server instance, to spread load. +*Description*: (1) A database _shard_ is a horizontal partition of data in a database or search engine. Each individual partition is referred to as a _shard_ or _database shard_. To spread load, each shard is held in a separate database server instance. (2) In storage, a _shard_ is a small part of a larger container. Shards replicate independently in parallel with other shards. Operations on shards take less time than operations on the whole container, which makes replication and maintenance more reliable. *Use it*: yes @@ -520,6 +575,17 @@ Specify the system architecture of your cluster, such as `s390x` or `x86_64`. *See also*: xref:snapshot-set[snapshot set] +[[snapshot]] +==== image:images/yes.png[yes] snapshot (noun) +*Description*: A _snapshot_ is a point-in-time copy of the current state of a volume or disk drive. Do not use "snapshot" as a verb, such as "snapshot the drive". Instead, say "take a snapshot" or "create a snapshot" + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[snapshot-set]] ==== image:images/yes.png[yes] snapshot set (noun) *Description*: In Red{nbsp}Hat Ceph Storage, the _snapshot set_ stores information about a snapshot as a list of key-values pairs. The pairs are called attributes of a snapshot set. @@ -668,6 +734,17 @@ Therefore, if you need to use the indefinite article before "sosreport", use _an *See also*: +[[source-node]] +==== image:images/yes.png[yes] source node (noun) +*Description*: When discussing geo-replication in Red{nbsp}Hat Gluster Storage, _source node_ refers to a node in the active cluster. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: master node + +*See also*: xref:primary-node[primary node] + [[source-to-image]] ==== image:images/yes.png[yes] Source-to-Image (S2I) (noun) *Description*: _Source-to-Image_ is a tool for building reproducible, Docker-formatted container images. It produces ready-to-run images by injecting application source into a container image and assembling a new image. @@ -679,6 +756,17 @@ Therefore, if you need to use the indefinite article before "sosreport", use _an *See also*: +[[source-volume]] +==== image:images/yes.png[yes] source volume (noun) +*Description*: Generically, _source volume_ refers to the volume from which information is obtained for reference. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[space]] ==== image:images/yes.png[yes] space (noun) *Description*: Use "space" to refer to white space, for example, "Ensure there is a space between each command." Use "spacebar" when referring to the keyboard key. @@ -762,6 +850,17 @@ Always capitalize as shown, except in commands, packages, or UI content. *See also*: +[[split-brain]] +==== image:images/yes.png[yes] split brain (noun) +*Description*: A _split brain_ state refers to a state that a server cluster can enter, where nodes and their associated data diverge from each other and have conflicts when handling incoming I/O operations. As a result, these servers might record the same data inconsistently or might compete for resources. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[sql]] ==== image:images/yes.png[yes] SQL (noun) *Description*: _SQL_ is an abbreviation for "Structured Query Language". The ISO-standard SQL (ISO 9075 and its descendants) is pronounced "ess queue ell" and takes "an" as its indefinite article. Microsoft's proprietary product, SQL Server, is pronounced as a word ("sequel") and takes "a" as its indefinite article. Oracle also pronounces its SQL-based products (such as PL/SQL) as "sequel". When referring to a specific Relational Database Management System (RDBMS), use the appropriate product name. For example, when discussing Microsoft SQL Server, write out the full name, "Microsoft SQL Server". @@ -951,7 +1050,29 @@ Always capitalize as shown, except in commands, packages, or UI content. [[storage-class]] ==== image:images/yes.png[yes] storage class (noun) -*Description*: In Red{nbsp}Hat OpenShift Data Foundation (formerly Red{nbsp}Hat OpenShift Container Storage), use _storage classes_ to describe the types of storage a product offers. OpenShift Data Foundation offers block, shared file system, and object classes. +*Description*: (1) In Red{nbsp}Hat OpenShift, a _storage class_ is a type of storage device categorized by performance characteristics. Storage class devices can be traditional hard disk drives, a solid state drives, or non-volatile memory express (NVMe) drives. (2) In Red{nbsp}Hat OpenShift Data Foundation (formerly Red{nbsp}Hat OpenShift Container Storage), use "storage classes" to describe the types of storage a product offers. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[[storage-cluster]] +==== image:images/yes.png[yes] storage cluster (noun) +*Description*: A _storage cluster_ is a group of physical or virtual machines that contains the resources and services required to provide storage. _Storage cluster_ might refer to a Ceph storage cluster, a Gluster storage cluster, or a cluster whose primary purpose is to provide storage as a service. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +[[storage-pool]] +==== image:images/yes.png[yes] storage pool (noun) +*Description*: A _storage pool_ is a logical storage partition that allows storage comprised of disks attached to one or more servers to be managed as a single entity. Access to and use of storage in a pool is usually shared between several different users or services. *Use it*: yes @@ -971,6 +1092,17 @@ Always capitalize as shown, except in commands, packages, or UI content. *See also*: +[[stripe]] +==== image:images/yes.png[yes] stripe (noun) +*Description*: A _stripe_ is a segment of data. Disk striping is a technique that spreads data segments across multiple disk drives to optimize performance. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[su]] ==== image:images/yes.png[yes] su (noun) *Description*: `su` (superuser, switch user, or substitute user) is a Linux command to change the local user to the root user. @@ -1048,6 +1180,27 @@ Always capitalize as shown, except in commands, packages, or UI content. *See also*: +[[subvolume]] +==== image:images/caution.png[with caution] subvolume (noun) +*Description*: _Subvolume_ has several possible meanings, depending on the context. + +* Generically, a _subvolume_ is a logical partition of a larger volume. + +* In Logical Volume Manager (LVM), an _LVM subvolume_ is a logical partition of an LVM volume, usually to store metadata related to the rest of the file system on the volume. + +* In Red{nbsp}Hat Gluster Storage, a _gluster subvolume_ is a gluster brick whose data has been processed by at least one translator, for example, to replicate files in the volume. + +* In Red{nbsp}Hat Ceph Storage, a _Ceph subvolume_ is an abstraction of a Ceph file system export that Ceph Manager can make available for consumption by a service, such as a Red{nbsp}Hat OpenStack file system service (Manila). + +Use the expanded term before you use "subvolume" by itself. + +*Use it*: with caution + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[sudo]] ==== image:images/caution.png[with caution] sudo (noun) *Description*: `sudo` is a command that allows a user to run a program as another user (the root user by default). When a user requires elevated privileges, use the phrase "as the root user" before a command instead of prefixing commands with `sudo`. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/t.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/t.adoc index a32e6a83..95f3b4a9 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/t.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/t.adoc @@ -1,6 +1,6 @@ [[target]] ==== image:images/yes.png[yes] target (noun) -*Description*: In Red{nbsp}Hat AMQ, a _target_ is a message's destination. This is usually a queue or topic. +*Description*: (1) Generically, a _target_ is synonymous with destination. A _target_ can be a file, a device or any type of location to which data is moved or copied. (2) In Red{nbsp}Hat AMQ, a _target_ is a message's destination. The _target_ is usually a queue or topic. *Use it*: yes @@ -31,6 +31,17 @@ *See also*: xref:instrumentation-module[instrumentation module] +[[target-volume]] +==== image:images/yes.png[yes] target volume (noun) +*Description*: A _target volume_ is a storage volume that has an administrative action performed against it. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[tcp]] ==== image:images/yes.png[yes] TCP (noun) *Description*: The _Transmission Control Protocol (TCP)_ is a connection-oriented protocol. Clients that are communicating over TCP must establish a connection to a server before data can be sent. TCP prefers reliability over time. Do not expand the abbreviation on first use. @@ -108,6 +119,19 @@ *See also*: +[[thickly-provisioned]] +==== image:images/yes.png[yes] thickly provisioned (adjective) +*Description*: _Thickly provisioned_ is used with reference to disk storage that is pre-allocated so that the total amount of virtual disk storage capacity exists on the physical storage when a virtual disk is created. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + +//The PR adding storage terms https://github.com/redhat-documentation/supplementary-style-guide/pull/155# indicates that you use the term "thinly-provisioned. The existing entry below contradicts this." + [[thin-provisioned]] ==== image:images/yes.png[yes] thin-provisioned (adjective) *Description*: _Thin-provisioning_ is a mechanism that allocates disk storage space in a flexible manner, based on the minimum space required at any given time. Thin-provisioned storage is also referred to as "sparse" in some contexts. @@ -229,6 +253,17 @@ A client requests a certificate from a web server. On receiving the certificate, *See also*: +[[total-capacity]] +==== image:images/yes.png[yes] total capacity (noun) +*Description*: _Total capacity_ is the complete amount of used and unused storage space available on a storage device. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[totally]] ==== image:images/no.png[no] totally (adverb) *Description*: Do not use "totally". @@ -251,6 +286,17 @@ A client requests a certificate from a web server. On receiving the certificate, *See also*: +[[translator]] +==== image:images/yes.png[yes] translator (noun) +*Description*: In Red{nbsp}Hat Gluster Storage, a _translator_ is a software module that converts user requests into a storage operation. Multiple translators may interact with the data in the request, but translators always work in a specific order, with data passed from one to another as appropriate, depending on the Gluster volume configuration. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[trigger-directive]] ==== image:images/yes.png[yes] trigger directive (noun) *Description*: In Red{nbsp}Hat Enterprise Linux, a _trigger directive_ is a special form of a transaction scriptlet that runs conditionally when another specific package is installed or uninstalled. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/u.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/u.adoc index 32b76051..297f940c 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/u.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/u.adoc @@ -110,7 +110,7 @@ [[upgrade]] ==== image:images/yes.png[yes] upgrade (verb) -*Description*: 1) To _upgrade_ means to raise (something) to a higher standard, in particular to improve by adding or replacing components. 2) In Red{nbsp}Hat Enterprise Linux, an _upgrade_ is when you replace the application, operating system, or software that you are currently running with a newer version. There are two ways to upgrade to RHEL: in-place upgrade or clean install. +*Description*: (1) To _upgrade_ means to raise (something) to a higher standard, in particular to improve by adding or replacing components. (2) In Red{nbsp}Hat Enterprise Linux, an _upgrade_ is when you replace the application, operating system, or software that you are currently running with a newer version. There are two ways to upgrade to RHEL: in-place upgrade or clean install. *Use it*: yes @@ -218,6 +218,17 @@ *See also*: xref:uri[URI] +[[usable-capacity]] +==== image:images/yes.png[yes] usable capacity (noun) +*Description*: _Usable capacity_ is the amount of unused space available on a storage device. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[user]] ==== image:images/caution.png[with caution] user (noun) *Description*: When referring to the reader, use "you" instead of "user". If referring to more than one user, calling the collection "users" is acceptable, such as "Other users might want to access your database." diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/v.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/v.adoc index 2833fc30..a01756c9 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/v.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/v.adoc @@ -110,6 +110,17 @@ Use lowercase "v" and uppercase "CPU". *See also*: +[[virtual-disk]] +==== image:images/yes.png[yes] virtual disk (noun) +*Description*: A _virtual disk_ is a file or set of files that presents as a physical disk to a virtualized operating system. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: xref:physical-disk[physical disk] + [[virtual-floppy-disk]] ==== image:images/yes.png[yes] virtual floppy disk (noun) *Description*: A _virtual floppy disk_ is an alternative to the traditional floppy. It is an image file rather than a physical disk. @@ -235,6 +246,28 @@ Although the _IBM Style_ guide recommends using "diskette drive" instead of "flo *See also*: xref:persistent-storage[persistent storage] +[[volume-file]] +==== image:images/yes.png[yes] volume file (noun) +*Description*: In Red{nbsp}Hat Gluster Storage, a _volume file_ is a configuration file that determines the behavior of the trusted storage pool. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: volfile + +*See also*: + +[[volume-group]] +==== image:images/yes.png[yes] volume group (noun) +*Description*: A _volume group_ is a combination of physical volumes, which creates a pool of disk space out of which logical volumes can be allocated. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*: + [[vpn]] ==== image:images/yes.png[yes] VPN (noun) *Description*: _VPN_ is an abbreviation for "virtual private network", which is a network that is constructed by using public wires to connect nodes. For example, there are a number of systems that enable you to create networks using the internet as the medium for transporting data. These systems use encryption and other security mechanisms to ensure that only authorized users can access the network and that the data cannot be intercepted. diff --git a/supplementary_style_guide/glossary_terms_conventions/general_conventions/w.adoc b/supplementary_style_guide/glossary_terms_conventions/general_conventions/w.adoc index 30b141fe..ad8973f5 100644 --- a/supplementary_style_guide/glossary_terms_conventions/general_conventions/w.adoc +++ b/supplementary_style_guide/glossary_terms_conventions/general_conventions/w.adoc @@ -173,6 +173,17 @@ *See also*: xref:microsoft-windows[Microsoft Windows] +[[worker-node]] +==== image:images/yes.png[yes] worker node (noun) +*Description*: In Red{nbsp}Hat OpenShift, a _worker node_ runs containerized applications. + +*Use it*: yes + +[.vale-ignore] +*Incorrect forms*: + +*See also*:xref:compute-node[compute node] + [[working-memory]] ==== image:images/yes.png[yes] working memory (noun) *Description*: In Red{nbsp}Hat JBoss BRMS and Red{nbsp}Hat JBoss BPM Suite, _working memory_ is a stateful object that provides temporary storage and enables manipulation of facts. The working memory includes an API that contains methods that enable access to the working memory from rule files.