Skip to content

Commit

Permalink
Merge pull request #445 from bergerhoffer/storage-terms
Browse files Browse the repository at this point in the history
Adding storage gloss terms
  • Loading branch information
bburt-rh authored Mar 26, 2024
2 parents c201305 + 3f97fbf commit 4042800
Show file tree
Hide file tree
Showing 20 changed files with 965 additions and 19 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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)
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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

Expand Down Expand Up @@ -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_.
Expand All @@ -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

Expand Down Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 4042800

Please sign in to comment.