Skip to content

Commit 3f97fbf

Browse files
Lisa Pettyjohnbergerhoffer
authored andcommitted
Adding storage gloss terms
1 parent 0ec7303 commit 3f97fbf

File tree

20 files changed

+965
-19
lines changed

20 files changed

+965
-19
lines changed

supplementary_style_guide/glossary_terms_conventions/general_conventions/a.adoc

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,17 @@ _Specify the system architecture of your cluster, such as `x86_64` or `aarch64`.
6565

6666
*See also*:
6767

68+
[[access-mode]]
69+
==== image:images/yes.png[yes] access mode (noun)
70+
*Description*: _Access mode_ is the concurrency method used when accessing a storage component, such as `readwriteonce` or `readwritemany`.
71+
72+
*Use it*: yes
73+
74+
[.vale-ignore]
75+
*Incorrect forms*:
76+
77+
*See also*:
78+
6879
[[access-token]]
6980
==== image:images/yes.png[yes] access token
7081
*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
588599

589600
*See also*:
590601

602+
[[availability]]
603+
==== image:images/caution.png[with caution] availability (adjective)
604+
*Description*: _Availability_ is the state of being available to perform work in a system, in the context of high availability or availability zones.
605+
606+
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".
607+
608+
*Use it*: with caution
609+
610+
[.vale-ignore]
611+
*Incorrect forms*:
612+
613+
*See also*: xref:high-availability[high-availability], xref:availability-zone[availability zone]
614+
615+
[[availability-zone]]
616+
==== image:images/yes.png[yes] availability zone (noun)
617+
*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.
618+
619+
*Use it*: yes
620+
621+
[.vale-ignore]
622+
*Incorrect forms*:
623+
624+
*See also*: xref:high-availability[high-availability]
625+
591626
[[cli]]
592627
==== image:images/yes.png[yes] Azure CLI 2.0 (noun)
593628
*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.

supplementary_style_guide/glossary_terms_conventions/general_conventions/b.adoc

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,17 @@
6464

6565
*See also*: xref:bare-metal-n[bare metal (noun)]
6666

67+
[[bare-metal-service]]
68+
==== image:images/yes.png[yes] Bare Metal service (noun)
69+
*Description*: The _Bare Metal service_ is a Red{nbsp}Hat OpenStack Platform product that provisions bare metal machines.
70+
71+
*Use it*: yes
72+
73+
[.vale-ignore]
74+
*Incorrect forms*:
75+
76+
*See also*:
77+
6778
[[base-dn]]
6879
==== image:images/yes.png[yes] base DN (noun)
6980
*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
178189

179190
*See also*:
180191

192+
[[bind-v]]
193+
==== image:images/yes.png[yes] bind (verb)
194+
*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.
195+
196+
*Use it*: yes
197+
198+
[.vale-ignore]
199+
*Incorrect forms*:
200+
201+
*See also*: xref:bind[BIND (noun)]
202+
181203
[[bind-dn]]
182204
==== image:images/yes.png[yes] bind DN (noun)
183205
*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
187209
[.vale-ignore]
188210
*Incorrect forms*:
189211

190-
*See also*: xref:distinguished-name[distinguished name]
212+
*See also*: xref:distinguished-name[distinguished name], xref:bind-v[bind (verb)]
191213

192214
[[bios]]
193215
==== 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
213235

214236
*See also*:
215237

238+
[[block-device]]
239+
==== image:images/caution.png[with caution] block device (noun)
240+
*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).
241+
242+
*Use it*: with caution
243+
244+
[.vale-ignore]
245+
*Incorrect forms*: block storage, block volume
246+
247+
*See also*: xref:block-storage[block storage], xref:block-volume[block volume]
248+
249+
[[block-storage]]
250+
==== image:images/caution.png[with caution] block storage (noun)
251+
*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).
252+
253+
*Use it*: with caution
254+
255+
[.vale-ignore]
256+
*Incorrect forms*: block device, block volume
257+
258+
*See also*: xref:block-device[block device], xref:block-volume[block volume]
259+
260+
[[block-volume]]
261+
==== image:images/caution.png[with caution] block volume (noun)
262+
*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).
263+
264+
*Use it*: with caution
265+
266+
[.vale-ignore]
267+
*Incorrect forms*: block device, block storage
268+
269+
*See also*: xref:block-device[block device], xref:block-storage[block storage]
270+
216271
[[blueprint]]
217272
==== image:images/yes.png[yes] blueprint (noun)
218273
*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
268323

269324
*See also*:
270325

326+
[[boot-source]]
327+
==== image:images/yes.png[yes] boot source (noun)
328+
*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.
329+
330+
*Use it*: yes
331+
332+
[.vale-ignore]
333+
*Incorrect forms*: bootsource, boot-source
334+
335+
*See also*:
336+
271337
[[bottleneck]]
272338
==== image:images/yes.png[yes] bottleneck (noun)
273339
*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
312378

313379
*See also*: xref:Bps[Bps]
314380

381+
[[brick]]
382+
==== image:images/yes.png[yes] brick (noun)
383+
*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.
384+
385+
*Use it*: yes
386+
387+
[.vale-ignore]
388+
*Incorrect forms*:
389+
390+
*See also*:
391+
315392
[[broadcast-n]]
316393
==== image:images/yes.png[yes] broadcast (noun)
317394
*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
391468

392469
[[bucket]]
393470
==== image:images/yes.png[yes] bucket (noun)
394-
*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.
471+
*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.
395472

396473
*Use it*: yes
397474

supplementary_style_guide/glossary_terms_conventions/general_conventions/c.adoc

Lines changed: 87 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,11 @@
301301

302302
[[client]]
303303
==== image:images/yes.png[yes] client
304-
*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.
304+
*Description*: _Client_ has multiple meanings, depending on the context:
305+
306+
* 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.
307+
308+
* 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.
305309

306310
*Use it*: yes
307311

@@ -354,6 +358,28 @@
354358

355359
*See also*:
356360

361+
[[clone-n]]
362+
==== image:images/yes.png[yes] clone (noun)
363+
*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.
364+
365+
*Use it*: yes
366+
367+
[.vale-ignore]
368+
*Incorrect forms*:
369+
370+
*See also*: xref:clone-v[clone (verb)]
371+
372+
[[clone-v]]
373+
==== image:images/yes.png[yes] clone (verb)
374+
*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.
375+
376+
*Use it*: yes
377+
378+
[.vale-ignore]
379+
*Incorrect forms*:
380+
381+
*See also*: xref:clone-n[clone (noun)]
382+
357383
[[cloudbursting]]
358384
==== image:images/yes.png[yes] cloudbursting (verb)
359385
*Description*: _Cloudbursting_ is an event where a private cloud exceeds its capacity and _bursts_ into and uses public cloud resources.
@@ -365,6 +391,17 @@
365391

366392
*See also*:
367393

394+
[[cloud-storage]]
395+
==== image:images/yes.png[yes] cloud storage (noun)
396+
*Description*: _Cloud storage_ refers to data or objects that are saved, accessed, and managed remotely, such as over a network.
397+
398+
*Use it*: yes
399+
400+
[.vale-ignore]
401+
*Incorrect forms*:
402+
403+
*See also*:
404+
368405
[[cloudwashing]]
369406
==== image:images/yes.png[yes] cloudwashing (verb)
370407
*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 @@
378415

379416
[[cluster]]
380417
==== image:images/yes.png[yes] cluster (noun)
381-
*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.
418+
*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.
382419

383420
*Use it*: yes
384421

@@ -530,6 +567,17 @@
530567

531568
*See also*:
532569

570+
[[compression]]
571+
==== image:images/caution.png[with caution] compression (noun)
572+
*Description*: Use _compression_ by itself only after first referring to the specific type of compression, for example, network compression.
573+
574+
*Use it*: with caution
575+
576+
[.vale-ignore]
577+
*Incorrect forms*:
578+
579+
*See also*:
580+
533581
[[compute-node]]
534582
==== image:images/yes.png[yes] compute node (noun)
535583
*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 @@
554602

555603
[[connection]]
556604
==== image:images/yes.png[yes] connection (noun)
557-
*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.
605+
*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.
558606

559607
*Use it*: yes
560608

@@ -587,7 +635,7 @@
587635

588636
[[connector]]
589637
==== image:images/yes.png[yes] connector (noun)
590-
*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.
638+
*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.
591639

592640
*Use it*: yes
593641

@@ -609,7 +657,7 @@
609657

610658
[[consumer]]
611659
==== image:images/yes.png[yes] consumer (noun)
612-
*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.
660+
*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.
613661

614662
*Use it*: yes
615663

@@ -620,7 +668,7 @@
620668

621669
[[container]]
622670
==== image:images/yes.png[yes] container (noun)
623-
*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.
671+
*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.
624672

625673
*Use it*: yes
626674

@@ -708,6 +756,17 @@ image repository contains one or more tagged images.
708756

709757
*See also*: xref:api-server[API server], xref:scheduler[scheduler]
710758

759+
[[control-plane-node]]
760+
==== image:images/yes.png[yes] control plane node (noun)
761+
*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.
762+
763+
*Use it*: yes
764+
765+
[.vale-ignore]
766+
*Incorrect forms*: master node
767+
768+
*See also*: xref:primary-node[primary node]
769+
711770
[[control-program]]
712771
==== image:images/yes.png[yes] control program (noun)
713772
*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.
730789

731790
*See also*:
732791

792+
[[controller-node]]
793+
==== image:images/yes.png[yes] controller node (noun)
794+
*Description*: A _controller node_ is the Ansible node from which jobs are executed.
795+
796+
*Use it*: yes
797+
798+
[.vale-ignore]
799+
*Incorrect forms*: master node
800+
801+
*See also*: xref:primary-node[primary node]
802+
733803
[[conversion]]
734804
==== image:images/yes.png[yes] conversion (noun)
735805
*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.
774844

775845
*See also*:
776846

847+
[[copy-v]]
848+
==== image:images/yes.png[yes] copy (verb)
849+
*Description*: In a data storage context, _copying_ is the process of creating a duplicate of a file in a different location.
850+
851+
*Use it*: yes
852+
853+
[.vale-ignore]
854+
*Incorrect forms*:
855+
856+
*See also*:
857+
777858
[[core-api]]
778859
==== image:images/yes.png[yes] Core API (noun)
779860
*Description*: The _Core API_ is an API for the ActiveMQ Artemis Core protocol. It is not supported by AMQ Broker.

0 commit comments

Comments
 (0)