Introduction

About this guide

This guide provides style guidelines and preferred term usage for Red Hat product and cross-product solution documentation. It is intended to be used as a supplement to the IBM Style Guide, which is the primary source of guidance for Red Hat product documentation.

The Red Hat Customer Content Services team created this guide as part of its responsibility for producing product documentation for Red Hat customers. Upstream communities who want to align more closely with the standards used by Red Hat product documentation can also use this guide.

How to use this guide

When looking for style guidance, reference this guide first, because it overrides certain guidance from the IBM Style Guide. If you must deviate from the guidance in either guide, notify the style council by opening an issue. This way, the deviation can be discussed by the style council and included in this guide.

In addition to the IBM Style Guide and the Red Hat supplementary style guide for product documentation, Red Hat product documentation uses the following reference guides for technical writers:

Contributing

Submitting a question or suggestion

If you have a suggestion or question, open an issue in the project’s GitHub repository.

Making an update to this guide

If you want to contribute an update to this guide, see the Contributing guide provided in the project’s GitHub repository.

Style guidelines

These recommendations might override existing guidance in the IBM Style Guide, or might provide guidance for items not covered in the IBM Style Guide.

Note

If applicable, these guidelines provide example formatting in AsciiDoc, which is the markup language that Red Hat Customer Content Services currently uses. However, the guidelines can be applied to any language.

General formatting

Date formats

Follow the IBM Style Guide guidance of day Month year for date formats, for example, 3 October 2019.

When the format day Month year causes a presentation or clarity issue, use Month day, year (for example, October 3, 2019) instead.

Conscious language

The Conscious Language Group supports the Red Hat commitment to remove problematic language from our code, documentation, websites, and open source projects with which Red Hat is involved. For more information about the Conscious Language Group, see https://github.com/conscious-lang/conscious-lang-docs.

Important

To ensure consistency and success, it is imperative for product team stakeholders to align internally. For example, documentation teams should engage in discussions with their engineering leadership to reach an agreement on replacement terms. This ensures that the product documentation matches the code.

blacklist and whitelist

When possible, rewrite documentation to avoid these terms. When it is not possible to remove the terms blacklist and whitelist, replace them with one of the following alternatives:

  • blocklist / allowlist: This combination is recommended by The IBM Style Guide. Use this combination unless your product area has another specific replacement that is agreed between engineering leadership and your documentation team.

  • denylist / allowlist

  • blocklist / passlist

  • You can also use a term that has been agreed by your product team stakeholders.

Examples
  • Removing blacklist

    no Heat blacklists any servers in the list from receiving updated heat deployments. After the stack operation completes, any blacklisted servers remain unchanged. You can also power off or stop the os-collect-config agents during the operation.

    yes Heat excludes any servers in the list from receiving updated heat deployments. After the stack operation completes, any excluded servers remain unchanged. You can also power off or stop the os-collect-config agents during the operation.

  • Removing whitelist

    no The following steps demonstrate adding a new rule to whitelist a custom binary.

    yes The following steps demonstrate adding a new rule to allow a custom binary.

master and slave

When possible, rewrite documentation to avoid these terms. When it is not possible to rewrite, you can use the following alternatives for master / slave:

  • primary / secondary

  • source / replica

  • initiator, requester / responder

  • controller, host / device, worker, proxy

  • director / performer

  • You can also use a term that has been agreed by your product team stakeholders.

Examples
  • Removing master

    no A Ceph Monitor maintains the master copy of the Red Hat Ceph Storage cluster map with the current state of the Red Hat Ceph Storage cluster.

    yes A Ceph Monitor maintains the primary copy of the Red Hat Ceph Storage cluster map with the current state of the Red Hat Ceph Storage cluster.

    yes A Ceph Monitor maintains the main copy of the Red Hat Ceph Storage cluster map with the current state of the Red Hat Ceph Storage cluster.

  • Removing slave

    no Use the following command to copy the public key to the slave node.

    yes Use the following command to copy the public key to the secondary node.

Conversational style

Follow the IBM Style Guide guidance of less conversational style in most cases.

As needed, adjust the conversational to fairly conversational for an audience of new users or least conversational for API documentation and other very experienced audiences.

Example: Less conversational style

Red Hat Enterprise Linux 8 delivers a stable, secure, and consistent foundation across hybrid cloud deployments with the tools needed to deliver workloads faster with less effort.

Contractions

Avoid contractions in product documentation to leave no ambiguity and to make it easier for translation and international audiences.

If you are writing quick start or other content that uses a more informal conversational style (fairly conversational or more conversational), you may use contractions. In this case, follow the guidance in the IBM Style Guide on using contractions.

User-replaced values

A user-replaced value, also known as a replaceable or variable value, is a value that the user must replace with a value that is relevant for their situation. User-replaced values are often found in places such as code blocks, file paths, and commands.

Use descriptive names for user-replaced values and follow this general format: <value_name>.

Note

For XML code blocks, see the guidance on user-replaced values for XML.

Ensure that user-replaced values have the following characteristics:

  • Surrounded by angle brackets (< >)

  • Separated by underscores (_) for multi-word values

  • Lowercase, unless the rest of the related text is uppercase or another capitalization scheme

  • Italicized

  • If the user-replaced value is referencing a value in code or in a command that is normally monospace, also use monospace for the user-replaced value

Example AsciiDoc: User-replaced value in a paragraph
Create an Ansible inventory file that is named `/_<path>_/inventory/hosts`.

This renders as:

Create an Ansible inventory file that is named /<path>/inventory/hosts.

To italicize a user-replaced value in a code block, you must add an attribute to apply text formatting, such as subs="+quotes" or subs="normal", to the attribute list of the code block.

Example AsciiDoc: User-replaced value in a code block
[subs="+quotes"]
----
$ oc describe node __<node_name>__
----

This renders as:

$ oc describe node <node_name>

User-replaced values for XML

Because XML uses angle brackets (< >), the default guidance for user-replaced values does not work well for it. If you are using user-replaced values in an XML code block, use the following format: ${value_name}.

Ensure that user-replaced values in XML have the following characteristics:

  • Surrounded by curly braces and preceded by a dollar sign (${ })

  • Separated by underscores (_) for multi-word values

  • Lowercase, unless the rest of the related text is uppercase or another capitalization scheme

  • Italicized

  • If the user-replaced value is referencing a value in code or in a command that is normally monospace, also use monospace for the user-replaced value

Example AsciiDoc: User-replaced value for an XML element
[source,xml,subs="+quotes"]
----
<ipAddress>__${ip_address}__</ipAddress>
----

This renders as:

<ipAddress>${ip_address}</ipAddress>
Example AsciiDoc: User-replaced value for an XML attribute
[source,xml,subs="+quotes"]
----
<oauth2-introspection client-id="__${client_id}__"/>
----

This renders as:

<oauth2-introspection client-id="${client_id}"/>

Lead-in sentences for Prerequisites and Procedure sections

A lead-in sentence in this context is the text that directly follows a Prerequisites or Procedure heading in a task-based module. It is distinct from the module abstract, which describes the goals of the user for the module.

Do not use a lead-in sentence in the Prerequisites or Procedure sections of a module unless it is necessary to aid navigation or add clarity.

The following examples demonstrate when a lead-in sentence might add value.

  • Your module has a long list of prerequisites, and you want to group the prerequisites in sections to make it easier for users to understand what tasks must be performed to complete a procedure.

  • Your module has a complex procedure or set of prerequisites, and you want to emphasize that all steps or prerequisites must be completed.

Use a complete sentence for the lead-in sentence to reduce ambiguity and support translation.

Single-step procedures

When a procedure contains only one step, use an unnumbered bullet.

For example:

  • Install the dnf-automatic package.

Admonitions

Admonitions should draw the reader’s attention to certain information. Keep admonitions to a minimum, and avoid placing multiple admonitions close to one another. If multiple admonitions are necessary, restructure the information by moving the less-important statements into the flow of the main content.

Valid admonition types:

NOTE

Additional guidance or advice that improves product configuration, performance, or supportability.

IMPORTANT

Advisory information essential to the completion of a task. Users must not disregard this information.

WARNING

Information about potential system damage, data loss, or a support-related issue if the user disregards this admonition. Explain the problem, cause, and offer a solution that works. If available, offer information to avoid the problem in the future or state where to find more information.

TIP

Alternative methods that might not be obvious. Makes applying the techniques and procedures described in the text easier or targets specific needs. Helps users understand the benefits and capabilities of the product. Not essential to using the product.

Important

CAUTION, which is another type of AsciiDoc admonition, is not fully supported by the Red Hat Customer Portal. Do not use this admonition type.

Admonitions should be short and concise. Do not include procedures in an admonition.

Only individual admonitions are allowed, for example, you cannot have a plural NOTES heading.

Example AsciiDoc
[NOTE]
====
Text for note.
====

Product names and version references

Whenever you refer to the name of your product in full, or in its abbreviated form, or when you refer to the major and minor version of your product, avoid using hard-coded references and use attributes instead. Only use hard-coded version references if the version that you are referring to in a particular case never changes.

Attribute file

Define attributes for product name and product version and store them in a dedicated attributes file for each set of product documentation. For examples of where you can store the shared attributes file inside your documentation repository, see the Example modular documentation repository. Include the attributes file at the beginning of the master.adoc files of all titles in your documentation set:

Example AsciiDoc: Attribute file included in a master.adoc file
include::<path_to_directory_with_attributes_file>/attributes.adoc[]
Minimum required attributes

Define attributes for the following values in each documentation set. Note that the attribute names used in this section are only meant as examples. You can use different attribute names:

The name of the product

Use the product name attribute for all instances of the product name where possible. Avoid using hard-coded product names. For example:

Example AsciiDoc: Product name attribute
:name-product: Red Hat JBoss Enterprise Application Platform
The abbreviated form of the product name

If it is necessary for your product, you can use an attribute to store a shortened version of the name of your product, for example:

Example AsciiDoc: Abbreviated product name attribute
:name-product-abbreviated: JBoss EAP
The major and minor version of the product

Use an attribute for the product version in cases where the product version can change with each release and the content is still correct. For example:

Example AsciiDoc: Product version attributes
:version-product-minor: 1.11
:version-product-patch: 1.11.6
Note

Do not use the product version attribute if the version should not change. For example, if a feature was introduced in a certain version, the version should be hard-coded.

You might create additional attributes according to what your documentation requires. For example, you might combine existing product name attributes to create compound names of products or components:

Example attributes for compound names of product components
:name-runtime-spring-boot: Spring Boot
:name-runtime-vertx: Eclipse Vert.x
:name-spring-reactive: {name-runtime-spring-boot} with {name-runtime-vertx} reactive components

Statements about future releases or plans

When possible, avoid making statements that predict future releases or plans.

However, some circumstances, such as release notes or deprecation notices, might dictate that you refer to a future release, plan, or event. In these situations, follow these guidelines:

  • When discussing future plans, use words such as "anticipate", "expect", or "plan".

  • Do not promise that a feature or a fix for a known issue will be included in an upcoming release or according to a specific timeline.

  • Do not refer to a specific future release. For example, do not mention a particular release number or a specific release date.

    Note

    One exception to this rule applies to deprecation notices, which might have to specify a future release in which a feature or functions will be removed.

    See Release notes for guidelines about deprecation notices.

Example: Bug fix statement

no We will fix this issue in the 18.3.4 release next February.

yes It is anticipated that an upcoming release will include a fix for this issue.

Code examples

Code example syntax highlighting

Provide the source language if it is supported by the Red Hat Customer Portal toolchain. Do not use the bash source language for terminal commands. It incorrectly interprets the number sign (#) as a comment instead of the prompt for a root command.

Example AsciiDoc
[source,yaml]
----
collections:
      - name: amazon.aws
        source: https://galaxy.ansible.com/api/v2/collections
        version: 1.2.1
----

Long code examples in procedures

All code blocks (regardless of length) must be necessary, accurate, and helpful. Code blocks must be as copy-and-paste friendly as possible, with the exception of variables and callouts. The length of the block is irrelevant, within reason, if the code block follows these guidelines.

Commands with root privileges

Some commands require root privileges to run. Users without root privileges must first do one of the following to run such a command:

  • Run su - to switch to the root user account.

  • Preface the command with sudo to temporarily change their current privileges.

Use the following guidelines when you document commands that require root privileges:

  • If you include a shell prompt in a sample command, always show the correct prompt for a regular user ($) or a user with root privileges (#).

    Note

    Do not rely solely on a shell prompt in a sample command to indicate the required privilege level to run a command. If you include a shell prompt to indicate that a user with root privileges must run the command, also include a statement about this requirement in the step text, the introductory text, or the prerequisites.

  • If a command requires a temporary switch to root privileges, use sudo at the beginning of the sample command syntax. If the sample command includes a shell prompt together with sudo, the prompt should remain $ and not be changed to #.

  • If multiple commands in a procedure require root privileges, add introductory content to tell the user what to do. For example, "The commands in this procedure require root privileges to run. Either run su - to switch to the root user or preface the commands with sudo."

Graphical interfaces

For more detailed guidance on how to document UI elements, see Patternfly.

User interface elements

Bold all graphical user interface elements, including, but not limited to, menu names, menu items, button names, dialog box names, and window names. Bold the item, even if it is not clickable.

Example AsciiDoc
On the *Installed Operators* page, click *Metering*.

Text entry

To indicate that a user should input text, use "enter" as opposed to "type" or "input". The text to enter should be in monospace.

Example AsciiDoc
In the *Name* field, enter `test-postgresql`.

Specific documentation types

Prerequisites

When writing prerequisites, be as clear and concise as possible. You can use the passive voice, if necessary, to achieve that end.

Write prerequisites as checks that are true or that the user must have completed before they begin a procedure. They can be actions that the user, another person, or piece of technology has completed. Prerequisites can also include items that the user must have ready before beginning the procedure.

  • The passive voice might be appropriate for a prerequisite that is not completed by the current user. For example, having a configuration enabled by a system admin.

  • Avoid using imperative formations.

  • Use parallel language when you write prerequisites. For example, if one bullet is a complete sentence, write the other bullets as complete sentences. But one bullet can be passive voice and another active voice.

Examples of prerequisites
  • JDK 11 or later is installed.

    Passive voice: the agent is unknown or unimportant.

  • A running Kafka instance in {product}.

    Not a complete sentence: This prerequisite is acceptable if all the other prerequisites in your list are also not complete sentences.

  • You are logged in to the Administration Portal.

  • You have validated Thing 1.

Release notes

Release notes doc texts

A doc text is a short description of an engineering Bugzilla or Jira issue that is published in product Errata advisories and release notes. Engineering typically supplies draft content, which is a summary of the issue, then technical writers edit or rewrite the draft content in accordance with the IBM Style Guide. You can write doc texts in more than one way, depending on the issue type:

  • Enhancement

  • Bug fix

  • Known issue

  • Technology Preview

  • Deprecated functionality

Use the following general structure for consistency.

Enhancement

Use present tense in one of the following formats:

This enhancement <present tense explanation>.
With this update, <present tense explanation>.
Example doc texts
This enhancement optimizes migration of an RBD volume from one Cinder back end to another when the volume resides within the same Ceph cluster. If both volumes are in the same Ceph cluster, Ceph performs data migration instead of the cinder-volume process. This reduces migration time.
With this update, you can create application credentials to use keystone to authenticate applications.
Bug fix

Use past tense for the problem and present tense for the solution, in the following format:

Before this update,  <X problem> caused <Y situation> (OPTIONAL: under the following <Z conditions>). With this update, <fix> resolves the issue (OPTIONAL: and <agent> can <perform operation> successfully).
Example doc text
Before this update, the loopback device for Cinder iSCSI/LVM backend was not recreated after a system restart, which prevented the cinder-volume service from restarting. With this update, a systemd service recreates the loopback device and the Cinder iSCSI/LVM backend persists after a restart.
Known issue

Use present tense for the issue and the imperative form for the workaround in the following format:

There is currently a known issue <present tense explanation> under <X conditions>.

Workaround: <workaround>.
Example doc text
Currently, you cannot use Orchestration (heat) templates with the director to deploy an overcloud that requires NFS as an Image service (glance) back end. There is currently no workaround for this issue.
The Compute services (nova) might fail to deploy because the `nova_wait_for_compute_service` script is unable to query the Nova API. If a remote container image registry is used outside of the undercloud, the Nova API service might not finish deploying in time.
Workaround: Rerun the deployment command, or use a local container image registry on the undercloud.
Technology Preview

Use the following text verbatim, where <tech_preview_name> is the name of your product, component, or feature:

<tech_preview_name> is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview[https://access.redhat.com/support/offerings/techpreview].
Examples of possible values for <tech_preview_name>
  • The Driver Toolkit

  • SSPI connection support on Microsoft Windows

  • Hot-plugging virtual disks

  • The Bare Metal Provisioning service (ironic) deployed on an IPv6 provisioning network for BMaaS (Bare Metal as-a-Service) tenants

Example doc text
The Driver Toolkit is a Technology Preview feature only. Technology Preview features are not supported with Red Hat production service level agreements (SLAs) and might not be functionally complete. Red Hat does not recommend using them in production. These features provide early access to upcoming product features, enabling customers to test functionality and provide feedback during the development process. For more information about the support scope of Red Hat Technology Preview features, see link:https://access.redhat.com/support/offerings/techpreview[https://access.redhat.com/support/offerings/techpreview].
Deprecated functionality

Warn users about the following deprecation stages:

  • Plan to deprecate

  • Deprecate

  • Plan to remove

  • Remove

If available, inform users of alternative capabilities and workarounds.

Deprecation notice
In <product_name> <release>, <name_of_capability_or_feature> is deprecated and is planned to be removed in the <deprecation_timeline>. Red Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed. As an alternative to <name_of_capability_or_feature>, you can use <alternative_capability_or_feature_if_available> instead.
Note

When citing deprecation timelines, refer to specific releases, such as the next release, only if that timeline is known to be accurate. Otherwise, use the phrase a future release because it accounts for the possibility of changes to the planned deprecation timeline.

Example deprecation notice doc text
In Red Hat Openstack Platform (RHOSP) 14, the director graphical user interface is deprecated and is planned to be removed in a future release. Red Hat will provide bug fixes and support for this feature during the current release lifecycle, but this feature will no longer receive enhancements and will be removed.
Removal notice
In <product_name> <current_release>, <name of capability or feature> has been removed. Bug fixes and support are provided only through the end of the <previous_release> lifecycle. As an alternative to <name_of_capability_or_feature>, you can use <alternative_capability_or_feature_if_available> instead.
Example removal notice doc text
In Red Hat OpenStack Platform (RHOSP) 16, the Data Processing service (sahara) has been removed. Bug fixes and support are provided only through the end of the RHOSP 15 lifecycle.
  • Use the title of the Knowledgebase article for the link text, or use descriptive running text.

  • Call out that this is a Knowledgebase article when not using running text.

  • When the link appears in Additional resources, put the article title first, followed by (Red Hat Knowledgebase).

Example: Article title

For a non-cloud environment, you can resize the disk and file system. For more information, see the Red Hat Knowledgebase solution Does RHEL 7 support online resize of disk partitions?.

Example: Running text

If your Apache web server configuration enables SSL security, verify that you enable only the TLSv1 protocol and disable SSLv2 and SSLv3. This is because of the POODLE SSL vulnerability (CVE-2014-3566).

Example: Additional resources

Cloud services guidelines

Cloud services are applications that run on a platform backed by data storage infrastructure and are hosted and managed by Red Hat on behalf of the customer. Cloud services provide rapid iteration and can more quickly deliver updated product functionality.

This means a product is no longer running exclusively in the customer’s infrastructure but is a service running in the cloud that is operated and maintained by Red Hat. Red Hat is now responsible for ensuring the service is secure, scalable, performant, and available at all times.

Cloud services documentation requires a shift from how documentation is typically created for an on-premise product. There is more emphasis on the content delivered within the product’s user interface itself, a need to deliver content rapidly without having a set release cadence, and to adapt content to the needs of cloud service users. For example, there might not be a need for upgrade and migration content that’s typical for on-premise products.

This section provides guidelines for creating content for the user interface, emphasizing accessibility, with the intent to provide consistency in how users understand and navigate across different cloud services.

Accessibility

Ensure that documentation meets Section 508 compliance for accessibility. Accessibility standards are derived from the Web Content Accessibility Guidelines (WCAGA) and the ICT Accessibility 508 Standards and 255 Guidelines.

Images

Use text equivalents for every diagram, image, or other non-text element. Avoid using images of text instead of actual text.

Evaluation:

  • All icons, images, diagrams, and non-text elements that convey information must have meaningful alternative-text descriptions.

    • For icons, use alternative text that describes what the icon does rather than what it looks like. For example, the alt text for a + icon is "Add" rather than "Plus Sign".

  • The document is free from images of text; for example, a screen capture image of an informational table. Make sure that actual text is used to convey information, rather than images of text.

The purpose of each link can be determined from the link text alone, or from the link text together with the link context. Links must lead to the correct target locations within the document, or to a valid external web page location. Ensure that all links work as expected.

  • All link URLs and cross-reference links must provide descriptive text that conveys information about the content of the target linked page prior to clicking the link. Do not use a generic phrase like “click here”.

Examples:

  • A link to a different section in the same document shows the section title.

  • An external link provides the site name or title of the target web page.

  • URLs must link to correct and valid web destinations.

Tables

When working with tables, accessibility tools such as a screen reader can programmatically determine the location of the content in each row and column. Screen readers interact with a data table based on the number of columns and rows, and provide table navigation to the user by reading row and column headers in the order they occur.

  • All tables must have a simple, logical reading order from left to right, top to bottom.

  • Avoid tables with irregular headers. Tables with multi-level headers, or spanned rows and cells, do not provide a clear horizontal or vertical association between header and data cells, and are too complex for accessibility tools to interpret.

  • Avoid blank header cells. Older screen readers often do not handle blank header cells correctly. Simplify tables to remove empty header cells, or add row and column text to each header cell.

  • For more information on adding titles using AsciiDoc, see Add a Title to a Table.

Colors and other visual information

Color should not be used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element. The documentation interface must provide at least one visual mode of operation that does not require user perception of color. Avoid indicating direction, such as left, right, above and below, since these have no meaning to a screen reader. Instructions provided for understanding and operating the product must not rely solely on sensory characteristics such as shape, size, visual location, or orientation.

  • Avoid instructions that rely solely on sensory characteristics.

  • Information that is conveyed by color differences must also be provided in text form.

  • For images or diagrams in your document, ensure sufficient contrast between foreground and background text or graphical elements. Graphics and diagrams in your document produced by a CCS graphic designer meet contrast ratio requirements. If you created a graphic or diagram yourself, use the WCAG reference for Contrast, and the Contrast Checker to evaluate contrast compliance.

  • Avoid directional indicators such as left, right, above and below when providing navigational instruction in the user interface.

Well-formed HTML and meaningful sequence

The meaning of content relies on the order in which you present it. For example, English content is arranged from left to right and readers usually look at a left-hand column before a right-hand column. Users who rely on assistive technology (such as a screen reader) to interpret content need the content to be presented in a meaningful order. If content is presented out of sequence, readers might become disoriented and unable to understand the content.

  • Correctly nest headings from H1 to H2, H3 and so forth to indicate relative importance. Do not skip heading levels.

  • Use correct AsciiDoc tags to produce the intended HTML.

Localization

Documentation that follows the IBM Style Guide for fairly conversational tone does not present issues with human or machine translation and better aligns with tone in the user interface. Use contractions where appropriate.

Microcopy

The words in a user interface, commonly referred to as "UX copy" or "microcopy," are just as important as the components or layouts. UX copy is another element of design, and it can drive better UX decisions and guide users to succeed. Red Hat cloud services are based on Patternfly, an open source design system created to enable consistency and usability across a wide range of applications and use cases.

See UX writing in the Patternfly content style guide for comprehensive guidelines when writing for the user interface.

Screenshots

Avoid screenshots for both accessibility and localization reasons. If you must use screenshots use them as judiciously as possible and ensure alt text is unique and descriptive. See Accessibility for more information on proper use of images in user interface documentation.

Glossary of terms and conventions

This glossary is the central location for terms and conventions for technical language in Red Hat’s product documentation and other technical content.

General conventions

A

yes absolute path (noun)

Description: The location of a file or directory from the root directory (/). Provides all information to locate a file or directory.

Use it: yes

Incorrect forms:

See also:

no agnostic (adjective)

Description: "Agnostic" denotes or relates to hardware or software that is compatible with many types of platforms or operating systems. For example, many common file formats (JPEG, MP3, and others) are platform agnostic. Use "neutral" instead.

Use it: no

Incorrect forms:

See also:

yes air gap (noun)

Description: "Air gap" is the physical segregation and isolation of a system as a security measure.

Use it: yes

Incorrect forms: air wall

See also:

no alright (adjective)

Description: "Alright" is the colloquial form of "correct".

Use it: no

Incorrect forms:

See also:

yes AMD64 (noun)

Description: "AMD64" is the AMD implementation of a 64-bit version of the x86 architecture.

Use it: yes

Incorrect forms: Hammer, x86_64, x86-64, x64, 64-bit x86

See also:

Note

The AMD64 logo is trademarked; the term "AMD64" is not trademarked. For more information about AMD trademarks, see the AMD Trademark Information page.

For more information about Intel® trademarks, see the Trademark Information and Usage Guidelines for Customers, Licensees, and Other Third Parties pages.

yes app (noun)

Description: Acceptable when referring to a mobile or web application.

Use it: yes

Incorrect forms: app.

See also:

yes Applixware (noun)

Description: "Applixware" is a suite of proprietary modular applications for Linux.

Use it: yes

Incorrect forms: Applix, ApplixWare

See also:

no as expected (adverb)

Description: Expectations are relative; use "correctly" instead.

Use it: no

Incorrect forms:

See also:

yes Asynchronous Transfer Mode (noun)

Description: "Asynchronous Transfer Mode" (ATM) is a network technology based on transferring data in cells or packets of a fixed size. The cell size used with ATM is relatively small compared to units used with older technologies.

Use it: yes

Incorrect forms:

See also:

yes auto-detect (verb)

Description: "Auto-detect" means to automatically detect threats, new hardware, software updates, and so on.

Use it: yes

Incorrect forms: autodetect

See also:

B

yes backtrace (noun)

Description: "Backtrace" is another name for "stack trace" (or "stack backtrace"), which is a report of the active stack frames (function calls) at a certain point in time during the execution of a program. The Python programming language uses the term "traceback", possibly because the stack frames are printed in the opposite order of those presented by gdb, the GNU Debugger. "Traceback" is the preferred term when referring to a Python stack trace.

Use it: yes

Incorrect forms:

See also:

yes bandwidth (noun)

Description: "Bandwidth" refers to a range within a band of frequencies or wavelengths, or the amount of data that can be transmitted in a fixed amount of time.

Use it: yes

Incorrect forms:

See also: latency

yes bare metal (noun)

Description: "Bare metal" refers to physical hardware as opposed to virtual hardware. Use the two-word form as a noun: "Install on bare metal".

Use it: yes

Incorrect forms: baremetal, bare-metal

yes bare-metal (adjective)

Description: "Bare metal" refers to physical hardware as opposed to virtual hardware. Use the hyphenated form as an adjective: "Bare-metal servers".

Use it: yes

Incorrect forms: baremetal, bare metal

See also: bare metal (noun)

no basically (adverb)

Description: "Basically" is another term for "in principle" or "fundamentally".

Use it: no

Incorrect forms:

See also:

with caution because (conjunction)

Description: Do not use "since" to mean "because". Use "because" to refer to a reason. Use "since" to indicate the passage of time.

Use it: with caution

Incorrect forms:

See also:

with caution bimodal IT (noun)

Description: "Bimodal IT" is the Gartner phrase for the combination of traditional (mode 1 or type 1) and modern (mode 2 or type 2) IT infrastructure and resources. There are many ways to talk about this combination approach. Using only the Gartner term can alienate other analysts or those not familiar with Gartner’s phrasing.

The practice of having both modes together is often referred to as "hybrid", "agile", or "modern" IT. "Hybrid IT" is a more general term; for example, it could mean "on-premise plus public cloud". "Agile" and "modern IT" can both carry an implication of "mode 2". When using those terms, be specific about the exact technology combination you mean.

Use it: with caution

Incorrect forms:

See also:

yes bimonthly (adverb)

Description: "Bimonthly" means every other month.

Use it: yes

Incorrect forms: bi-monthly

See also:

yes biweekly (adverb)

Description: "Biweekly" means every other week.

Use it: yes

Incorrect forms: bi-weekly

See also:

yes BIND (noun)

Description: Use "BIND" when referring to the DNS software.

Use it: yes

Incorrect forms: Bind, bind

See also:

yes BIOS (noun)

Description: "BIOS" is an abbreviation for basic input and output system. The plural form is "BIOSes".

Use it: yes

Incorrect forms: Bios

See also:

yes boot disk (noun)

Description: A "boot disk" is a disk used to start a computer.

Use it: yes

Incorrect forms: boot diskette

See also:

yes boot loader (noun)

Description: "Boot loader" is software used to load an operating system when a computer is started.

Use it: yes

Incorrect forms: bootloader

See also:

yes bottleneck (noun)

Description: A "bottleneck" is a limitation in the capacity of software or hardware caused by a single component.

Use it: yes

Incorrect forms: bottle neck, bottle-neck

See also:

yes bpp (noun)

Description: The abbreviation for bits per pixel ("bpp") is presented in lowercase letters, unless it is at the beginning of a sentence. Use a non-breaking space between the numeral and the units, for example, "16 bpp", not "16bpp".

Use it: yes

Incorrect forms:

See also:

yes Bps (noun)

Description: "Bps" is an abbreviation for bytes per second.

Use it: yes

Incorrect forms: bps

See also: bps

yes bps (noun)

Description: The abbreviation for bits per second is "bps".

Use it: yes

Incorrect forms: Bps

See also: Bps

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.

Use it: yes

Incorrect forms: broad cast, broad-cast

See also: broadcast (verb)

yes broadcast (verb)

Description: When used as a verb, "broadcast" means to simultaneously send the same message 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.

Use it: yes

Incorrect forms: broad cast, broad-cast

See also: broadcast (noun)

yes Btrfs (noun)

Description: "Btrfs" is a copy-on-write file system for Linux. Use a capital "B" when referring to the file system. When referring to tools, commands, and other utilities related to the file system, be faithful to those utilities. See the Btrfs wiki page for more information on this file system. See the List of file systems wiki page for a list of file system names and how to present them.

Use it: yes

Incorrect forms: btrfs

See also:

yes bug fix (noun)

Description: A "bug fix" is the resolution to a bug.

Use it: yes

Incorrect forms: bugfix

See also:

yes built-in (adjective)

Description: Use "built-in" when referring to something that is included or incorporated into a larger unit.

Use it: yes

Incorrect forms: builtin, built in

See also:

C

yes CapEx (noun)

Description: "CapEx" is an acronym for "capital expenditures".

Use it: yes

Incorrect forms: Capex, capex, capEx

See also:

yes cd (noun)

Description: The "change directory" command is "cd".

Use it: yes

Incorrect forms: CD

See also: CD

yes CD (noun)

Description: "CD" is an abbreviation for "compact disc".

Use it: yes

Incorrect forms: cd

See also: cd, CDs

yes CD #1 (noun)

Description: When referring to a specific CD in the Red Hat Enterprise Linux CD set, it is correct to refer to it as "Red Hat Enterprise Linux CD #1". Avoid using "Red Hat Enterprise Linux CD 1".

Use it: yes

Incorrect forms: CD 1

See also:

yes CD writer (noun)

Description: A "CD writer" is a device that records data into the CD format.

Use it: yes

Incorrect forms: CD burner, burner

See also:

yes CDs (noun)

Description: "CDs" is the plural form of "CD". Use "CDs" to describe multiple compact discs.

Use it: yes

Incorrect forms: CDS, Cds

See also: CD

yes cgroup (noun)

Description: The term "cgroup" is a contraction of "control group". Cgroups allow you to allocate resources, such as CPU time, system memory, network bandwidth, or combinations of these resources, among user-defined groups of processes running on a system.

Use it: yes

Incorrect forms: CGroup, c group

See also:

yes ciphertext (noun)

Description: In cryptography, "ciphertext" is the result of encryption performed on plain text using an algorithm, called a cipher.

Use it: yes

Incorrect forms: cipher text, cyphertext, cypher text, cipher-text, cypher-text

See also:

yes client side (noun)

Description: Use the two-word form of "client side" as a noun when referring to the client side in a client-server relationship, for example, "This happens on the client side of the relationship."

Use it: yes

Incorrect forms: client-side

See also: client-side

yes client-side (adjective)

Description: Use the one-word form "client-side" as an adjective when referring to operations that are performed by the client in a client-server relationship, for example, "This is a client-side service."

Use it: yes

Incorrect forms: client side

See also: client side

yes cloud (adjective)

Description: Use "cloud" with a lowercase "c" when referring to cloud computing in a general sense.

Use it: yes

Incorrect forms: Cloud

See also: cloud (noun)

yes cloud (noun)

Description: Use "cloud" with a lowercase "c" when referring to cloud computing in a general sense.

Use it: yes

Incorrect forms: Cloud

See also: cloud (adjective)

yes cloudbursting (verb)

Description: "Cloudbursting" is an event where a private cloud exceeds its capacity and "bursts" into and uses public cloud resources.

Use it: yes

Incorrect forms: cloud-bursting

See also:

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.

Use it: yes

Incorrect forms: cloud-washing

See also:

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 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

Incorrect forms:

See also:

yes code (noun)

Description: "Code" refers to programming statements and a set of instructions for a computer. Do not use "code" as a verb.

Use it: yes

Incorrect forms:

See also:

yes colocate (verb)

Description: "Colocate" means to place two or more items in the same space. Do not hyphenate "colocate".

Use it: yes

Incorrect forms: co-locate, collocate

See also:

yes comma-delimited (adjective)

Description: "Comma-delimited" is an adjective that refers to a data format in which each piece of data is separated by a comma.

Use it: yes

Incorrect forms: comma delimited, commadelimited

See also:

yes comma-separated values (noun)

Description: "Comma-separated values" are a set of values in which each value is separated by a comma. Spell out "comma-separated values" on first use; use "CSV" thereafter.

Use it: yes

Incorrect forms: comma-delimited values, comma delimited values, comma separated values

See also: CSV

yes command-driven (adjective)

Description: "Command-driven" is an adjective that refers to programs and operating systems that accept commands in the form of special words or letters.

Use it: yes

Incorrect forms: command driven, commanddriven

See also: menu-driven

yes command language (noun)

Description: "Command language" is the programming language through which a user communicates with an operating system or an application.

Use it: yes

Incorrect forms: command-language

See also:

yes connectivity (noun)

Description: "Connectivity" is the ability of a program or device to link with other programs and devices.

Use it: yes

Incorrect forms:

See also:

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.

Use it: yes

Incorrect forms:

See also: bucket

yes container-based (adjective)

Description: Use "container-based" as an adjective when referring to applications made up of multiple services that are distributed in containers. "Container-based" can be used interchangeably with "containerized".

Use it: yes

Incorrect forms: container based

See also: containerized

yes containerized (adjective)

Description: Use "containerized" as an adjective when referring to applications made up of multiple services that are distributed in containers. "Containerized" can be used interchangeably with "container-based".

Use it: yes

Incorrect forms: containerised

See also: container-based

yes container registry (noun)

Description: A "container registry" refers to a service that stores and retrieves Docker-formatted container images. A "container registry" is also a registry that contains a collection of one or more image repositories. Each image repository contains one or more tagged images.

Use it: yes

Incorrect forms:

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.

Use it: yes

Incorrect forms:

yes convert (verb)

Description: Use "convert" when referring to changing data from one format to another.

Use it: yes

Incorrect forms:

See also:

yes cooked (adjective)

Description: "Cooked" is an adjective that refers to data that is processed before being passed to the I/O device.

Use it: yes

Incorrect forms:

See also: raw

Description: A "cookie" is a message given to a web browser by a web server. The browser stores the message in a text file called cookie.txt. The message is then sent back to the server each time the browser requests a page from the server.

Use it: yes

Incorrect forms:

See also:

with caution crash (verb)

Description: When a program "crashes", it terminates unexpectedly. The IBM Style Guide suggests to use a more specific term, such as "fail". However, in Red Hat documentation, it is acceptable to use crash in certain cases: When writing errata descriptions, it is possible to use "crash" instead of "terminate unexpectedly" if "terminate unexpectedly" was used in a previous sentence. For example: A utility terminated unexpectedly because of a bug in the underlying source code. With this update, the utility no longer crashes.

Use it: with caution

Incorrect forms:

See also: fail

yes cross-platform (adjective)

Description: Use "cross-platform" as an adjective when referring to the capability of software or hardware to run identically on different platforms.

Use it: yes

Incorrect forms: crossplatform, cross platform

See also:

yes cross-site scripting (adjective)

Description: Use "cross-site scripting" as an adjective when referring to "cross-site scripting" attacks. Another acceptable use is "cross-site scripting" (XSS) attack.

Use it: yes

Incorrect forms: cross site scripting

See also:

yes CSV (noun)

Description: CSV is an abbreviation for "comma-separated values", which is a set of values in which each value is separated by a comma. Spell out "comma-separated values" on first occurrence; use "CSV" thereafter.

Use it: yes

Incorrect forms: csv

yes Ctrl (noun)

Description: "Ctrl" refers to the Ctrl key on a keyboard.

Use it: yes

Incorrect forms: control key, ctrl

See also:

yes Cygmon (noun)

Description: "Cygmon" is a type of ROM monitor.

Use it: yes

Incorrect forms: CygMon, cygmon, CYGMON

See also:

D

yes daisy chain (noun)

Description: When used as a noun, a "daisy chain" is a hardware configuration in which devices are connected to each other in series.

Use it: yes

Incorrect forms: daisy-chain, daisychain

See also: daisy chain (verb)

yes daisy chain (verb)

Description: When used as a verb "daisy chain" means to connect devices in a daisy-chain pattern, that is, in series.

Use it: yes

Incorrect forms: daisy-chain, daisychain

See also: daisy chain (noun)

yes data center (noun)

Description: A "data center" is a group of networked computer servers used for the remote storage, processing, or distribution of large amounts of data. Note that marketing publications use the one-word form, "datacenter".

Use it: yes

Incorrect forms: datacenter, data-center, data centre, datacentre

See also:

yes data mirroring (noun)

Description: "Data mirroring" is the act of copying data from one location to a storage device in real time.

Use it: yes

Incorrect forms: datamirroring, data-mirroring

See also:

yes data path (noun)

Description: A "data path" is a collection of functional units (such as arithmetic logic units or multipliers that perform data processing operations), registers, and buses. Along with the control unit, a "data path" comprises the central processing unit (CPU).

Use it: yes

Incorrect forms: datapath

See also:

yes debug (adjective)

Description: Use "debug" as an adjective to describe a type of command or script that is used to find and remove errors from a program or design, for example, a "debug script".

Use it: yes

Incorrect forms: de-bug

See also: debug (verb)

yes debug (verb)

Description: When used as a verb, "debug" means to find and remove errors from a program or design.

Use it: yes

Incorrect forms: de-bug

See also: debug (adjective)

yes denial of service (noun)

Description: "Denial of service" is an interruption in a user’s access to a computer network, usually caused deliberately and with malicious intent. Use "denial of service (DoS)" on first use and "DoS" thereafter.

Use it: yes

Incorrect forms: Denial of Service

yes denial-of-service (adjective)

Description: When used as an adjective, spell as "denial-of-service", for example, "denial-of-service attack".

Use it: yes

Incorrect forms: Denial-of-Service

yes desktop (adjective)

Description: Use "desktop" as an adjective when describing a type of computer, for example, "desktop computer".

Use it: yes

Incorrect forms: desk top, desk-top

See also: desktop (noun)

yes desktop (noun)

Description: When used as a noun, "desktop" can refer to a type of computer or the working area of a computer screen.

Use it: yes

Incorrect forms: desk top, desk-top

yes device (noun)

Description: A "device" is any machine or component that attaches to a computer.

Use it: yes

Incorrect forms:

See also:

yes DevOps (noun)

Description: "DevOps" is a combination of "Development" and "Operations". It refers to a specific method or organizational approach where developers and IT operations staff work together to create the applications that run the business.

Use it: yes

Incorrect forms: devops, Devops, Dev-Ops, Dev Ops

See also:

yes different from (preposition)

Description: Use "different from" when comparing two things. Use "different from" when the next part of the sentence is a noun or pronoun.

Use it: yes

Incorrect forms: different than, different to

See also:

yes Disk Druid (noun)

Description: A "Disk Druid" is a partitioning tool incorporated into Red Hat Enterprise Linux.

Use it: yes

Incorrect forms: Disk druid, disk druid, diskdruid

See also:

yes disk label (noun)

Description: A "disk label" is a record that contains information about the location of the partitions on a disk.

Use it: yes

Incorrect forms: disklabel, disk-label

See also:

yes DNS (noun)

Description: "DNS" is an abbreviation for "Domain Name System" or "Domain Name Service", a service that translates domain names into IP addresses and vice versa.

Use it: yes

Incorrect forms: dns

See also:

yes domain name (noun)

Description: A "domain name" is a name that identifies one or more IP addresses, for example, "redhat.com".

Use it: yes

Incorrect forms: domainname, domain-name

See also:

yes download (noun)

Description: Use "download" as a noun when referring to software, data, and so on that is being retrieved from another computer.

Use it: yes

Incorrect forms: down-load, down load

See also: download (verb)

yes download (verb)

Description: Use "download" as a verb when referring to the act or process of downloading data.

Use it: yes

Incorrect forms: down-load, down load

See also: download (noun)

yes downstream (adjective)

Description: "Downstream" as an adjective refers to the Red Hat offerings that are based on upstream community projects.

Use it: yes

Incorrect forms: down-stream, down stream

yes downstream (noun)

Description: "Downstream" as a noun refers to the Red Hat offerings that are based on upstream community projects.

Use it: yes

Incorrect forms: down-stream, down stream

yes dual-boot (adjective)

Description: A "dual-boot" system is a system in which two operating systems are installed on the same hard drive.

Use it: yes

Incorrect forms: dualboot, dual boot

See also:

yes DVD writer (noun)

Description: A "DVD writer" is a device that records data into the DVD format.

Use it: yes

Incorrect forms: DVD burner, burner

See also:

E

yes Emacs (noun)

Description: "Emacs" is a text editor that is available on the UNIX system and similar operating systems. Like vi, Emacs is a screen editor. Unlike vi, Emacs is not an insertion mode editor, meaning that any character typed in Emacs is automatically inserted into the file, unless it includes a command prefix.

If referring to the program, use "Emacs", for example, "Source-Navigator supports Emacs or vi commands." If referring to the shell prompt command, use emacs. Always mark up the command correctly, for example, "At the prompt, type emacs." The complete and correct name is "GNU Emacs".

Use it: yes

Incorrect forms:

See also:

yes emit (verb)

Description: "Emit" means to send something out. Do not use "send out" because that is too informal and imprecise. Alternatively, use "issue".

Use it: yes

Incorrect forms: send out

See also:

yes Enter (noun)

Description: When referring to the keyboard key, use "Enter". If referring to the keyboard key on Solaris, use "Return".

Use it: yes

Incorrect forms:

See also: return

with caution entitlement (noun)

Description: "Entitlement" refers to the number of systems that can be attached to an individual subscription. When you use Red Hat Subscription Management (RHSM), you register a system, attach a subscription, and enable repositories. Attaching a subscription to the system consumes one or more of the subscription’s available entitlements. Do not use "entitlement" and "subscription" interchangeably. See https://access.redhat.com/discussions/3119981 for details.

Use it: with caution

Incorrect forms:

yes environment (noun)

Description: In IT, "environment" refers to the state of a computer, usually determined by which programs are running and basic hardware and software characteristics. For example, when one speaks of running a program in a UNIX "environment", it means running a program on a computer that has the UNIX operating system. One ingredient of an environment is the operating system, but operating systems include a number of different parameters. For example, many operating systems allow you to choose your command prompt or a default command path. All of these parameters taken together comprise the environment.

Use it: yes

Incorrect forms:

See also:

no essentially (adverb)

Description: Do not use "essentially". It does not add anything to the sentence.

Use it: no

Incorrect forms:

See also:

yes event (noun)

Description: 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.

Use it: yes

Incorrect forms:

See also:

yes examine (verb)

Description: Use "examine" instead of "look at".

Use it: yes

Incorrect forms: look at

See also:

yes Exec-Shield (noun)

Description: "Exec-Shield" is a security-enhancing modification to the Linux kernel that makes large parts of specially marked programs including their stack not executable.

Use it: yes

Incorrect forms:

See also:

yes Exif (noun)

Description: "Exif" is an image file format specification that enables metadata tags to be added to existing JPEG, TIFF, and RIFF files. "Exif" is sometimes referred to as "Exif Print".

Use it: yes

Incorrect forms: EXIF, exif

See also:

yes extranet (noun)

Description: "Extranet" refers to an "intranet" that is partially accessible to authorized outsiders. Whereas an intranet resides behind a firewall and is accessible only to people who are members of the same company or organization, an extranet provides various levels of accessibility to outsiders. You can access an extranet only if you have a valid user name and password. Your identity determines which parts of the extranet you can view.

Capitalize "extranet" only at the beginning of a sentence.

Use it: yes

Incorrect forms: Extranet

See also:

F

yes fail (verb)

Description: When a program "fails", it means that it stops working.

Use it: yes

Incorrect forms:

See also: crash

yes FAQ (noun)

Description: When referring to a Frequently Asked Questions (FAQ) section of content, refer to it as "an FAQ" (to be read as "an F-A-Q"), not "a FAQ". The plural form is "FAQs".

Use it: yes

Incorrect forms: Faq, faq, F.A.Q

See also:

yes fault tolerance (noun)

Description: "Fault tolerance" is the ability of a system to respond gracefully to an unexpected hardware or software failure. There are many levels of fault tolerance, the lowest being the ability to continue operation in the event of a power failure.

Use the two-word "fault tolerance" when using it as a noun.

Use it: yes

Incorrect forms: fault-tolerance

See also: fault-tolerant

yes fault-tolerant (adjective)

Description: "Fault-tolerant" systems can respond gracefully to an unexpected hardware or software failure. Many fault-tolerant computer systems mirror all operations, that is, every operation is performed on two or more duplicate systems, so if one fails the other can take over.

Use the hyphenated "fault-tolerant" when using it as an adjective.

Use it: yes

Incorrect forms: fault tolerant

See also: fault tolerance

yes Fedora™ Project (noun)

Description: The "Fedora Project" is a global partnership of free software community members, sponsored by Red Hat. Red Hat Enterprise Linux is based on the Fedora operating system.

Use it: yes

Incorrect forms: fedora project

See also:

yes FireWire (noun)

Description: "FireWire" is the Apple name for the IEEE 1394 High Speed Serial Bus, a serial bus architecture for high-speed data transfer.

Do not use "Firewire" or "firewire". Although FireWire is a trademark of Apple Computer, it does not need to be listed with a trademark symbol when mentioned. Only use the trademark symbol when talking about the Apple FireWire software license or specific logos. See http://developer.apple.com/softwarelicensing/agreements/firewire.html for full details.

Use it: yes

Incorrect forms: Firewire, firewire

See also:

yes firmware (noun)

Description: "Firmware" is software (programs or data) that has been written onto read-only memory (ROM). Firmware is a combination of software and hardware. ROMs, PROMs (programmable ROMs), and EPROMs (erasable PROMs) that have data or programs recorded on them are firmware.

Use it: yes

Incorrect forms: firm ware, firm-ware

See also:

yes floating point (noun)

Description: "Floating point" derives from the fact that there is no fixed number of digits before and after the decimal point, that is, the decimal point can float.

Use it: yes

Incorrect forms: floating-point

See also:

yes foreground (noun)

Description: In multiprocessing systems, "foreground" sometimes refers to the process that is currently accepting input from the keyboard or other input device. On display screens, the foreground consists of the characters and pictures that are displayed on the screen. The background is the uniform canvas behind the characters and pictures.

Use it: yes

Incorrect forms: fore-ground, forground

See also:

yes Fortran (noun)

Description: "Fortran" is a general-purpose, imperative programming language that is especially suited to numeric computation and scientific computing. For earlier versions up to FORTRAN 77, use "FORTRAN". For later versions beginning with Fortran 90, use "Fortran".

Use it: yes

Incorrect forms: fortran

See also:

yes FQDN (noun)

Description: "FQDN" is an abbreviation for fully qualified domain name. A FQDN consists of a host and domain name, including top-level domain. For example, www.redhat.com is a fully qualified domain name. www is the host, redhat is the second-level domain, and .com is the top-level domain. A FQDN always starts with a hostname and continues all the way up to the top-level domain name, so www.parc.xerox.com is also a FQDN.

Use it: yes

Incorrect forms: Fqdn, fqdn

See also:

yes futex (noun)

Description: A "futex" (an abbreviation for "fast userspace mutex") is a Linux kernel system call that programmers can use to implement basic locking or as a building block for higher-level locking abstractions.

Use it: yes

Incorrect forms:

See also: futexes, mutex

yes futexes (noun)

Description: "Futex" is an abbreviation of "fast user-space mutex". "Futexes" is the correct plural form.

Use it: yes

Incorrect forms:

See also: futex, mutexes

with caution fuzzy (adjective)

Description: It is only correct to use "fuzzy" as an adjective when referring to "fuzzy searches" (the technique of finding strings that match a pattern approximately, rather than exactly). See Avoiding Slang, Metaphors, and Misleading Language for details and examples.

Use it: with caution

Incorrect forms:

See also:

G

yes G++ (noun)

Description: "G" is a C compiler usually operated using the command line. When referring to the program, use "G++".

Use it: yes

Incorrect forms:

See also: g++

yes g++ (noun)

Description: "G" is a C compiler usually operated through the command line. When referring to the command, use "g++", marked up appropriately.

Use it: yes

Incorrect forms:

See also: G++

yes GAS (noun)

Description: "GAS" is an acronym for "GNU Assembler", the assembler used by the GNU Project. When referring to the program, use "GAS".

Use it: yes

Incorrect forms:

See also: gas

yes gas (noun)

Description: "GAS" is an acronym for "GNU Assembler", the assembler used by the GNU Project. When referring to the command, use gas, marked up appropriately.

Use it: yes

Incorrect forms:

See also: GAS

yes GB (noun)

Description: "GB" is an abbreviation for gigabyte. Use a space between the value and the abbreviation, for example, "a 2 GB file".

Use it: yes

Incorrect forms: gb, Gb

See also: gigabyte

yes Gbps (noun)

Description: "Gbps" is an abbreviation for Gigabits per second, a data transfer speed measurement for high-speed networks such as Gigabit Ethernet. When used to describe data transfer rates, a gigabit equals 1,000,000,000 bits.

Use it: yes

Incorrect forms: gbps, GBPS

See also:

yes GCC (noun)

Description: "GCC" is an abbreviation for the "GNU Compiler Collection". GCC is a compiler system produced by the GNU Project supporting various programming languages. When referring to the program, use "GCC".

Use it: yes

Incorrect forms:

See also: gcc

yes gcc (noun)

Description: "GCC" is an abbreviation for the "GNU Compiler Collection". GCC is a compiler system produced by the GNU Project supporting various programming languages. When referring to the command, use gcc, marked up appropriately.

Use it: yes

Incorrect forms:

See also: GCC

yes GCJ (noun)

Description: "GCJ" is an abbreviation for the "GNU Compiler for Java". GCJ was a free compiler for the Java programming language and part of the GNU Compiler Collection. As of 2015, there were no new developments announced from GCJ. In 2016, GCJ was removed from GCC. When referring to the program, use "GCJ".

Use it: yes

Incorrect forms:

See also: gcj, GCC

yes gcj (noun)

Description: "GCJ" is an abbreviation for the "GNU Compiler for Java". GCJ was a free compiler for the Java programming language and part of the GNU Compiler Collection. As of 2015, there were no new developments announced from GCJ. In 2016, GCJ was removed from GCC. When referring to the command, use gcj, marked up appropriately.

Use it: yes

Incorrect forms:

See also: GCJ, gcc

yes GDB (noun)

Description: "GDB" is an abbreviation for "GNU Debugger", the standard debugger for the GNU operating system. It is a portable debugger that runs on many operating systems that are similar to the UNIX system, and works for many programming languages. When referring to the program, use "GDB".

Use it: yes

Incorrect forms:

See also: gdb, Insight

yes gdb (noun)

Description: "GDB" is an abbreviation for "GNU Debugger", the standard debugger for the GNU operating system. It is a portable debugger that runs on many operating systems that are similar to the UNIX system, and works for many programming languages. When referring to the command, use gdb, marked up appropriately.

Use it: yes

Incorrect forms:

See also: GDB, Insight

yes GID (noun)

Description: "GID" is an abbreviation for "Group ID". Do not use "gid".

Use it: yes

Incorrect forms: gid, Gid

See also:

yes gigabyte (noun)

Description: A "gigabyte" is 2 to the 30th power (1,073,741,824) bytes. One gigabyte is equal to 1,024 megabytes. When abbreviating gigabyte, use "GB".

Use it: yes

Incorrect forms:

See also: GB

yes GIMP (noun)

Description: "GIMP" is an acronym for "GNU Image Manipulation Program". Do not use "Gimp" or "gimp".

Use it: yes

Incorrect forms: Gimp, gimp

See also:

yes Git (noun)

Description: Git is an open source version control system. Use "Git" when referring to the software in general, for example, "Clone the Git repository." Do not use lowercase "git" unless you are referring to the git command; as such, mark it up in monospace.

Use it: yes

Incorrect forms: git, GIT

See also:

yes GNOME (noun)

Description: "GNOME" is an open source desktop environment for operating systems that are similar to the UNIX system.

Use it: yes

Incorrect forms: Gnome, gnome

See also: GNOME Classic

yes GNOME Classic (noun)

Description: Although the desktop team tends to refer to "GNOME Classic" (technically, GNOME Shell with the classic mode extensions enabled) as "classic mode" in internal and developer-oriented community documents, we should stay consistent with what is exposed to the user on the GNOME Display Manager (GDM) login screen, that is, "GNOME Classic". The GNOME "modern mode" (technically, GNOME Shell with the classic mode extensions disabled) is referred to as "GNOME" (on the login screen and elsewhere).

Use it: yes

Incorrect forms: classic mode

See also: GNOME

yes GNU (noun)

Description: "GNU" is a recursive acronym for "GNU’s Not UNIX". GNU is an open-source operating system that is similar to the UNIX system. Do not use "Gnu" or "gnu".

Use it: yes

Incorrect forms: Gnu, gnu

See also:

yes GNUPro (noun)

Description: "GNUPro" Toolkit for Linux is designed for developing commercial and noncommercial Linux applications on native Linux platforms. It is a set of tested and certified, open-source, GNU standard C, C++, and assembly language development tools. When referring to the Red Hat product, use "GNUPro".

Use it: yes

Incorrect forms:

See also:

yes GPL (noun)

Description: "GPL" is an abbreviation for "General Public License". Do not use "Gpl" or "gpl".

Use it: yes

Incorrect forms: Gpl, gpl

See also:

yes grayscale (noun)

Description: "Grayscale" is a range of gray shades from white to black, as used in a monochrome display or printout. Do not use "gray-scale" or "gray scale". Only the noun form is currently recognized.

Use it: yes

Incorrect forms: gray-scale, gray scale

See also:

yes GRUB (noun)

Description: "GRUB" is an acronym for "GRand Unified Bootloader", which is a Linux boot loader.

Use it: yes

Incorrect forms: Grub

See also:

yes GTK+ (noun)

Description: "GTK+" is an abbreviation for "GIMP Tool Kit". Do not use "GTK", "Gtk", or "gtk".

Use it: yes

Incorrect forms: GTK, Gtk, gtk

See also:

yes Guestfish (noun)

Description: "Guestfish" is an interactive shell that supports commands for accessing and modifying virtual disk images used in platform virtualization. You can use Guestfish for viewing and editing virtual machines (VMs) managed by libvirt.

Use it: yes

Incorrect forms:

See also: libvirt

yes guest operating system (noun)

Description: A "guest operating system" refers to the operating system that is installed in a virtual machine. Do not use "guest" by itself, because it is ambiguous.

Use it: yes

Incorrect forms:

See also:

H

yes hard code (verb)

Description: "Hard code" means to configure values in source code such that it cannot be altered without modifying the code.

Use it: yes

Incorrect forms: hardcode

See also:

yes hard-coded (adjective)

Description: A "hard-coded" value is a value that is configured in the source code such that it cannot be altered without modifying the code.

Use it: yes

Incorrect forms: hardcoded

See also:

no he (pronoun)

Description: Reword the sentence to avoid using "he" or "she".

Use it: no

Incorrect forms:

See also: she

yes health check (noun)

Description: A "health check" identifies inefficiencies in your IT systems, applications, and maintenance. "Health check" is only capitalized when it is part of a product name, for example, "Red Hat Enterprise Linux Server Health Check". Do not capitalize "health check" when referring to those services in a general way, for example, "A health check ensures your systems perform at their best."

Use it: yes

Incorrect forms: healthcheck, health-check

See also:

yes help desk (noun)

Description: A "help desk" is a service that provides support for computer users.

Use it: yes

Incorrect forms: helpdesk, help-desk

See also:

yes hertz (noun)

Description: A "hertz" is a unit of frequency. Capitalize the initial "H" only at the beginning of a sentence. The correct abbreviation is "Hz".

Use it: yes

Incorrect forms:

See also:

yes high-availability (adjective)

Description: Use "high-availability" to describe an object that is continuously available, for example, "high-availability cluster".

Use it: yes

Incorrect forms:

See also: high availability

yes high availability (noun)

Description: "High availability" is the concept of making a system or service continuously available, even if a particular component experiences a failure. An example is, "Support is available 24x7 to help maintain high availability."

Use it: yes

Incorrect forms:

See also: high-availability

yes high-performance computing (noun)

Description: "High-performance computing" is the use of parallel processing to obtain much more efficient processing of complex programs. Use standard hyphenation guidelines to maintain clarity.

Use it: yes

Incorrect forms:

See also:

yes host group (noun)

Description: A "host group" is a group of one or more hosts. Only capitalize the initial "H" at the beginning of a sentence.

Use it: yes

Incorrect forms: hostgroup

See also:

yes hot add (verb)

Description: "Hot add" is the ability to add physical or virtual hardware to a running system without the need for downtime.

Use it: yes

Incorrect forms: hotadd, hot-add

See also: hot plug, hot swap

yes hotline (noun)

Description: A "hotline" is a direct communications link between two points in which communications are automatically directed to a specific destination without the need for additional routing.

Use it: yes

Incorrect forms: hot-line

See also:

yes hot plug (verb)

Description: "Hot plug" is the ability to add or remove physical or virtual hardware to or from a running system without the need for downtime.

Use it: yes

Incorrect forms: hotplug, hot-plug

See also: hot add, hot swap

yes hot swap (verb)

Description: "Hot swap" is the ability to remove and replace physical or virtual hardware on a running system without the need for downtime.

Use it: yes

Incorrect forms: hotswap, hot-swap

See also: hot add, hot plug

yes HP ProLiant (noun)

Description: "HP ProLiant" is a Hewlett-Packard (HP) server. Do not use any other variations.

Use it: yes

Incorrect forms: HP Proliant

See also:

yes HTML (noun)

Description: "HTML" is an abbreviation for "HyperText Markup Language", a markup language for web pages. When referring to the language, use "HTML", such as "To see the HTML version of this documentation". When referring to a web page extension, use "html", such as "The main page is index.html."

Use it: yes

Incorrect forms:

See also:

yes huge-page (adjective)

Description: Use "huge-page" when referring to page sizes on Linux-based systems larger than the default size of 4096 bytes. Normal hyphenation rules apply. See huge page for capitalization rules.

Use it: yes

Incorrect forms:

See also: huge page (noun)

yes huge page (noun)

Description: Use "huge page" when referring to page sizes on Linux-based systems larger than the default size of 4096 bytes. Use the two-word version in uppercase and lowercase. Capitalize "huge" at the beginning of a sentence, and capitalize both words in titles. If you are documenting a user interface, use the capitalization used in that interface.

Use it: yes

Incorrect forms: large page, super page

yes Hyper-Threading (noun)

Description: "Hyper-Threading" is the Intel implementation of simultaneous multithreading. If you are not referring specifically to the Intel implementation, use "simultaneous multithreading" or "SMT".

Use it: yes

Incorrect forms: hyperthreading, hyper-threading

See also:

yes hyperconverged (adjective)

Description: A hyperconverged system combines compute, storage, networking, and management capabilities into a single solution, simplifying deployment and reducing the cost of acquisition and maintenance.

Use it: yes

Incorrect forms: hyper-converged

See also:

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 Hat Enterprise Virtualization Hypervisor.

Use it: yes

Incorrect forms: HyperVisor, Hyperviser

See also:

I

yes IaaS (noun)

Description: "IaaS" is an acronym for "Infrastructure-as-a-Service". Always use hyphens when spelling out the acronym.

Use it: yes

Incorrect forms:

See also: PaaS, SaaS

yes IBM eServer System p (noun)

Description: Use "IBM eServer System p" for the first reference, and "IBM System p" or "System p" for subsequent references.

Use it: yes

Incorrect forms: pSeries

See also:

yes IBM S/390 (noun)

Description: The "IBM S/390" is the IBM large server (or mainframe) line of computer systems. Use the full description "IBM S/390".

Use it: yes

Incorrect forms: S/390, S90

See also:

yes IBM Z (noun)

Description: "IBM Z" is the new name for the "IBM z Systems" family of IBM mainframe computers.

Use it: yes

Incorrect forms: IBM z Systems

See also:

yes in-memory (adjective)

Description: In-memory systems store data in a computer’s main memory, random access memory (RAM). Clusters share memory resources, which reduces waste and boosts application performance by providing access to data in the same memory space where code executes.

Use it: yes

Incorrect forms:

See also:

yes InfiniBand (noun)

Description: "InfiniBand" is a switched fabric network topology used in high-performance computing. The term is both a service mark and a trademark of the InfiniBand Trade Association. Their rules for using the mark are standard ones: append the ™ symbol the first time it is used, and respect the capitalization (including the inter-capped "B") from then on. In ASCII-only circumstances, the "(TM)" string is the acceptable alternative.

Use it: yes

Incorrect forms: Open InfiniBand, Infiniband

See also:

yes insecure (adjective)

Description: "Insecure" refers to something that is unsafe.

Use it: yes

Incorrect forms: nonsecure, non-secure

See also:

yes Insight (noun)

Description: "Insight" is a graphical user interface to the GNU Debugger (GDB). Insight is written in Tcl/Tk and was developed by associates from Red Hat and Cygnus Solutions.

Use it: yes

Incorrect forms: GDBTK

See also: GBD, gdb

yes installation program (noun)

Description: An "installation program" is a program that installs certain software.

Use it: yes

Incorrect forms: the installer

See also:

yes Intel® Core™ (noun)

Description: "Intel® Core™" refers to a line of Intel brand processors.

Use it: yes

Incorrect forms:

See also:

yes Intel® EP80579 Integrated Processor (noun)

Description: "Intel® EP80579 Integrated Processor" is the official brand name.

Use it: yes

Incorrect forms: Tolapai, Intel Tolapai

See also:

yes Intel Virtualization Technology (noun)

Description: The first and all prominent uses of "Intel Virtualization Technology" should be spelled out, immediately followed by the abbreviation, for example, "Intel Virtualization Technology (Intel VT) for Intel 64 or Itanium architecture (Intel VT-i)". Subsequent uses can be abbreviated to "Intel VT-i". Always write the abbreviation in uppercase letters, accompanied by the Intel mark. Do not use the abbreviation in any prominent places, such as in titles or paragraph headings. Do not include any trademark symbols, such as ™ or "(TM).

Use it: yes

Incorrect forms: VT-i, VT

See also:

yes Intel® Xeon® (noun)

Description: "Intel® Xeon®" refers to a line of Intel brand processors.

Use it: yes

Incorrect forms:

See also:

no interesting (adjective)

Description: Avoid using "interesting", as this term is a substitute for showing the reader why something is of interest. Instead of writing, "It is interesting to note…​", consider using a "Note" admonition.

Use it: no

Incorrect forms:

See also:

yes IOPS (noun)

Description: "IOPS" is an acronym for "input/output operations per second".

Use it: yes

Incorrect forms: Iops, IOPs

See also:

yes IP (noun)

Description: "IP" is an abbreviation for "Internet Protocol".

Use it: yes

Incorrect forms: Ip

See also:

yes IP Masquerade (noun)

Description: "IP Masquerade" is a Linux networking function. IP Masquerade, also called "IPMASQ" or "MASQ", allows one or more computers in a network without assigned IP addresses to communicate with the internet using the Linux server’s assigned IP address. The IPMASQ server acts as a gateway, and the other devices are invisible behind it. To other machines on the internet, the outgoing traffic appears to be coming from the IPMASQ server and not the internal PCs. Because IPMASQ is a generic technology, the server can be connected to other computers through LAN technologies such as Ethernet, Token Ring, and FDDI, as well as dial-up connections such as PPP or SLIP.

Use it: yes

Incorrect forms:

See also:

yes IPsec (noun)

Description: "IPsec" is an abbreviation for "Internet Protocol security".

Use it: yes

Incorrect forms: IPSec

See also:

yes IP switching (noun)

Description: "IP switching" is a type of IP routing developed by Ipsilon Networks, Inc. Unlike conventional routers, IP switching routers use ATM hardware to speed packets through networks. Although the technology is new, it appears to be considerably faster than older router techniques.

Use it: yes

Incorrect forms:

See also:

yes ISeries (noun)

Description: Use "IBM eServer System i" for the first reference, and "IBM System i" or "System i" for subsequent references.

Use it: yes

Incorrect forms: iSeries

See also:

yes ISO (noun)

Description: "ISO" is an acronym for the "International Organization for Standardization", which is an international standard-setting body made up of representatives from multiple national standards organizations. Since its founding in February 1947, ISO has promoted worldwide proprietary, industrial, and commercial standards.

Use it: yes

Incorrect forms: iso

See also:

yes ISO image (noun)

Description: An "ISO image" is a type of disk image comprising the data contents from every written sector on a media disk. ISO image files use the .iso file extension. According to Wikipedia, the ISO name comes from the ISO 9660 file system used with CD-ROM media, but what is known as an ISO image might also contain a UDF (ISO/IEC 13346) file system, which is often used by DVDs and Blu-ray discs.

Use it: yes

Incorrect forms: iso image

See also:

yes IT, I.T. (noun)

Description: "IT" and "I.T." are abbreviations for "information technology". Use "I.T." (with periods) only in headlines or subheadings where all uppercase letters are used, to clarify that the word is "IT" rather than "it".

Use it: yes

Incorrect forms:

See also:

yes Itanium (noun)

Description: "Itanium" is a 64-bit RISC microprocessor and a member of Intel’s Merced family of processors. Based on the Explicitly Parallel Instruction Computing (EPIC) design philosophy, which states that the compiler should decide which instructions be executed together, Itanium has the highest FPU power available. In 64-bit mode, Itanium is able to calculate two bundles of a maximum of three instructions at a time. In 32-bit mode, it is much slower. Decoders must first translate 32-bit instruction sets into 64-bit instruction sets, which results in extra-clock cycle use. Itanium’s primary use is driving large applications that require more than 4 GB of memory, such as databases, ERP, and future internet applications.

Use it: yes

Incorrect forms: IA64, ia64

See also:

yes Itanium 2 (noun)

Description: "Itanium 2" is correct. Do not use "Itanium2" without the space between "Itanium" and "2".

Use it: yes

Incorrect forms: Itanium2

See also:

J

yes JavaScript (noun)

Description: "JavaScript" is a trademark of Oracle Corporation and should be used when referring to the scripting language. When referring to a file written using this language, use "javascript".

Use it: yes

Incorrect forms:

See also: javascript

yes javascript (adjective)

Description: When referring to a file written using the "JavaScript" language, use all lowercase letters, for example, "Copy the IPA javascript file to the /temp/ directory."

Use it: yes

Incorrect forms:

See also: JavaScript

yes JBoss Community (noun)

Description: Use "JBoss Community" when referring to the community of users and contributors. Do not refer to the community as "JBoss.org".

Use it: yes

Incorrect forms: JBoss.org

See also:

yes JBoss Way (noun)

Description: Capitalize "JBoss Way" as a formal, branded concept when referring specifically to the JBoss cultural and business climate or practices. If the reference is generic or the way is further specified, do not capitalize "way".

Use it: yes

Incorrect forms:

See also: Red Hat Way, open source way

yes job (noun)

Description: A "job" is a task performed by a computer system, for example, printing a file is a job. Jobs can be performed by a single program or by a collection of programs.

Use it: yes

Incorrect forms:

See also:

yes jsvc (noun)

Description: The Apache Commons Daemon "jsvc" is a set of libraries and applications for making Java applications run on UNIX systems more easily. Capitalize the initial "J" only at the beginning of a sentence.

Use it: yes

Incorrect forms:

See also:

yes JVM (noun)

Description: "JVM" is an abbreviation for "Java Virtual Machine" and a registered trademark of Oracle Corporation. Due to this registration, use the full phrase "Java Virtual Machine" or "Java VM", or only the noun itself, "virtual machine". You can include JVM for clarity because most people know it as such, for example, "Java Virtual Machine (JVM)".

Use it: yes

Incorrect forms: Jvm, jvm

See also:

K

yes KB (noun)

Description: "KB" is an abbreviation for "kilobyte". One KB equals 1024 bytes.

Use it: yes

Incorrect forms:

See also: kB

yes kB (noun)

Description: "kB" is an abbreviation for "kilobyte". One kB equals 1000 bytes.

Use it: yes

Incorrect forms:

See also: KB

no kerberize (verb)

Description: Do not use "kerberize" or other variants to refer to applications or services that use Kerberos authentication. Refer to such applications as "Kerberos-aware" or "Kerberos-enabled", or rewrite the sentence.

Use it: no

Incorrect forms:

See also: kerberized

no kerberized (adjective)

Description: Do not use "kerberized" or other variants to refer to applications or services that use Kerberos authentication. Refer to such applications as "Kerberos-aware" or "Kerberos-enabled", or rewrite the sentence.

Use it: no

Incorrect forms:

See also: kerberize

yes kernel (noun)

Description: The "kernel" is the central module of an operating system. It is the part of the operating system that loads first, and it remains in main memory. Because it stays in memory, it is important for the kernel to be as small as possible while still providing all the essential services required by other parts of the operating system and applications. Typically, the kernel is responsible for memory management, process and task management, and disk management.

Do not capitalize the first letter.

Use it: yes

Incorrect forms: Kernel

yes Kernel-based Virtual Machine (noun)

Description: "Kernel-based Virtual Machine" is a loadable kernel module that converts the Linux kernel into a bare-metal hypervisor. Spell out "Kernel-based Virtual Machine" on first occurrence, and use "KVM" thereafter. It is an industry standard and a proper noun.

Use it: yes

Incorrect forms: kernel-based virtual machine

See also: KVM

yes kernel oops (noun)

Description: A "kernel oops" is an error in the Linux kernel. Do not use "oops" by itself.

Use it: yes

Incorrect forms: oops

See also: kernel, kernel panic

yes kernel panic (noun)

Description: Numerous circumstances can cause a "kernel panic". Unlike a "kernel oops", when confronted with a kernel panic, the operating system shuts down to prevent the possibility of further damage or security breaches.

Use it: yes

Incorrect forms:

See also: kernel, kernel oops

yes kernel space (noun)

Description: "Kernel space" is the part of the system memory where the kernel executes and provides its services.

Use it: yes

Incorrect forms: kernelspace

See also: kernel, kernel-space

yes kernel-space (adjective)

Description: "Kernel space" is that part of the system memory where the kernel executes and provides its services. When used as modifier, use the hyphenated form "kernel-space".

Use it: yes

Incorrect forms: kernelspace

See also: kernel, kernel space

yes Kickstart (noun)

Description: "Kickstart" is a tool for Red Hat Enterprise Linux and Fedora-based distributions that allows you to control various aspects of a system install process using commands in a text file. You can use Kickstart to change defaults or even do a fully automatic installation. Capitalize the first letter.

Use it: yes

Incorrect forms: kickstart

See also:

yes knowledge base (noun)

Description: Use the two-word "knowledge base" unless referring specifically to the "Red Hat Knowledgebase".

Use it: yes

Incorrect forms: knowledgebase

See also: Knowledgebase

yes Knowledgebase (noun)

Description: Red Hat Knowledgebase includes solutions and articles written mainly by GSS support engineers. The proper spelling is "Knowledgebase", not "KnowledgeBase".

Use it: yes

Incorrect forms: KnowledgeBase

See also: knowledge base

yes KVM (noun)

Description: "KVM" is an abbreviation for "Kernel-based Virtual Machine".

Use it: yes

Incorrect forms: kvm

L

yes LAN (noun)

Description: "LAN" is an acronym for "local area network".

Use it: yes

Incorrect forms: Lan, lan

See also:

yes latency (noun)

Description: (1) In general, "latency" is the period of time that one component in a system is waiting for another component, which is wasted time. In accessing data on a disk, latency is the time it takes to position the proper sector under the read/write head. (2) In networking, "latency" is the amount of time it takes a packet to travel from source to destination. Latency and bandwidth define the speed and capacity of a network.

Use it: yes

Incorrect forms:

See also: bandwidth

yes libvirt (noun)

Description: "libvirt" is an open source API, daemon, and management tool for managing platform virtualization. It can manage several types of virtualization technologies, including KVM and QEMU. libvirt APIs are used in the orchestration layer of hypervisors in the development of cloud-based environments.

Use it: yes

Class: noun

Incorrect forms: Libvirt

See also: KVM

yes Linux (noun)

Description: "Linux" is an operating system that is similar to the UNIX system. Do not use "LINUX" because it is not an acronym. Do not use "linux" unless you are referring to a command, such as "To start Linux, type linux." In that case, mark it correctly.

Use it: yes

Incorrect forms: LINUX, linux

See also:

yes load (verb)

Description: (1) To "load" means to copy a program from a storage device into memory. Every program must be loaded into memory before it can be executed. Usually, the loading process is performed invisibly by a part of the operating system called the loader. (2) In programming, "load" means to copy data from main memory into a data register. (3) In networking, "load" refers to the amount of data (traffic) being carried by the network.

Use it: yes

Incorrect forms:

See also:

yes load balancing (noun)

Description: "Load balancing" distributes processing and communications activity evenly across a computer network so that no single device is overwhelmed. Load balancing is especially important for networks, where it is difficult to predict the number of requests that might be issued to a server. Busy websites typically employ two or more web servers in a load-balancing scheme. If one server starts to get swamped, requests are forwarded to another server with more capacity. Load balancing can also refer to the communications channels themselves.

Use it: yes

Incorrect forms:

See also:

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.

Use it: yes

Incorrect forms:

with caution lookup (noun)

Description: A "lookup" means an act of searching. The correct noun form is "lookup".

Use it: with caution

Incorrect forms:

See also: look up, look-up

with caution look up (verb)

Description: To "look up" means to search for something. The correct verb form is "look up".

Use it: with caution

Incorrect forms:

See also: lookup, look-up

with caution look-up (adjective)

Description: Hyphenate "look-up" when using it as a modifier.

Use it: with caution

Incorrect forms:

See also: look up, lookup

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.

Use it: yes

Incorrect forms:

See also:

yes LPAR (noun)

Description: "LPAR" is an acronym for "logical partitioning", a system of taking a computer’s total resources (processors, memory, and storage) and splitting them into smaller units that each can be run with its own instance of the operating system and applications. Logical partitioning, which requires specialized hardware circuits, is typically used to separate different functions of a system, such as web serving, database functions, client/server actions, or systems that serve multiple time zones and/or languages. Logical partitioning can also be used to keep testing environments separated from the production environments. Because the logical partitions act as separate physical machines, they can communicate with each other. Logical partitioning was first used in 1976 by IBM.

Use it: yes

Incorrect forms:

See also:

M

yes manual page (noun)

Description: A "manual page" is a form of software documentation tied directly with packages providing that software. It is accessible by using the man <utility> command from the command-line interface.

Use it: yes

Incorrect forms:

See also: man page

yes man page (noun)

Description: "Man page" is an abbreviation for "manual page".

Use it: yes

Incorrect forms: manpage

See also: manual page

yes many (noun)

Description: Use "many" to indicate the number of objects.

Use it: yes

Incorrect forms: lots of, bunches of

See also:

yes Master Boot Record (noun)

Description: "Master Boot Record" (MBR) is a small program that is executed when a computer boots up. Typically, the MBR resides on the first sector of the hard disk. The program begins the boot process by looking up the partition table to determine which partition to use for booting. It then transfers program control to the boot sector of that partition, which continues the boot process.

Use it: yes

Incorrect forms:

See also: MBR

yes matrixes (noun)

Description: In mathematics, a "matrix" is a rectangular array of numbers, symbols, or expressions arranged in rows and columns. The correct plural form for US English spelling is "matrixes".

Use it: yes

Incorrect forms: matrices

See also:

yes MB (noun)

Description: "MB" is an abbreviation for "megabyte", which is 1,000,000 bytes or 1,048,576 bytes, depending on the context.

Use it: yes

Incorrect forms:

See also: Mb

yes Mb (noun)

Description: "Mb" is an abbreviation for "megabit". One megabit equals 1000 kilobits or 1,000,000 bits.

Use it: yes

Incorrect forms:

See also: MB

yes MBps (noun)

Description: "MBps" is an abbreviation for "megabytes per second", a measure of data transfer speed. Mass storage devices are generally measured in MBps.

Use it: yes

Incorrect forms:

See also:

yes MBR (noun)

Description: "MBR" is an abbreviation for "Master Boot Record".

Use it: yes

Incorrect forms:

See also: Master Boot Record

yes media (noun)

Description: (1) "Media" are objects on which data can be stored. These objects include hard disks, diskettes, CDs, and tapes. (2) In computer networks, "media" refer to the cables linking workstations together. There are many different types of transmission media, the most popular being twisted-pair wire (normal electrical wire), coaxial cable (the type of cable used for cable television), and fiber optic cable (cables made out of glass). (3) "Media" can also mean the form and technology used to communicate information. Multimedia presentations, for example, combine sound, pictures, and videos, all of which are different types of media.

Use it: yes

Incorrect forms:

See also:

Description: Use "menu-driven" to refer to programs whose user interface employs menus rather than command-line interface commands.

Use it: yes

Incorrect forms: menu driven, menudriven

See also: command-driven

with caution micro release (noun)

Description: "Micro release" refers to the z in an x.y.z product version numbering schema. Use only if required for generic reference to a release and the term is in use already by the product. In all other instances refer to the specific release number.

Use it: with caution

Incorrect forms:

See also: z-stream

yes Microsoft (noun)

Description: "Microsoft" is a technology company that develops, manufactures, licenses, supports, and sells computer software, consumer electronics, personal computers, and services.

Use it: yes

Incorrect forms: MS, MSFT, MicroSoft

See also: MS-DOS

with caution misconfigure (verb)

Description: "Misconfigure" means to configure something incorrectly. Avoid using it if possible.

Use it: with caution

Incorrect forms: mis-configure

See also:

yes mount (verb)

Description: (1) "Mount" means to make a mass storage device available. In Linux environments, for example, inserting a floppy disk into the drive is called "mounting" the floppy. (2) "Mount" also means to install a device, such as a disk drive or expansion board.

Use it: yes

Incorrect forms:

See also:

yes mouse button (noun)

Description: Use "mouse button" as two words. If you need to indicate which mouse button to use, use "right", "left", or "center", such as "right mouse button".

Use it: yes

Incorrect forms: mouse-button, mousebutton

See also:

yes Mozilla Firefox (noun)

Description: "Mozilla Firefox" is an open source web browser. The first reference must be "Mozilla Firefox". Subsequent references can be "Firefox". Do not use "firefox" unless you are referring to the firefox command; as such, mark it correctly.

Use it: yes

Incorrect forms: firefox

yes Mozilla Thunderbird (noun)

Description: "Mozilla Thunderbird" is a free, open source, cross-platform email, news, RSS, and chat client. The first reference must be "Mozilla Thunderbird". Subsequent references can be "Thunderbird". Do not use "thunderbird" unless you are referring to the thunderbird command; as such, mark it correctly.

Use it: yes

Incorrect forms: thunderbird

See also: Mozilla Firefox

yes MS-DOS (noun)

Description: "MS-DOS" is an operating system, mostly developed by Microsoft.

Use it: yes

Incorrect forms: ms-dos, MSDOS, msdos

See also: Microsoft

yes multiprocessing (noun)

Description: "Multiprocessing" is the use of two or more central processing units within a single computer system.

Use it: yes

Incorrect forms: multi-processing

See also:

yes multitenant (adjective)

Description: "Multitenant" describes a mode where a software instance serves multiple tenants. Do not hyphenate "multitenant".

Use it: yes

Incorrect forms: multi-tenant

See also:

yes mutual exclusion (noun)

Description: In computer science, "mutual exclusion" is a property of concurrency control, which is instituted for the purpose of preventing race conditions. It is the requirement that one thread of execution never enter its critical section at the same time that another concurrent thread of execution enters its own critical section.

Use it: yes

Incorrect forms:

See also: Mutex, Mutexes

yes mutex (noun)

Description: "Mutex" is an abbreviation for "mutual exclusion".

Use it: yes

Incorrect forms:

yes mutexes (noun)

Description: "Mutexes" is the plural form of "mutex".

Use it: yes

Incorrect forms:

See also: mutual exclusion, Mutex

yes MySQL (noun)

Description: "MySQL" is the common open source database server and client package from Microsoft. Mark the first mention of MySQL in body text with an r-ball (®) to denote that it is a registered trademark.

Use it: yes

Incorrect forms: MYSQL, mySQL

See also: SQL

N

yes need (verb)

Description: Use "need" instead of "desire" or "wish". Use "want" when the reader’s actions are optional (that is, one might not need something but might still want something).

Use it: yes

Incorrect forms: desire, wish

See also: want

yes neighbor (noun)

Description: "Neighbor" is the accepted spelling.

Use it: yes

Incorrect forms: neighbour

See also:

no network interface card

Description: Do not use "network interface card" for the acronym "NIC". Use "network interface controller" instead.

Use it: no

Incorrect forms:

yes network interface controller (NIC)

Description: The physical or virtual hardware that provides Ethernet connectivity between a host or virtual machine and a network.

Use it: yes

Incorrect forms: network interface card

See also: vNIC, SmartNIC

yes network transparency (noun)

Description: "Network transparency" is a condition where an operating system or other service allows the user access to a remote resource through a network without needing to know if the resource is remote or local. For example, Sun Microsystems' NFS, which has become a de facto industry standard, provides access to shared files through an interface called the Virtual File System (VFS) that runs on top of the TCP/IP stack. Users can manipulate shared files as if they were stored locally on the user’s hard disk.

Use it: yes

Incorrect forms:

See also:

yes NIC

Description: "NIC" is an acronym for "network interface controller".

Use it: yes

Incorrect forms:

See also: vNIC, SmartNIC

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, use "node" to refer to 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". 4) In Fuse tooling, a node is a Camel component or EIP that has been dragged from the Palette and dropped on the route editor’s canvas displayed on the Design tab. Selecting a node on the canvas displays its properties in Properties view for editing. Selecting a node on the canvas also displays its usage details on the Documentation tab in Properties view.

Use it: yes

Incorrect forms:

See also:

yes now (adverb)

Description: "Now" means at the present time, immediately, or at once.

Use it: yes

Incorrect forms: right now

See also:

with caution numbers (adverb)

Description: Spell out the numbers zero through nine. Spell out any number that begins a sentence. Spell out a number that precedes another number (four 6-pound bags or eleven 20-pound bags). Spell out approximations (for example, thousands of …​) and very large values (for example, 4 billion). Use numerals for numbers 10 and greater, negative numbers, fractions, percentages, decimals, measurements, references to book sections (Chapter 3, Table 5, Page 11), and numbers less than 10 if they appear in the same paragraph as numbers of 10 or greater. (You answered 8 out of 14 questions correctly.) Use numerals when referring to registers (such as R1), code (such as x = 6), and release versions (Red Hat Enterprise Linux 6, Source-Navigator 4.5). Do not use commas in numbers with four digits (for example, 1000 rather than 1,000). Use commas in numbers with five or more digits (for example, 10,000). See the IBM Style Guide for detailed information on numbering formats.

Use it: with caution

Incorrect forms:

See also:

O

yes Objective C (noun)

Description: "Objective C" is the name of a programming language.

Use it: yes

Incorrect forms: Objective-C

See also:

yes OEM (noun)

Description: "OEM" is an abbreviation for "original equipment manufacturer", which is a misleading term for a company that has a special relationship with computer producers. OEMs buy computers in bulk and customize them for a particular application. They then sell the customized computer under their own name. OEMs are not the original manufacturers; they are the customizers.

Use it: yes

Incorrect forms:

See also:

yes offline backup (noun)

Description: Use "offline backup" to refer to backing up a database while the database is not being accessed by applications.

Use it: yes

Incorrect forms: cold backup

See also: online backup

yes OK (noun)

Description: When referring to the "OK" button, it is not necessary to use "button" in the sentence.

Use it: yes

Incorrect forms: OK button

See also:

yes omit (verb)

Description: Use "omit" rather than "leave out" and other terms meaning the same thing.

Use it: yes

Incorrect forms: leave out

See also:

with caution on-board (adjective)

Description: Hyphenate "on-board" when using it as an adjective. The term "on board" is also valid, for example, "They are on board with the idea." Try to reword the sentence to avoid using "on board".

Use it: with caution

Incorrect forms:

See also: onboard

with caution onboard (verb)

Description: "Onboard" is usually used to describe the process of introducing a new employee to the company.

Use it: with caution

Incorrect forms:

See also: on-board

yes online backup (noun)

Description: From webopedia: In storage technology, "online backup" means to back up data from your hard drive to a remote server or computer using a network connection.

Use it: yes

Incorrect forms:

See also: offline backup

with caution on-premise (adjective)

Description: Substitute "on-site" or "in-house" for "on-premise" whenever possible. Although "on-premises" is grammatically correct, "on-premise" is preferred by the industry and the Red Hat Cloud business unit. Capitalize "on-premise" only when using it as part of the name of the Red Hat product "Red Hat Storage Server for On-premise".

Use it: with caution

Incorrect forms: on premise, on-premises, on-prem

See also:

yes opcode (noun)

Description: An "opcode" is the portion of a machine language instruction that specifies the operation to be performed.

Use it: yes

Incorrect forms: op-code

See also:

yes open architecture (noun)

Description: An "open architecture" is an architecture whose specifications are public. This includes officially approved standards as well as privately designed architectures whose specifications are made public by the designers. The opposite of "open architecture" is "closed architecture" or "proprietary architecture".

Use it: yes

Incorrect forms:

See also:

yes open source (noun)

Description: "Open source" means that the source code of a program or utility can be viewed, modified, and shared. See What is Open Source for details.

Use it: yes

Incorrect forms: open-source, OpenSource, opensource

See also:

yes OpEx (noun)

Description: "OpEx" is an abbreviation of "operating expenses".

Use it: yes

Incorrect forms: Opex, Opex, OPEX, opEx

See also:

yes operating environment (noun)

Description: An "operating environment" is the environment in which a user can run application software. An operating environment consists of a user interface provided by an applications manager and usually includes an application programming interface (API).

Use it: yes

Incorrect forms: Operating Environment

See also: control program

yes operating system (noun)

Description: From Wikipedia: An "operating system" is system software that manages computer hardware and software resources and provides common services for computer programs. All computer programs, excluding firmware, require an operating system to function.

Use it: yes

Incorrect forms: OS, Operating System

See also:

yes Operator (noun)

Description: In the context of Kubernetes, an Operator is a method of packaging, deploying, and managing a Kubernetes application. A Kubernetes application is an application that is both deployed on a Kubernetes cluster (including OpenShift clusters) and managed using the Kubernetes APIs and kubectl or oc tooling.

The term "Operator" in the context of Kubernetes is always capitalized to distinguish it from other types of operators, such as human or mathematical operators.

Example: Kubernetes Operator
= Support policy for unmanaged Operators

Individual Operators have a `managementState` parameter in their configuration.
Example: Mathematical operator
The following operators and operands are supported in Drools Rule Language:

* + (addition)
* - (subtraction)
...

The full name of an Operator must be a proper noun, with each word initially capitalized. If it includes a product name, defer to the product’s capitalization style guidelines. For example:

  • Red Hat OpenShift Logging Operator

  • Prometheus Operator

  • etcd Operator

  • Node Tuning Operator

  • Cluster Version Operator

Although "containerized" is allowed, do not use "Operatorize" to refer to building an Operator that packages an application.

Note
When referring generally to other Kubernetes components, such as pods, nodes, or image streams, use lowercase. When referring to a specific component, follow the capitalization of the component name and apply monospace formatting, such as "the Pod spec", "a Node object", or "an ImageStream resource".

Use it: yes

Incorrect forms: Kubernetes operator, operatorize

See also: API objects

yes Organization Administrator (noun)

Description: From Roles and Permissions for Red Hat Customer Portal: Organization Administrator: This is the highest permission level for a Red Hat account with full access to content and features. This is the only role that can manage users and control their access and permissions on an account.

Use Organization Administrator as a proper noun when referring to the Organization Administrator role for a Red Hat corporate account.

Use it: yes

Incorrect forms: Organization administrator, Org Admin, org admin

See also:

yes output device (noun)

Description: An "output device" is any machine capable of representing information from a computer, such as display screens, printers, plotters, and synthesizers.

Use it: yes

Incorrect forms:

See also:

yes override (verb)

Description: In computing, "override" means to force the use of a specific setting or value instead of the one that would otherwise be used, for example, "Apply a setting from a configuration file to override the default ones."

Use it: yes

Incorrect forms: over-ride, over ride

See also:

P

yes PaaS (noun)

Description: "PaaS" is an acronym for "Platform-as-a-Service". In the spelled-out version of this term and its variants (for example, "Infrastructure-as-a-Service" and "Software-as-a-Service"), hyphens are always used. Note for Marketing, Brand, or Customer Portal usage: For all-uppercase text, such as banners, use "<VARIANT>-AS-A-SERVICE" for the spelled-out version. The same acronym is used across all groups.

Use it: yes

Incorrect forms:

See also: SaaS, IaaS

yes PC (noun)

Description: "PC" is an abbreviation for personal computer. See the IBM Style Guide for further information.

Use it: yes

Incorrect forms:

See also:

yes performance counter (noun)

Description: A "performance counter" is a utility for collecting and analyzing performance data. Always use "performance counter" unless referring to a code element named perfcounter and as such, mark it up appropriately (perfcounter).

Use it: yes

Incorrect forms: perfcounter

See also:

yes persistent storage (noun)

Description: Persistent storage is a type of storage that preserves data even after the computer is turned off or after the process that created the data ends. A hard disk, tape, or flash memory are examples of persistent storage.

Use it: yes

Incorrect forms:

See also: volatile storage

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.

Use it: yes

Incorrect forms:

See also:

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.

Use it: yes

Incorrect forms:

yes Pico (noun)

Description: Capitalize "Pico" when referring to the text editor or to the programming language. Do not capitalize "pico" when referring to the SI prefix.

Use it: yes

Incorrect forms:

See also:

yes plain text (adjective)

Description: "Plain text" is correct in almost all cases. We use "plain text" as a plain English denotation of all unencrypted information, whether it is being stored or is being fed to an encryption algorithm. Unless it is necessary to make the cryptographer’s distinction, do not use "plaintext" or "cleartext". Cryptographers distinguish between "cleartext" (unencrypted data) and "plaintext" (unencrypted data as input to an encryption algorithm).

Use it: yes

Incorrect forms: plaintext, plain-text, cleartext, clear text

See also:

yes pluggable (noun)

Description: "Pluggable" refers to something that is capable of being plugged in, especially in terms of (for example) software modules. "Hot-pluggable" is also widely used with respect to hardware to indicate that it can be connected and recognized without powering down the system.

Use it: yes

Incorrect forms:

See also:

Description: A "pop-up" is a graphical user interface (GUI) display area, usually a small window, that is suddenly displayed in the foreground of the visual interface. Pop-ups can be initiated by a single or double mouse click or rollover (sometimes called a mouseover). A pop-up window must be smaller than the background window or interface; otherwise, it’s a replacement interface.

Use it: yes

Incorrect forms: popup, Pop-up

See also:

yes POSIX (noun)

Description: "POSIX" is an acronym for "Portable Operating System Interface [for UNIX]".

Use it: yes

Incorrect forms: Posix, posix, variations

See also:

yes PostScript (noun)

Description: "PostScript" is a registered trademark of Adobe.

Use it: yes

Incorrect forms: Postscript

See also:

yes PowerPC (noun)

Description: Depending on context, "PowerPC" refers to either "64-bit PowerPC" (which covers most 64-bit PowerPC implementations) or "64-bit IBM POWER Series" (which covers the IBM POWER2 and IBM POWER8 series). The PowerPC version of Red Hat Enterprise Linux runs on 64-bit IBM POWER series hardware in almost all cases.

Use it: yes

Incorrect forms: PPC, P-PC, PPC64

See also:

yes PPP (noun)

Description: "PPP" is an abbreviation for "Point-to-Point Protocol", a data link (layer 2) protocol used to establish a direct connection between two nodes. PPP can provide connection authentication, transmission encryption (using ECP, RFC 1968), and compression.

Use it: yes

Incorrect forms: Ppp, ppp

See also:

yes PROM (noun)

Description: "PROM" is an acronym for "programmable read-only memory" and is a variation of "ROM". PROMs are manufactured as blank chips on which data can be written with a device called a PROM programmer.

Use it: yes

Incorrect forms: prom, Prom

See also: ROM

yes proof of concept (noun)

Description: Use the following rules to form the plural of this phrase: Use "proofs of concept" for multiple proofs but only one concept. Use "proofs of concepts" for multiple proofs and multiple concepts.

Use it: yes

Incorrect forms: proof of concepts

See also:

no pSeries (noun)

Description: Use "IBM eServer System p" for the first reference; use "IBM System p" or "System p" for subsequent references.

Use it: no

Incorrect forms:

See also:

yes pseudo-ops (noun)

Description: "Pseudo-ops" is an abbreviation for "pseudo operations" and is sometimes called an assembler directive. These keywords do not directly translate to a machine instruction.

Use it: yes

Incorrect forms: pseudo ops, pseudoops

See also:

yes pulldown (adjective)

Description: A "pulldown" is the common type of menu used with a graphical user interface (GUI). Clicking a menu title causes the menu items to drop down from that position and be displayed. Options are selected either by clicking the menu item or by continuing to hold the mouse button down and letting go when the item is highlighted.

Use it: yes

Incorrect forms: pull-down

See also:

yes PXE (noun)

Description: "PXE" is an acronym for "Pre-Boot Execution Environment". Pronounced "pixie", PXE is one of the components of the Intel Wired for Management (WfM) specification. It allows a workstation to boot from a server on a network in preference to booting the operating system on the local hard drive. PXE is a mandatory element of the WfM specification. To be considered compliant, PXE must be supported by the computer’s BIOS and its NIC.

Use it: yes

Incorrect forms:

See also:

Q

yes Q and A (noun)

Description: "Q and A" is an abbreviation for "Question and Answer", as defined by the American Heritage Dictionary. In DocBook XML, the title is defined by the DocBook style sheets for the <qandadiv> element. The relevant generated text in English is "Q & A" and is localized automatically.

Use it: yes

Incorrect forms: q & a, q&a Q & A, Q&A

See also:

yes QCOW2 (noun)

Description: "QCOW2" is an abbreviation for "QEMU Copy On Write version 2". QCOW2 is a file format for disk image files used by QEMU, a hosted virtual machine monitor. Always write this term in uppercase letters.

Use it: yes

Incorrect forms: qcow2, Qcow2

See also: KVM

yes qeth (adjective)

Description: Messages with a prefix "qeth" are issued by the qeth device driver. The qeth device driver supports a multitude of network connections, for example, connections through Open Systems Adapters (OSA), HiperSockets™, guest LANs, and virtual switches.

Use it: yes

Incorrect forms: Qeth, QETH

See also:

no quiescent (adjective)

Description: This lofty-sounding word means at rest, quiet, or inactive. With reference to a measurable property or system, it can also mean not active. A system can be quiescent, meaning it is inactive, or (by extension) in a known, unchanging state. If this is what you mean, this is what you should write. If a system is, or needs to be inactive, write inactive. If a system is, or needs to be safe, write safe.

Use it: no

Incorrect forms:

See also:

R

yes RAM (noun)

Description: "RAM" is an acronym for "random access memory".

Use it: yes

Incorrect forms: Ram, ram

See also: RAM disk

yes RAM disk (noun)

Description: "RAM disk" refers to "RAM" that has been configured to simulate a disk drive. You can access files on a RAM disk as you would access files on a physical disk. RAM disks, however, are approximately a thousand times faster than hard disk drives. They are particularly useful for applications that require frequent disk accesses.

Use it: yes

Incorrect forms: RAMdisk, ramdisk, RAM-disk

See also: RAM

yes raw (adjective)

Description: In computing terms, "raw" means unprocessed. The term refers to data that is passed to an I/O device without being interpreted. In contrast, "cooked" refers to data that is processed before being passed to the I/O device. The term comes from the UNIX system, which supports cooked and raw modes for data output to a terminal. In cooked mode, special characters, such as erase and kill, are processed by the device driver before being sent to the output device.

Use it: yes

Incorrect forms: RAW

See also: cooked

yes raw data (noun)

Description: "Raw data" is information that has not been organized, formatted, or analyzed.

Use it: yes

Incorrect forms:

See also:

yes read (verb)

Description: To "read" means to copy data to a place where it can be used by a program. Read is commonly used to describe copying data from a storage medium, such as a disk, to main memory. It is also used to refer to the act of determining the contents of a variable or parameter.

Use it: yes

Incorrect forms:

See also: read (noun)

yes read (noun)

Description: When used as a noun, "read" refers to the act of reading, for example, "A fast disk drive performs 100 'reads' per second."

Use it: yes

Incorrect forms:

See also: read (verb)

no recommend (verb)

Description: Avoid "recommends". Instead of "Red Hat recommends", direct users to take the recommended action. This allows Red Hat to be more prescriptive in documentation and prevent any user uncertainty, and is easier for upstream/downstream coordinated efforts.

For example, instead of "Red Hat recommends using X package because", write "Use this package because" or "Use this package when".

Use it: no

Incorrect forms: we recommend, we suggest, Red Hat recommends

See also: we suggest

yes RedBoot (noun)

Description: "RedBoot" is an abbreviation for "Red Hat Embedded Debug and Bootstrap" firmware. RedBoot is a complete bootstrap environment for embedded systems. Based on the eCos Hardware Abstraction Layer, RedBoot inherits the eCos qualities of reliability, compactness, configurability, and portability.

Use it: yes

Incorrect forms: Redboot, Red Boot, red

See also:

no Red Hat Container Catalog (noun)

Description: "Red Hat Container Catalog" was the Red Hat-hosted registry for enterprise-ready containers located at access.redhat.com/containers.

The Red Hat Container Catalog no longer exists; it has become part of the Red Hat Ecosystem Catalog, which holds not only information about container images, but also information about certified software, hardware, and cloud service providers. The old Red Hat Container Catalog link redirects to the Container images section of the Red Hat Ecosystem Catalog.

Use it: no

Incorrect forms:

yes Red Hat Ecosystem Catalog (noun)

Description: The "Red Hat Ecosystem Catalog" is the official source for discovering and learning more about the Red Hat Certified Technology Ecosystem and certified third-party products and services. The Red Hat Ecosystem Catalog is a repository for all certified partner software, hardware, and public cloud provider images that run on, in, or under Red Hat software, such as Red Hat Enterprise Linux, OpenShift Container Platform, Red Hat OpenStack Platform, and Ansible.

Write this name in full the first time that you use it in a document. Subsequent uses can be shortened to "Ecosystem Catalog".

Use it: yes

Incorrect forms:

yes Red Hat Enterprise Linux

Description: "Red Hat Enterprise Linux" is an open source operating system based on Fedora and developed by Red Hat.

Use it: yes

Incorrect forms:

See also: RHEL

yes Red Hat Network Satellite Server (noun)

Description: Use "Red Hat Network Satellite Server" for the first occurrence; use "RHN Satellite Server" or omit the word "Server" from any of the previous constructions on subsequent mentions. With sufficient context, you can refer to "Satellite" and "Proxy", for example, "RHN Satellite and Proxy" instead of "RHN Satellite and RHN Proxy".

Use it: yes

Incorrect forms: Red Hat Satellite (Server)

yes Red Hat Network Proxy Server (noun)

Description: Use "Red Hat Network Proxy Server" for the first occurrence; use "RHN Proxy Server" or omit the word "Server" from any of the previous constructions on subsequent mentions. With sufficient context, you can refer to "Satellite" and "Proxy", for example, "RHN Satellite and Proxy" instead of "RHN Satellite and RHN Proxy".

Use it: yes

Incorrect forms: Red Hat Proxy (Server)

yes Red Hat Way (noun)

Description: "Red Hat Way" refers to the culture valued and maintained by Red Hat associates.

Use it: yes

Incorrect forms: Red Hat way

See also:

yes relative path (noun)

Description: The path related to the present working directory. Because it does not provide enough information for a program to locate a file, it must be combined with an additional path to access a file.

Use it: yes

Incorrect forms:

See also:

yes remote access (noun)

Description: "Remote access" is the ability to log on to a network from a distant location. Generally, this implies a computer, a modem, and some remote access software to connect to the network. "Remote control" refers to taking control of another computer, while "remote access" means that the remote computer actually becomes a full-fledged host on the network. The remote access software dials in directly to the network server. The only difference between a remote host and workstations connected directly to the network is slower data transfer speeds.

Use it: yes

Incorrect forms: remote-access

yes remote access server (noun)

Description: A "remote access server" is a server that is dedicated to handling users that are not on a LAN but need remote access to it. The remote access server allows users to gain access to files and print services on the LAN from a remote location. For example, a user who dials in to a network from home by using an analog modem or an ISDN connection dial in to a remote access server. After the user is authenticated, they can access shared drives and printers as if they were physically connected to the office LAN.

Use it: yes

Incorrect forms: remote-access server

See also: remote access

yes repository (noun)

Description: Repositories provide the packages required for Red Hat products. Using Red Hat Subscription Management (RHSM), you register a system, attach a subscription, and enable repositories. Do not confuse this with Red Hat Network (RHN), where you subscribed to channels.

Use it: yes

Incorrect forms: channel

yes required (adjective)

Description: "Required" can mean needed, essential, or obligatory. Example 1: "The module is missing essential parts." Example 2: "Filling in the Class field is obligatory."

Use it: yes

Incorrect forms:

See also:

yes Resilient Storage Add-On (noun)

Description: "Resilient Storage Add-On" is an add-on to Red Hat Enterprise Linux that allows a shared storage or clustered file system to access the same storage device over a network. The Resilient Storage Add-On creates a pool of data that is available to each server in a group by creating consistent storage across a cluster of servers that is protected if any one server fails.

Use it: yes

Incorrect forms:

See also:

yes return (verb)

Description: When referring to the keyboard key on Solaris or Mac, use "Return" or "return", respectively. See "enter" for other platforms.

Use it: yes

Incorrect forms:

See also: enter

with caution RHEL (noun)

Description: "RHEL" is an acronym for "Red Hat Enterprise Linux". The conventions for using this acronym vary for different products and teams. If you are not sure whether to use the acronym or only the full version, ask your team members.

Use it: with caution

Incorrect forms:

yes roll out (verb)

Description: In marketing, to "roll out" a product means to introduce it in stages to the public. In computing, to roll out software means to install a new product across a network.

Use it: yes

Incorrect forms: rollout

See also: rollout

yes rollout (noun)

Description: In marketing, "rollout" describes a series of related product announcements. When a company installs new equipment or software, this process is also called a "rollout".

Use it: yes

Incorrect forms: roll out

See also: roll-out

yes ROM (noun)

Description: "ROM" is an acronym for "read-only memory", that is, computer memory on which data has been prerecorded. After data has been written onto a ROM chip, it cannot be removed and can only be read.

Use it: yes

Incorrect forms: Rom, rom

See also: PROM

yes roundtable (noun)

Description: Use "roundtable" when referring to a type of event or gathering.

Use it: yes

Incorrect forms: round table

See also: round table

yes round table (noun)

Description: Use "round table" when referring to a circular table.

Use it: yes

Incorrect forms: roundtable

See also: roundtable

yes routine (noun)

Description: A "routine" is a set of programming instructions designed to perform a specific limited task.

Use it: yes

Incorrect forms:

See also:

yes RPM (noun)

Description: "RPM" is the recursive initialism for the "RPM Package Manager". RPM manages files in the RPM format, known as RPM packages. RPM packages are known informally as rpm files, but this informal usage is not used in Red Hat documentation to avoid confusion with the command name. Files in RPM format are referred to as RPM packages.

Use it: yes

Incorrect forms: rpm

See also:

yes runlevel (noun)

Description: A "runlevel" is a preset operating state on a UNIX system and similar operating systems. A system can be booted in to (that is, started up in to) any of several runlevels, each of which is represented by a single-digit integer. Each runlevel designates a different system configuration and allows access to a different combination of processes (that is, instances of executing programs). There are differences in the runlevels according to the operating system. Seven runlevels are supported in the standard Linux kernel.

Use it: yes

Incorrect forms: run level, run-level

See also:

S

yes SaaS (noun)

Description: "SaaS" is an acronym for Software-as-a-Service. In the spelled-out version and its variants (for example, Infrastructure-as-a-Service and Platform-as-a-Service), hyphens are always used. Note for Marketing, Brand, or Customer Portal usage: For all-uppercase text (such as banners), use "<VARIANT>-AS-A-SERVICE" for the spelled-out version. The same acronym is used across all groups.

Use it: yes

Incorrect forms:

See also: IaaS, PaaS

yes Samba (noun)

Description: "Samba" is a freeware program that allows end users to access and use files, printers, and other commonly shared resources on a company’s intranet or on the internet. Samba can be installed on a variety of operating system platforms, including Linux, most common UNIX platforms, OpenVMS, and OS/2.

Use it: yes

Incorrect forms: samba, SAMBA

See also:

yes screen saver (noun)

Description: A "screen saver" is an image or animation that replaces a computer’s display after a set amount of time without user activity.

Use it: yes

Incorrect forms: screensaver

See also:

yes scrollbar (noun)

Description: A "scrollbar" is a long, thin rectangle on the edge of the screen that allows a user to view information that does not fit on a single screen display.

Use it: yes

Incorrect forms: scroll bar, scroll-bar

See also:

yes see (verb)

Description: Use "see" to refer readers to another resource, for example, "See the Red Hat Enterprise Linux Installation Guide for more information." Avoid using "refer to" in this context.

Use it: yes

Incorrect forms: refer to

See also:

yes segmentation fault (noun)

Description: A "segmentation fault" occurs when a process tries to access a memory location that it is not allowed to access, or tries to access a memory location in a way that is not allowed (for example, if the process tries to write to a read-only location or to overwrite part of the operating system). Only use the abbreviation "segfault" if absolutely necessary, and never use it as a verb.

Use it: yes

Incorrect forms: segfault as a verb

See also: A Guide for Troubleshooting a Segfault on the Customer Portal for more information.

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".

Use it: yes

Incorrect forms: SE-Linux, S-E Linux, SE Linux, selinux

See also:

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.

Use it: yes

Incorrect forms: computer farm, computer ranch

See also: server farm

yes server farm (noun)

Description: A "server farm" 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 farms 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 farm fails, another server can serve as a backup.

Use it: yes

Incorrect forms: computer farm, computer ranch

See also: server cluster

yes SHA-1 (noun)

Description: "SHA" is an acronym for Secure Hash Algorithm and is a cryptographic hash function. SHA-1 is an earlier hashing algorithm that is being replaced by SHA-2.

Use it: yes

Incorrect forms:

See also: SHA-2

yes SHA-2 (noun)

Description: "SHA" is an acronym for Secure Hash Algorithm and is a cryptographic hash function. The encryption hash used in SHA-2 is significantly stronger and not subject to the same vulnerabilities as SHA-1. SHA-2 variants are often specified using their digest size, in bits, as the trailing number, instead of 2. SHA-224, SHA-256, SHA-384, and SHA-512 are all correct when referring to these specific hash functions.

Use it: yes

Incorrect forms:

See also: SHA-1

yes Shadowman (noun)

Description: "Shadowman" is a Red Hat corporate logo and is a trademark of Red Hat, Inc., registered in the United States and other countries.

Use it: yes

Incorrect forms: Shadow Man, ShadowMan

yes shadow passwords (noun)

Description: "Shadow passwords" are a method of improving system security by moving the encrypted passwords (normally found in /etc/passwd) to /etc/shadow, which is readable only by root. This option is available during installation and is part of the shadow utilities package. Shadow passwords is not a proper noun and is only capitalized at the beginning of a sentence.

Use it: yes

Incorrect forms: Shadow passwords (capitalized)

See also:

yes shadow utilities (noun)

Description: "Shadow utilities" are the specific system programs that operate on the shadow password files. Shadow utilities is not a proper noun and is only capitalized at the beginning of a sentence.

Use it: yes

Incorrect forms: Shadow utilities (capitalized)

See also:

yes share name (noun)

Description: "Share name" is the name of a shared resource. Use it as two words unless you are quoting the output of commands, such as "smbclient -L".

Use it: yes

Incorrect forms: sharename, Sharename

See also:

no she (pronoun)

Description: Reword the sentence to avoid using "he" or "she".

Use it: no

Incorrect forms:

See also: he

yes shell (noun)

Description: A "shell" is a software application (for example, /bin/bash or /bin/sh) that provides an interface to a computer. Do not use this term to describe the prompt where you type commands.

Use it: yes

Incorrect forms:

See also: shell prompt

yes shell prompt (noun)

Description: The "shell prompt" is the character at the beginning of the command line, for example "$" or "#". It indicates that the shell is ready to accept commands. Do not use "command prompt", "terminal", or "shell".

Use it: yes

Incorrect forms: command prompt, terminal, shell

See also: shell

yes signal 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 "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. The signal topology is also called "logical topology".

Use it: yes

Incorrect forms:

no skill set (noun)

Description: Use "skills" or "knowledge" instead of "skill set" (n) or "skill-set" (adj). For example, "Do you have the right skill set to be an RHCE?" is incorrect. Use "Do you have the right skills to be an RHCE?" instead.

Use it: no

Incorrect forms: skill set, skillset, skill-set, skill-set knowledge

See also:

yes SmartNIC

Description: A type of network interface controller (NIC) that uses its own integrated processor to handle certain low-level networking tasks.

Use it: yes

Incorrect forms: smart NIC, Smart-NIC

See also: NIC, vNIC

no snippet (noun)

Description: A "snippet" is a small piece or brief extract. Use "piece" instead of snippet. Use "excerpt" to refer to samples taken from a more-extensive section of text.

Use it: no

Incorrect forms:

See also:

yes SOCKS (noun)

Description: "SOCKS" is an abbreviation for Socket Secure, which is an internet protocol that exchanges network packets between a client and server through a proxy server. When specifying a SOCKS version, use "SOCKSv4" or "SOCKSv5".

Use it: yes

Incorrect forms: socks

See also:

no softcopy (noun)

Description: "Softcopy" is an electronic copy of some type of data, for example, a file viewed on a computer screen. Use "online" instead of softcopy, for example, "To view the online documentation…​​".

Use it: no

Incorrect forms:

See also:

yes Software Collection (noun)

Description: A "Software Collection" (SCL) allows for building and concurrent installation of multiple versions of the same software component on a single system. Always capitalize as shown. The abbreviation "SCL" (plural form "SCLs") is acceptable only for use in technical documents or documents shared with upstream projects.

Use it: yes

Incorrect forms: software collection, collection, Software collection, Collection

See also:

yes sound card (noun)

Description: A "sound card" is a device slotted into a computer to allow the use of audio components for multimedia applications.

Use it: yes

Incorrect forms: soundcard, sound-card

See also:

yes Source-NavigatorTM (noun)

Description: "Source-NavigatorTM" is a source code analysis tool and is a Red Hat trademark.

Use it: yes

Incorrect forms: Source Navigator (without trademark symbol)

See also:

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.

Use it: yes

Incorrect forms:

See also: spacebar

yes spacebar (noun)

Description: Use "spacebar" when referring to the keyboard key, for example, "Press the spacebar and type the correct number." Use "space" to refer to white space.

Use it: yes

Incorrect forms:

See also: space

yes spec file (noun)

Description: "Spec files" are used as part of rebuilding RPMs. The spec file outlines how to configure and compile the RPM as well as how to install the files later.

Use it: yes

Incorrect forms: specfile

See also:

yes specific (noun)

Description: When used as a modifier, put a hyphen before "specific", for example, "Linux-specific" or "chip-specific".

Use it: yes

Incorrect forms: Linux specific, chip specific, and so on

See also:

yes spelled (verb)

Description: "Spelled" is the past tense of "to spell" in U.S. English. Do not use the Commonwealth English variant "spelt".

Use it: yes

Incorrect forms: spelt

See also:

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".

Use it: yes

Incorrect forms:

See also: MySQL

yes S-record (noun)

Description: "Motorola S-record" is a file format that stores binary information in ASCII hex text form.

Use it: yes

Incorrect forms: s-record, S-Record, s-Record, SREC, or any other variation

See also:

yes SR-IOV (noun)

Description: "SR-IOV" is an abbreviation for Single-Root I/O Virtualization. It is a virtualization specification that allows a PCIe device to appear to be multiple separate physical PCIe devices.

Use it: yes

Incorrect forms: SR/IOV

See also:

yes SSH (noun)

Description: "SSH" is an abbreviation for Secure Shell, which is a network protocol that allows data exchange using a secure channel. For the protocol, do not use "SSH", "ssh", "Ssh", or other variants. For the command, use "ssh". Do not use ssh as a verb; for example, write "Use SSH to connect to the remote server" instead of "ssh to the remote server".

Use it: yes

Incorrect forms: SSH as a verb

See also:

no SSL (noun)

Description: "SSL" is an abbreviation for Secure Sockets Layer, which is a protocol developed by Netscape for transmitting private documents over the internet. SSL uses a public key to encrypt data that is transferred over the SSL connection. The majority of web browsers support SSL. Many websites use the protocol to obtain confidential user information, such as credit card numbers. By convention, URLs that require an SSL connection start with https: instead of http:.

Use it: no

Incorrect forms:

See also: SSL/TLS

yes SSL/TLS (noun)

Description: SSL/TLS refers to the Secure Socket Layer protocol (SSL) and its successor, the Transport Layer Security protocol (TLS). Both of these protocols are frequently called "SSL", so use SSL/TLS in high-level documentation entries, such as headings, to establish context with encryption protocols. In other documentation areas, use TLS and document the supported version of the TLS protocol for your product.

Use it: yes

Incorrect forms: TLS/SSL

See also:

yes standalone (adjective)

Description: Use "standalone" instead of "stand-alone" when referring to components that are complete and that operate independently of other components, such as "a standalone distribution" or "a standalone module". However, use two words for a noun phrase, such as "a module must stand alone".

Use it: yes

Incorrect forms: stand-alone

See also:

yes StarOffice (noun)

Description: "StarOffice" is a Linux desktop suite.

Use it: yes

Incorrect forms: Star, Staroffice, Star Office

See also:

yes startx (noun)

Description: "startx" begins the xsession, which provides a graphical interface for running the session.

Use it: yes

Incorrect forms: StartX

See also:

yes straightforward (adjective)

Description: "Straightforward" means uncomplicated and easy to understand.

Use it: yes

Incorrect forms: straight forward, straight-forward

See also:

yes su (noun)

Description: "su" (superuser, switch user, or substitute user) is a Linux command to change the local user to the root user.

Use it: yes

Incorrect forms: SU

See also:

yes subcommand (noun)

Description: A "subcommand" is a secondary or even tertiary command used with a primary command. Do not confuse subcommands with options or arguments; subcommands operate on more focused objects or entities. In the following command, "hammer" is the primary command, "import" and "organization" are subcommands, and "--help" is an option: hammer import organization --help.

Use it: yes

Incorrect forms: sub-command

See also:

yes subdirectory (noun)

Description: A "subdirectory" is a directory located within another directory, similar to a folder beneath another folder in a graphical user interface (GUI).

Use it: yes

Incorrect forms: sub-directory

See also:

Description: A "submenu" is a secondary menu contained within another menu.

Use it: yes

Incorrect forms: sub-menu

See also:

yes subpackage (noun)

Description: "Subpackage" has a specific, specialized meaning in Red Hat products. An RPM spec file can define more than one package; these additional packages are called "subpackages". CCS strongly discourages any other use of subpackage. Subpackages are not the same as dependencies. Do not treat them as if they are.

Use it: yes

Incorrect forms: sub-package

See also:

yes subscription (noun)

Description: Subscriptions provide access to Red Hat products. Using Red Hat Subscription Management (RHSM), you register a system, attach a subscription, and enable repositories. Do not confuse this with Red Hat Network (RHN), where you subscribed to channels. Do not use "subscription" and "entitlement" interchangeably. See https://access.redhat.com/discussions/3119981 for details.

Use it: yes

Incorrect forms: entitlement

See also: entitlement, repository

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.

Use it: with caution

Incorrect forms: SUDO, Sudo

See also:

yes superuser (noun)

Description: Superuser is the same as the root user. The term is more common in Solaris documentation than Linux.

Use it: yes

Incorrect forms: super-user, super user

See also:

yes swap space (noun)

Description: A Linux system uses "swap space" when it needs more memory resources and the RAM is full. The system moves inactive pages to the swap space to free memory.

Use it: yes

Incorrect forms: swapspace

See also:

yes Sybase Adaptive Server Enterprise (noun)

Description: Sybase Corporation developed Sybase Adaptive Server Enterprise as a relational database management system that became part of SAP AG. Use SAP Sybase Adaptive Server Enterprise (ASE) on the first use; on subsequent mentions, use "Sybase ASE". If discussing the high-availability version, use "Sybase ASE and High Availability".

Use it: yes

Incorrect forms:

See also:

yes symmetric encryption (noun)

Description: "Symmetric encryption" is a type of encryption where the same key encrypts and decrypts the message. In contrast, asymmetric (or public-key) encryption uses one key to encrypt a message and another to decrypt the message.

Use it: yes

Incorrect forms:

See also:

yes systemd (noun)

Description: Systemd is a "system and service manager" that is used as the default system daemon for Red Hat Enterprise Linux 7+

Use it: yes

Incorrect forms: system D, system D, SystemD, system d, Systemd (unless at the start of a sentence).

See also:

yes SysV (noun)

Description: The "SysV" init runlevel system provides a standard process for controlling which programs init launches or halts when initializing a runlevel.

Use it: yes

Incorrect forms: Sys V, System V

See also:

T

yes terminal emulation (noun)

Description: "Terminal emulation" refers to making a computer respond like a particular type of terminal. Terminal emulation programs allow you to access a mainframe computer or bulletin board service with a personal computer.

Use it: yes

Incorrect forms:

See also:

yes text-based (adjective)

Description: Use "text-based" as an adjective when referring to a text-based operating system or interface.

Use it: yes

Incorrect forms: text based

See also:

yes text mode (noun)

Description: "Text mode" is a video mode in which a display screen is divided into rows and columns of boxes. Each box can contain one character. Text mode is also called character mode.

Use it: yes

Incorrect forms: textmode, text-mode

See also:

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.

Use it: yes

Incorrect forms: thinly provisioned, thinly-provisioned

See also:

yes through (preposition)

Description: Use "through" instead of a hyphen or any other type of dash when expressing a range.

Use it: yes

Incorrect forms: thru

See also:

yes throughput (noun)

Description: "Throughput" is the amount of data transferred from one place to another or processed in a specified amount of time. Data transfer rates for disk drives and networks are measured in terms of throughput. Typically, throughput is measured in kbps, Mbps, or Gbps. See the IBM Style Guide for more information about using measurements and abbreviations.

Use it: yes

Incorrect forms: thru

See also:

yes tier-1 (adjective)

Description: Always hyphenate "tier-1" and indicate the number in numeral form. Follow standard capitalization guidelines.

Use it: yes

Incorrect forms: tier-one, tier 1

See also:

yes time frame (noun)

Description: "Time frame" is a period of time with respect to some action or project. It is most commonly styled as two words.

Use it: yes

Incorrect forms: timeframe, time-frame

See also:

yes time to live (noun)

Description: Do not capitalize "time to live" unless you are documenting a GUI field, label, or similar element, in which case you should use the same capitalization. Capitalization at the beginning of a sentence is acceptable.

Use it: yes

Incorrect forms:

See also: TTL, time-to-live

yes time-to-live (adjective)

Description: Do not capitalize "time-to-live" unless you are documenting a GUI field, label, or similar element, in which case you should use the same capitalization. Capitalization at the beginning of a sentence is acceptable.

Use it: yes

Incorrect forms:

See also: TTL, time to live

yes TLS (noun)

Description: TLS is an initialism for Transport Layer Security (TLS), and it is the successor to the Secure Sockets Layer (SSL) protocol.

TLS is a cryptographic protocol that uses the Public Key Infrastructure (PKI) method to encrypt network traffic between two systems. PKI uses asymmetric encryption during a TLS handshake process to authenticate the connection between two systems.

Use "TLS" when referring to protocols that exchange cryptographic keys and secure network connections between two systems. Check for the latest version of the TLS protocol and, if necessary, contact a subject matter expert (SME) to verify the TLS version to note in product documentation.

Use "SSL/TLS" in high-level documentation entries, such as headings, to establish context with encryption protocols.

Use it: yes

Incorrect forms:

yes TLS handshake (noun)

Description: The process of a client checking the validity of a certificate on a web server for authentication purposes.

The following example demonstrates a TLS handshake process:

A client requests a certificate from a web server. On receiving the certificate, the client checks that it trusts the certificate authority (CA) that issued the certificate. If the client trusts the CA, it generates a premaster secret and encrypts it by using the web server’s public key. The client sends the encrypted value to the web server. The web server decrypts the value by using its private key. Both client and web server calculate a shared session key by using the premaster secret and other values. Both client and web server then use the session key to encrypt any sent messages during the TLS session.

Use it: yes

Incorrect forms: SSL handshake

no totally (adverb)

Description: Do not use "totally".

Use it: no

Incorrect forms:

See also: basically

yes trusted certificate authority (noun)

Description: A trusted certificate authority (CA) is a third-party entity that creates TLS certificates, known as CA certificates, for authentication purposes. A trusted CA is different from a self-signed certificate in that a self-signed certificate has its own private key and does not need to request a key from a public or private CA.

A web server uses its public key to obtain a certificate from a trusted CA. The web server stores this certificate in a keystore. During the TLS handshake process, a client checks the validity of the certificate for authentication purposes.

Use it: yes

Incorrect forms: self-signed certificate

See also: TLS

yes TTL (noun)

Description: "TTL" is an abbreviation for "time to live" (noun) and "time-to-live" (adjective). The abbreviation is always in uppercase letters.

Use it: yes

Incorrect forms: ttl

U

yes UID (noun)

Description: "UID" is an abbreviation of user identifier. UID is a unique identifier associated with a single entity within a given system.

Use it: yes

Incorrect forms: uid

See also:

yes UltraSPARC (noun)

Description: "UltraSPARC" is a trademark of SPARC International, Inc. and is used under license by Sun Microsystems, Inc. Products bearing the SPARC trademarks are based upon an architecture developed by Sun Microsystems, Inc.

Use it: yes

Incorrect forms: ULTRASPARC, UltraSparc, or other variations.

See also:

yes uninterruptible (adjective)

Description: Although "uninterruptible" is not listed in the American Heritage Dictionary, it is listed in the Merriam-Webster Unabridged Dictionary and is considered acceptable in Red Hat documentation, especially in the context of "uninterruptible power supply (UPS)".

Use it: yes

Incorrect forms:

See also:

yes UNIX (noun)

Description: UNIX is a registered trademark of The Open Group. Do not use "UNIX-like" or "UNIX-based"; use an expression such as "Linux, UNIX, and similar operating systems" or "UNIX system-based" instead.

Use it: yes

Incorrect forms: Unix, unix, UNIX-like, UNIX-based

See also:

no unset (verb)

Description: Use "clear" instead of "unset", for example, "To disable the Wobbly Widget, clear the Enable Wobbly Widget check box." Another example is, "This rule only matches TCP packets that have the SYN flag set and the ACK flag cleared."

Use it: no

Incorrect forms:

See also:

yes untrusted (adjective)

Description: Use "untrusted" only in the context of security relationships, for example, web browsers often indicate that a site is untrusted if it cannot verify that site’s security certificate.

Use it: yes

Incorrect forms:

See also:

yes upgrade (verb)

Description: "Upgrade" means to raise (something) to a higher standard, in particular to improve by adding or replacing components, for example, "Upgrade the RHEL version."

Use it: yes

Incorrect forms: up-grade, up grade

See also:

yes UPS (noun)

Description: "UPS" is an abbreviation of uninterruptible power supply, which is a power supply that includes a battery to maintain power in the event of a power outage.

Use it: yes

Incorrect forms:

See also:

yes upsell (verb)

Description: As per http://www.ahdictionary.com/word/search.html?q=upsell, "upsell" is the practice of offering customers additional or more expensive products or services after they have already agreed to buy something. No adjectival form is currently recognized.

Use it: yes

Incorrect forms: up-sell

See also:

yes upselling (noun)

Description: As per http://www.ahdictionary.com/word/search.html?q=upsell, "upselling" is the practice of offering customers additional or more expensive products or services after they have already agreed to buy something. No adjectival form is currently recognized.

Use it: yes

Incorrect forms: up-selling, up selling

See also:

yes upstream (noun)

Description: "Upstream" is data sent from a customer to a network service provider. Use the one-word form for the nominal form.

Use it: yes

Incorrect forms: up-stream, up stream

yes upstream (adjective)

Description: "Upstream" is data sent from a customer to a network service provider. Use the one-word form for the adjectival form.

Use it: yes

Incorrect forms: up-stream, up stream

yes uptime (noun)

Description: "Uptime" is the time during which a computer or server is in operation. Use the one-word form.

Use it: yes

Incorrect forms: up-time, up time

See also:

yes URL (noun)

Description: "URL" is an abbreviation for Uniform Resource Locator. A URL provides a way to locate a resource on the web, the hypertext system that operates over the internet. The URL contains the name of the protocol to be used to access the resource and a resource name. Include the appropriate protocol, such as http, ftp, or https, at the beginning of URLs, that is, use http://www.redhat.com and not www.redhat.com.

Use it: yes

Incorrect forms: url

See also:

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."

Use it: with caution

Incorrect forms:

See also:

yes user name (noun)

Description: Use as shown, two words, except for instances in which the GUI uses the single word form (username).

Use it: yes, with exception for GUI.

Incorrect forms:

See also:

yes user space (noun)

Description: Use "user space" when used as a noun.

Use it: yes

Incorrect forms: userspace

See also: user-space

yes user-space (adjective)

Description: When used as a modifier, use the hyphenated form "user-space".

Use it: yes

Incorrect forms: userspace

See also: user space

V

yes VAR (noun)

Description: "VAR" is an acronym for value-added reseller, which is the equivalent of original equipment manufacturer (OEM).

Use it: yes

Incorrect forms: var

See also: OEM

yes vCPU (noun)

Description: "vCPU" is an abbreviation for a virtual central processing unit, which represents a portion of a physical CPU that is assigned to a virtual machine.

Use lowercase "v" and uppercase "CPU".

Use it: yes

Incorrect forms: VCPU, vcpu

See also:

yes VDSM (noun)

Description: "VDSM" is an abbreviation for Virtual Desktop Server Management. Do not spell out this abbreviation. Using the term "virtual desktop" in this context has negative marketing implications.

Use it: yes

Incorrect forms: Virtual Desktop Server Management

See also:

yes verify (verb)

Description: "Verify" means to check that something is correct.

Use it: yes

Incorrect forms: make sure

See also:

yes vi (noun)

Description: "vi" is a screen-oriented text editor originally created for the UNIX operating system. Do not use "VI".

Use it: yes

Incorrect forms: VI

See also: Vim

yes video mode (noun)

Description: "Video mode" is the setting of a video adapter. Most video adapters can run in either text mode or graphics mode. In text mode, a monitor can display only ASCII characters. In graphics mode, a monitor can display any bit-mapped image. In addition to the text and graphics modes, video adapters offer different modes of resolution and color depth.

Use it: yes

Incorrect forms: video-mode, videomode

See also:

yes Vim (noun)

Description: "Vim" is an acronym for Vi IMproved. In the original 1991 release for the Amiga platform, the acronym was derived from Vi IMitation. It became Vi IMproved in 1992, when ported to the UNIX system and similar operating systems. Despite being an acronym, and despite the first word of the "About" text that is displayed when you launch the editor, the standard, proper noun-derived, mixed-case spelling has been in use since its release on the Amiga.

Use it: yes

Incorrect forms: VIM, vim

See also: vi

yes virtual (adjective)

Description: "Virtual" is an adjective describing computer systems with hardware functions partially carried out in the software layer. It is preferred over virtualized, as it is simple, direct, and unambiguous.

Use it: yes

Incorrect forms:

See also: virtualized

yes virtual console (noun)

Description: "Virtual console" can be abbreviated to "VC" as long as the term has been introduced in the same content in its full version first, such as "A virtual console (VC) is a shell prompt in a non-graphical environment. Multiple VCs can be accessed simultaneously".

Use it: yes

Incorrect forms: virtual-console, Virtual Console

See also:

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.

Although the IBM Style Guide recommends using "diskette" instead of "floppy disk", this term is outdated and refers to the physical disk. In the context of virtualization, "floppy disk" is the preferred term; the file extension, for example, is ".vfd".

Use it: yes

Incorrect forms: virtual diskette

yes virtual floppy drive (noun)

Description: A "virtual floppy drive" is the virtual hardware used to mount a floppy disk image.

Although the IBM Style Guide recommends using "diskette drive" instead of "floppy drive", this term is outdated and refers to the physical hardware. In the context of virtualization, "floppy drive" is the preferred term.

Use it: yes

Incorrect forms: virtual diskette drive

yes virtual machine (noun)

Description: "Virtual machine" refers to virtual hardware that consists of virtual CPUs, memory, devices, and so on. Do not use "guest virtual machine" unless you want to specifically emphasize the fact that it is a guest. Virtual machine can be abbreviated to "VM" as long as the term has been introduced in the same content in its full version first and provided there is no possibility of confusion with other terms, such as "virtual memory". Author discretion is recommended.

Use it: yes

Incorrect forms:

See also:

yes virtual router (noun)

Description: A "virtual router" is an abstract object managed by the virtual router redundancy protocol (VRRP) that acts as a default router for hosts on a shared LAN. It consists of a Virtual Router Identifier and a set of associated IP addresses across a common LAN.

Use it: yes

Incorrect forms:

See also:

yes virtualized (adjective)

Description: "Virtualized" is an adjective and a past-tense verb. It implies having undergone or been produced by a process. The distinction implies the possibility of a real (not virtual) counterpart.

Use it: yes

Incorrect forms:

See also: virtual

with caution virtualized guest (noun)

Description: A "virtualized guest" is a virtual machine (VM). Use virtualized guest only when comparing a "fully virtualized guest" with a "paravirtualized guest".

Use it: with caution

Incorrect forms:

yes VLAN (noun)

Description: "VLAN" is an abbreviation for virtual local area network. Use uppercase for all letters.

Use it: yes

Incorrect forms: vlan, vLAN

See also:

yes vNIC (noun)

Description: "vNIC" is an abbreviation for virtual network interface controller. Use lowercase v and uppercase NIC for the abbreviation, but all lowercase for the expansion, except at the beginning of a sentence.

Use it: yes

Incorrect forms: vnic, VNIC, Virtual Network Interface Card

See also:

yes vNUMA node (noun)

Description: A virtual non-uniform memory access (vNUMA) node optimizes performance for a virtual machine (VM) by pinning vNUMA nodes on the VM to specific NUMA nodes on the host. You can optionally use virtual NUMA node instead of vNUMA node.

Use it: yes

Incorrect forms: vnuma, VNUMA

See also:

yes volatile storage (noun)

Description: Volatile storage is temporary storage, for example, random access memory (RAM) that requires power to maintain the stored information. The stored data is lost when the device is turned off or restarts.

Use it: yes

Incorrect forms:

See also: persistent storage

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.

Use it: yes

Incorrect forms: vpn

See also:

W

yes WAN (noun)

Description: "WAN" is an acronym for wide-area network, which is a computer network that spans a relatively large geographical area. Typically, a WAN consists of two or more local-area networks (LANs). Computers connected to a wide-area network are often connected through public networks, such as the telephone system. Connections can be through leased lines or satellites. The largest WAN in existence is the internet.

Use it: yes

Incorrect forms: wan

See also:

yes want (verb)

Description: Use "want" instead of "wish" or "would like". It is better to avoid it entirely by rewriting the sentence.

Use it: yes

Incorrect forms: wish, would like

See also:

yes WCA (noun)

Description: "WCA" is an abbreviation for web clipping application, which is an application that allows users to extract static information from a web server and load that data onto a web-enabled PDA. WCAs are also called query applications.

Use it: yes

Incorrect forms: wca

See also:

no we suggest (verb)

Description: Do not use "we suggest". Use a more direct construction or use "recommend". For example, instead of "We suggest that you make a backup of your data disk", write "Back up your data disk", or "It is recommended that you back up your data disk".

Use it: no

Incorrect forms:

See also: recommend

yes web UI (noun)

Description: Use "web UI" to refer to a browser-based interface to a software application, even if that application has no connection to the web. If necessary, spell out web UI on first use. Do not hyphenate the abbreviation or use the one-word form.

Use it: yes

Incorrect forms: web-UI, webUI

See also:

yes who (pronoun)

Description: Use the pronoun "who" as a subject, for example, "Who owns this?"

Use it: yes

Incorrect forms:

See also: whom

yes whom (pronoun)

Description: Use the pronoun "whom" as a direct object, an indirect object, or the object of a preposition, for example, "To whom does this belong?"

Use it: yes

Incorrect forms:

See also: who

with caution will (verb)

Description: Do not use future tense unless it is absolutely necessary.

Use it: with caution

Incorrect forms:

See also:

yes Window Maker (noun)

Description: "Window Maker" is a window manager for the X Window System. Do not combine Window Maker into one word or hyphenate the two words.

Use it: yes

Incorrect forms: Window-Maker, WindowMaker

See also:

yes write (verb)

Description: Use "write" instead of "code" as a verb.

Use it: yes

Incorrect forms: code

See also:

X

with caution X (noun)

Description: "X" is an alternative reference to the "X Window System". Do not use X by itself when referring to "XEmacs".

Use it: with caution

Incorrect forms: X (when referring to XEmacs only)

See also: XEmacs

yes XEmacs (noun)

Description: Use "xemacs" only when referring to a command, such as, "To start XEmacs, type xemacs."

Use it: yes

Incorrect forms: Xemacs

See also:

with caution Xen (adjective)

Description: "Xen Project" is a hypervisor using a microkernel design, providing services that allow multiple computer operating systems to execute on the same computer hardware concurrently. It was developed by the Linux Foundation and is supported by Intel. Use Xen Project when it accurately refers to the original Xen version of the package. If the Xen package we distribute is for all practical purposes the same as the upstream code, we can refer to the package we distribute as "Xen" in a referential way. A referential use is one that describes another entity’s goods or services, not our own, such as referring to Microsoft Windows as a technology we compete and integrate with. When referring to another entity’s trademark, always use good trademark practices. Only use the trademark as an adjective followed by the noun; do not use a logo form of the trademark; do not make it more prominent than our own marks; and do not incorporate the trademark into our own product names. The proper use is "Xen hypervisor". The Xen Trademark Policy is available at http://www.xenproject.org/trademark-policy.html.

Use it: with caution

Incorrect forms:

See also:

yes xterm (noun)

Description: "Xterm" is the standard terminal emulator for the X Window System. Do not use Xterm unless the word is used at the beginning of a sentence.

Use it: yes

Incorrect forms: Xterm

See also:

Y

yes YAML (noun)

Description: "YAML" is the recursive acronym for YAML Ain’t Markup Language, after originally being said to mean Yet Another Markup Language. YAML is a human-readable data serialization standard for all programming languages.

Use it: yes

Incorrect forms: yaml

See also:

yes you (noun)

Description: Do not use the first-person pronoun "I" or the third-person pronouns "he" or "she".

Use it: yes

Incorrect forms: I, he, she

See also:

Z

no zSeries (noun)

Description: "IBM Z" is the correct usage. Do not use "S/390x", "s390x", "IBM zSeries", or "zSeries".

Use it: no

Incorrect forms: S/390x, s390x, IBM zSeries, zSeries

See also: IBM Z, IBM S/390

with caution z-stream (noun)

Description: "z-stream" refers to the z in an x.y.z product version numbering schema. Use only if required for generic reference to a release and the term is in use already by the product. In all other instances refer to the specific release number.

Use it: with caution

Incorrect forms:

See also: micro release

Symbols

with caution ampersand (&)

Description: Ampersands ("&") can be used in design elements and graphics when space is limited and when either referring to or quoting third-party content that uses them. Do not use an ampersand in original body copy.

Use it: with caution

Incorrect forms:

See also:

no exclamation point (!)

Description: Do not use exclamation points ("!") at the end of sentences. An exclamation point can be used when referring to a command, such as the bang (!) command.

Use it: no

Incorrect forms:

See also:

with caution plus symbol (+)

Description: Plus symbols ("+") can be used in design elements and graphics when space is limited and when either referring to or quoting third-party content that uses them. Do not use a plus symbol in original body copy.

Use it: with caution

Incorrect forms:

See also:

Product-specific conventions

The following sections contain conventions specific to particular Red Hat products. Product documentation teams are responsible for these sections. Product-specific terms must be defined by the individual writing team responsible for that product, and usage should be consistent within that product documentation. Terms that might be used by more than one product team should be proposed as additions to the General Conventions chapter.

Each product portfolio and product has an official name and an approved abbreviated name. Some products have multiple component names that also have an approved or accepted usage. It is important to use these names consistently when referring to products in the documentation. For information on official product naming, including long- and short-form names, contact brand@redhat.com.

Product teams are not expected to maintain third-party (non-Red Hat) product names and terms in this document, and these names and terms must always be confirmed by checking that third party’s own sources (for example, the third party’s website or documentation) or by discussion with a third-party representative.

Azure and .NET Core

yes Azure CLI 2.0 (noun)

Description: "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.

Use it: yes

Incorrect forms:

yes Azure Resource Manager (noun)

Description: The "Azure Resource Manager" (ARM) is a Microsoft Azure management mode that deploys, manages, and monitors resources in the Microsoft Azure portal. ARM mode is the default for Azure CLI 2.0. Microsoft Azure resources can be managed remotely from a Red Hat Enterprise Linux server. ARM replaces Azure Service Management (ASM) as the preferred mode for managing resources in Microsoft Azure.

Use it: yes

Incorrect forms:

yes Azure Service Management (noun)

Description: "Azure Service Management" (ASM) is a Microsoft Azure management mode that deploys, manages, and monitors resources in the Microsoft Azure portal. The Azure Resource Manager (ARM) has replaced ASM as the preferred method for managing Azure resources.

Use it: yes

Incorrect forms:

yes Hyper-V (noun)

Description: "Hyper-V" is a native hypervisor. Hyper-V can create virtual machines (VMs) on AMD64 systems running the Microsoft Windows operating system. Hyper-V drivers are required on all Red Hat Enterprise Linux (RHEL) VMs running in Microsoft Azure.

Use it: yes

Incorrect forms:

See also: hypervisor

yes Microsoft Azure (noun)

Description: "Microsoft Azure" is a cloud computing platform and infrastructure for building, deploying, and managing applications and services through a global network of Microsoft-managed datacenters. (source: wikipedia). Always refer to it as Microsoft Azure to provide clarity unless the term is repeated multiple times in a sentence or paragraph.

Use it: yes

Incorrect forms: Azure

See also:

yes Microsoft Azure Cross-Platform Command-Line Interface (noun)

Description: The "Microsoft Azure Cross-Platform Command-Line Interface" (Xplat-CLI) is a set of open source, cross-platform commands for managing Microsoft Azure platform resources. The Xplat-CLI has several top-level commands that correspond to Microsoft Azure features. Typing azure at the Xplat-CLI command prompt lists each of the many Microsoft Azure subcommands. When using the Xplat-CLI, a user can enable ARM mode or ASM mode.

Azure CLI 2.0 is the most current command-line interface and is replacing Xplat-CLI. Do not use all uppercase letters for Xplat, and do not use any other variant of Xplat-CLI.

Use it: yes

Incorrect forms: xplat-cli, x-plat-cli, xplat cli, x-plat cli, X-PLAT CLI, X-PLAT-CLI, XPLAT-CLI, XPLAT CLI

See also: Azure CLI 2.0

yes Microsoft Azure On-Demand Marketplace (noun)

Description: The "Microsoft Azure On-Demand Marketplace" is a Microsoft Azure storefront where users can locate and quickly install operating systems, programming languages, frameworks, tools, databases, and devices into their Microsoft Azure environment. Red Hat Enterprise Linux is available as a VM image within the Microsoft Azure On-Demand Marketplace, along with other Red Hat open source products. Always preface On-Demand Marketplace with Microsoft Azure to provide clarity unless the term is repeated multiple times in a sentence or paragraph.

Use it: yes

Incorrect forms: On-Demand Marketplace

See also:

yes Microsoft Azure portal (noun)

Description: The "Microsoft Azure portal" is a unified console graphical user interface (GUI) that allows users to build, manage, and monitor resources, web apps, and cloud applications. Do not capitalize portal; this is how Microsoft presents the portal’s name.

Use it: yes

Incorrect forms: Microsoft Azure Portal

yes .NET Core (noun)

Description: Microsoft’s newest development platform, ".NET Core", is an open source and cross-platform framework for building cloud-based internet-connected applications, such as web apps, IoT apps, and mobile backends. All .NET Core applications can run on .NET Core or on the full .NET Framework. Always refer to it as .NET Core; all other variants are incorrect.

Use it: yes

Incorrect forms: dotNet Core, .Net Core, .NET, .Net

See also:

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.

Use it: yes

Incorrect forms:

See also:

yes Red Hat Cloud Access (noun)

Description: "Red Hat Cloud Access" is a Red Hat partner program that allows customers to use their Red Hat subscriptions to build resources and import images on qualified Red Hat Certified Cloud and Service Providers (CCSPs).

Use it: yes

Incorrect forms:

See also:

yes virtual hard drive (noun)

Description: A "virtual hard drive" (VHD) is file format that represents a virtual hard disk drive (HDD). It contains elements typically found on a physical HDD, such as disk partitions and a file system, which in turn can contain files and folders. VHD files have the extension .vhd. VHD is the required image format for all virtual machine images used in Microsoft Azure. Do not use virtual hard disk as a synonym.

Use it: yes

Incorrect forms: virtual hard disk

See also:

Note

See the Microsoft Azure glossary for additional terms and definitions.

Red Hat AMQ

yes acceptor (noun)

Description: An acceptor defines the way a client can connect to a broker instance.

Use it: yes

Incorrect forms:

See also:

yes AMQ (noun)

Description: The short product name for Red Hat AMQ.

Use it: yes

Incorrect forms: A-MQ, JBoss AMQ, Red Hat A-MQ, Red Hat AMQ

See also: Red Hat AMQ

yes AMQ Broker (noun)

Description: A component of Red Hat AMQ, it is a full-featured, message-oriented middleware broker. It offers specialized queueing behaviors, message persistence, and manageability.

Use it: yes

Incorrect forms: A-MQ Broker, The AMQ Broker, Red Hat Broker, JBoss Broker

yes AMQ Clients (noun)

Description: A suite of messaging libraries supporting multiple languages and platforms. It enables users to write messaging applications that send and receive messages. AMQ Clients is a component of Red Hat AMQ.

Use it: yes

Incorrect forms: A-MQ Clients, Red Hat Clients, JBoss Clients

yes AMQ Console (noun)

Description: A management tool for administering AMQ brokers and routers in a single graphical interface.

Use it: yes

Incorrect forms: A-MQ Console, Red Hat Console, JBoss Console

See also:

yes AMQ Core Protocol JMS (noun)

Description: The "AMQ Core Protocol JMS" is an implementation of the Java Message Service (JMS) using the ActiveMQ Artemis Core protocol. This is sometimes called Core JMS.

Use it: yes

Incorrect forms:

See also: JMS, Core protocol

yes AMQ Interconnect (noun)

Description: A component of Red Hat AMQ, it is a messaging router that provides flexible routing of messages between any AMQP-enabled endpoints, whether they are clients, servers, brokers, or any other entity that can send or receive standard AMQP messages.

Use it: yes

Incorrect forms: Interconnect, Router, A-MQ Interconnect, Red Hat Interconnect, JBoss Interconnect

See also: router

yes AMQP (noun)

Description: Advanced Message Queuing Protocol. It is an open standard for passing business messages between applications or organizations (https://www.amqp.org/about/what). AMQ Broker supports AMQP, and AMQ Interconnect uses AMQP to route messages and links.

Use it: yes

Incorrect forms:

See also:

with caution Artemis (noun)

Description: The upstream project for AMQ Broker (Apache ActiveMQ Artemis). When referring to AMQ Broker, always use the Red Hat product name.

Use it: with caution

Incorrect forms:

See also: AMQ Broker

Description: An AMQ Interconnect configurable entity that defines a link between the router and a queue, topic, or service in an external broker.

Use it: yes

Incorrect forms: auto-link, AutoLink

See also:

yes broker distribution (noun)

Description: The platform-independent AMQ Broker archive containing the product binaries and libraries.

Use it: yes

Incorrect forms:

yes broker instance (noun)

Description: A configurable instance of AMQ Broker. Each broker instance is a separate directory containing its own runtime and configuration data. Use this term to refer to the instance, not the product.

Use it: yes

Incorrect forms:

yes broker cluster (noun)

Description: A group of brokers to be grouped together in order to share message processing load. In JBoss A-MQ 6, this was called a network of brokers.

Use it: yes

Incorrect forms:

See also:

yes brokered messaging (noun)

Description: Any messaging configuration that uses a message broker to deliver messages to destinations. Brokered messaging can include brokers only, or a combination of brokers and routers.

Use it: yes

Incorrect forms:

See also:

yes client application (noun)

Description: An application or server that connects to broker instances, routers, or both to send or receive messages. This should not be confused with AMQ Clients, which is the messaging library used to create the client application.

Use it: yes

Incorrect forms:

yes connection (noun)

Description: 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.

Use it: yes

Incorrect forms:

yes connection factory (noun)

Description: An object used by a JMS client to create a connection to a broker.

Use it: yes

Incorrect forms:

See also:

yes connector (noun)

Description: 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.

Use it: yes

Incorrect forms:

See also: connection

yes consumer (noun)

Description: A client that receives messages.

Use it: yes

Incorrect forms:

See also: client application

yes container (noun)

Description: A top-level application, such as a broker or client. Connections are established between containers.

Use it: yes

Incorrect forms:

See also: connection

yes Core API (noun)

Description: The "Core API" is an API for the ActiveMQ Artemis Core protocol. It is not supported by AMQ Broker.

Use it: yes

Incorrect forms:

yes Core protocol (noun)

Description: The "Core protocol" is the native messaging protocol for ActiveMQ Artemis.

Use it: yes

Incorrect forms:

yes delivery (noun)

Description: The process by which a message is sent to a receiver. Delivery includes the message content and metadata, and the protocol exchange required to transfer that content. When the delivery is completed, it is settled.

Use it: yes

Incorrect forms:

See also: message settlement

with caution destination (noun)

Description: In JMS, this is a named location for messages, such as a queue or a topic. Clients use destinations to specify the queue or topic from which to send or receive messages. Only use this term in the context of JMS. In all other instances, use address.

Use it: with caution

Incorrect forms:

See also: message address

yes direct routed messaging (noun)

Description: A messaging configuration that uses routers only to deliver messages to destinations. This can also be called routed messaging.

Use it: yes

Incorrect forms:

See also:

with caution Dispatch Router (noun)

Description: The upstream component for AMQ Interconnect (Apache Qpid Dispatch Router). When referring to AMQ Interconnect, always use the Red Hat product name.

Use it: with caution

Incorrect forms:

See also: AMQ Interconnect

yes JMS (noun)

Description: The Java Message Service API for sending messages between clients.

Use it: yes

Incorrect forms:

See also:

Description: A message path between endpoints. Links are established over connections, and are responsible for tracking the exchange status of the messages that flow through them.

Use it: yes

Incorrect forms:

See also:

Description: A routing mechanism in AMQ Interconnect. A link route is a set of links that represent a private message path between a sender and receiver. Link routes can traverse multiple brokers and routers. With link routing, a router makes a routing decision when it receives link-attach frames, and it enables the sender and receiver to use the full AMQP link protocol.

Use it: yes

Incorrect forms:

See also: message routing

yes listener (noun)

Description: A configurable entity for AMQ routers and messaging APIs. A listener defines a context for accepting multiple, incoming connections on a particular TCP address and port.

Use it: yes

Incorrect forms:

See also: connection

yes live-only (noun)

Description: Live-broker is a broker high availability policy for scaling down brokers. If a live-only broker is shut down, its messages and transaction state are copied to another live broker.

Use it: yes

Incorrect forms: live only

See also:

yes master-slave group (noun)

Description: A broker high availability configuration in which a master broker is linked to slave brokers. If a failover event occurs, the slave broker(s) take over the master broker’s workload.

Use it: yes

Incorrect forms: live-backup group

See also:

yes master broker (noun)

Description: The broker that serves client requests in a master-slave group.

Use it: yes

Incorrect forms: live broker

yes message (noun)

Description: A mutable holder of application content.

Use it: yes

Incorrect forms:

See also:

with caution message address (noun)

Description: The name of a source or destination endpoint for messages within the messaging network. Message addresses can designate entities such as queues and topics. The term address is also acceptable, but should not be confused with TCP/IP addresses. In JMS, the term destination may be used.

Use it: with caution

Incorrect forms:

See also: destination

yes message routing (noun)

Description: A routing mechansim in AMQ Interconnect. A message route is the message distribution pattern to be used for a message address. With message routing, a router makes a routing decision on a per-message basis when a message arrives.

Use it: yes

Incorrect forms:

See also: link routing

yes message settlement (noun)

Description: The process for confirming that a message delivery has been completed, and propagating that confirmation to the appropriate endpoints. The term settlement is also acceptable.

Use it: yes

Incorrect forms:

See also: delivery

yes messaging API (noun)

Description: The client libraries and APIs used to create client applications. These libraries are provided by AMQ Clients.

Use it: yes

Incorrect forms:

yes MQTT (noun)

Description: MQ Telemetry Transport protocol. It is a lightweight, client-to-server, publish/subscribe messaging protocol (http://mqtt.org/). AMQ Broker supports MQTT.

Use it: yes

Incorrect forms:

See also:

yes OpenWire (noun)

Description: A cross-language wire protocol that enables JMS clients to communicate with AMQ Broker (http://activemq.apache.org/openwire.html).

Use it: yes

Incorrect forms:

See also:

yes peer-to-peer messaging (noun)

Description: A messaging operation in which a client sends messages directly to another client without using a broker or router. This term should only be used to refer to client-to-client communication, not direct routed messaging.

Use it: yes

Incorrect forms:

yes producer (noun)

Description: A client that sends messages.

Use it: yes

Incorrect forms:

See also: client application

yes qdmanage (noun)

Description: A generic AMQP management client used for managing AMQ Interconnect.

Use it: yes

Incorrect forms: Qdmanage, QDMANAGE

See also:

yes qdstat (noun)

Description: A management client used for monitoring the status of an AMQ Interconnect router network.

Use it: yes

Incorrect forms: Qdstat, QDSTAT

See also:

yes queue (noun)

Description: A stored sequence of messages. In AMQ, queues are hosted on brokers.

Use it: yes

Incorrect forms:

See also:

yes receiver (noun)

Description: A channel for receiving messages from a source.

Use it: yes

Incorrect forms:

See also: consumer, source, sender

yes Red Hat AMQ (noun)

Description: A lightweight messaging platform that delivers information and easily integrates applications. It consists of several components (message broker, interconnect router, and clients) that support a variety of configurations. Always use the full product name (Red Hat AMQ) or short product name (AMQ).

Use it: yes

Incorrect forms: A-MQ, AMQ, Red Hat A-MQ, Red Hat JBoss AMQ

See also: AMQ

yes router (noun)

Description: A configurable instance of AMQ Interconnect. Routers are application layer programs that route AMQP messages between message producers and consumers. Routers are typically deployed in networks of multiple routers with redundant paths. When using this term, be careful not to confuse it with network device routers.

Use it: yes

Incorrect forms:

See also: AMQ Interconnect

yes routing mechanism (noun)

Description: The type of routing to be used for an address. Routing mechanisms include message routing and link routing.

Use it: yes

Incorrect forms:

See also:

yes routing pattern (noun)

Description: The path messages sent to a particular address can take across the network. Messages can be distributed in balanced, closest, and multicast routing patterns.

Use it: yes

Incorrect forms:

See also:

yes sender (noun)

Description: A channel for sending messages to a target.

Use it: yes

Incorrect forms:

See also: producer, target, receiver

with caution session (noun)

Description: 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

Incorrect forms:

See also: connection

yes sharded queue (noun)

Description: A distributed queue in which a single logical queue is hosted on multiple brokers. Routers are typically used with sharded queues to enable clients to access the entire sharded queue instead of only a single shard of the queue.

Use it: yes

Incorrect forms:

See also: queue

yes slave broker (noun)

Description: In a master-slave group, this is the broker (or brokers) that takes over for the master broker to which it is linked.

Use it: yes

Incorrect forms: passive broker

yes source (noun)

Description: A message’s named point of origin.

Use it: yes

Incorrect forms:

See also: target

yes SSL/TLS (noun)

Description: The Secure Socket Layer protocol (SSL) and its successor, the Transport Layer Security protocol (TLS). As both of these protocols are frequently called "SSL", always use "SSl/TLS" to avoid confusion.

Use it: yes

Incorrect forms: SSL, TLS, TLS/SSL

See also:

yes STOMP (noun)

Description: Simple (or Streaming) Text Oriented Message Protocol. It is a text-oriented wire protocol that enables STOMP clients to communicate with STOMP brokers. AMQ Broker can accept connections from STOMP clients.

Use it: yes

Incorrect forms:

See also:

yes target (noun)

Description: A message’s destination. This is usually a queue or topic.

Use it: yes

Incorrect forms:

See also: source

yes topic (noun)

Description: A stored sequence of messages for read-only distribution.

Use it: yes

Incorrect forms:

See also:

Red Hat Ceph Storage

For documentation questions, contact ceph-docs@redhat.com.

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.

Use it: yes

Incorrect forms:

See also: container

yes bucket index (noun)

Description: A bucket index in the S3 API contains an index of objects within the bucket. The bucket index enables listing the bucket’s contents.

Use it: yes

Incorrect forms:

See also:

yes bucket sharding (noun)

Description: Bucket sharding is a process of breaking down a bucket index into smaller more manageable shards. Bucket sharding improves performance.

Use it: yes

Incorrect forms:

See also: shard

yes BlueStore (noun)

Description: BlueStore is an OSD back end that uses block devices directly.

Use it: yes

Incorrect forms: bluestore, Blue Store

See also: FileStore, Object Store

yes Ceph (noun)

Description: Ceph is a unified, distributed storage system designed for excellent performance, reliability and scalability.

Use it: yes

Incorrect forms: CEPH, ceph

yes ceph (noun)

Description: The Ceph command-line utility. Always mark it correctly (ceph).

Use it: yes

Incorrect forms: CEPH

yes Ceph Block Device (noun)

Description: The block storage component of Ceph. Also known as the RADOS Block Device, however the term Ceph Block Device is preferred.

Use it: yes

Incorrect forms: Ceph block device, Ceph block devices

yes CephFS (noun)

Description: CephFS is an initialization for the Ceph File System.

Use it: yes

Incorrect forms: cephfs

See also: Ceph File System

yes Ceph File System (noun)

Description: The POSIX file system component of Ceph.

Use it: yes

Incorrect forms: Ceph filesystem, Ceph file system

See also: Ceph File System

yes Ceph Monitor (noun)

Description: A node where the ceph-mon daemon is running.

Use it: yes

Incorrect forms: Ceph monitor

See also: ceph-mon

yes ceph-ansible (noun)

Description: ceph-ansible is a utility that provides Ansible playbooks for installing, managing, and upgrading the Ceph Storage Cluster. Always mark it correctly (ceph-ansible).

Use it: yes

Incorrect forms: Ceph Ansible

See also:

yes ceph-mds (noun)

Description: ceph-mds is the Metadata Server daemon. One or more instances of ceph-mds collectively manage the file system namespace, coordinating access to the shared OSD cluster. Always mark it correctly (ceph-mds)

Use it: yes

Incorrect forms:

See also: Metadata Server, MDS

yes ceph-mon (noun)

Description: ceph-mon is the Ceph Monitor daemon. Always mark it correctly (ceph-mon).

Use it: yes

Incorrect forms:

See also: Ceph Monitor

yes ceph-osd (noun)

Description: ceph-osd is the Ceph object storage daemon that is responsible for storing objects on local file system and providing access to them over network. Always mark it correctly (ceph-osd).

Use it: yes

Incorrect forms:

yes Ceph Object Gateway (noun)

Description: The S3/Swift component of Ceph. Also known as RADOS gateway. However, prefer using the Ceph Object Gateway.

Use it: yes

Incorrect forms: Ceph object gateway, Ceph object gateways

yes ceph-radosgw (noun)

Description: The ceph-radosgw daemon runs on Ceph Object Gateway nodes. Each instance provides a Civetweb web server and the object gateway functionality.

Use it: yes

Incorrect forms:

yes container (noun)

See container in the General conventions section.

yes CRUSH (noun)

Description: Abbreviation for Controlled Replication Under Scalable Hashing. This is the mechanism of data distribution in a Ceph cluster. Use all capital letters when referring to CRUSH. Do not expand, only when explaining what the abbreviation means. See the CRUSH section in the Red Hat Ceph Storage Architecture Guide for details.

Use it: yes

Incorrect forms:

See also: CRUSH map

yes CRUSH map (noun)

Description: A CRUSH map contain a list of OSDs, a list of buckets for aggregating the devices into physical locations, and a list of rules that tell CRUSH how it should replicate data in a Ceph cluster’s pools. See the CRUSH section in the Red Hat Ceph Storage Architecture Guide for details.

Use it: yes

Incorrect forms: crush map, crushmap

See also: CRUSH

yes FileStore (noun)

Description: FileStore is an OSD back end responsible for the OSD data that writes objects as files on a file system.

Use it: yes

Incorrect forms: filestore, File Store

See also: BlueStore

yes federated (adjective)

Description: In Red Hat Ceph Storage 1.3, you can configure the Ceph Object Gateway to participate in a federated architecture with multiple regions and with multiple zones for a region.

Use it: yes

Incorrect forms:

See also: multisite

yes indexless bucket (noun)

Description: A bucket that does not maintain an index.

Use it: yes

Incorrect forms:

See also: bucket index

yes librados (noun)

Description: A shared library allowing applications to access the RADOS object store.

Use it: yes

Incorrect forms: Librados, LIBRADOS

See also: RADOS

yes librbd (noun)

Description: A shared library allowing applications to access Ceph Block Devices.

Use it: yes

Incorrect forms: Librbd, LIBRBD

yes MDS (noun)

Description: MDS is an abbreviation for the Ceph Metadata Server.

Use it: yes

Class: noun

Incorrect forms:

yes Metadata Server (noun)

Description: Another name of the ceph-mds daemon.

Use it: yes

Incorrect forms:

See also: MDS, ceph-mds

yes multisite (adjective)

Description: You can configure the Ceph Object Gateway to participate in a multisite architecture that consists of one zone group and multiple zones each zone with one or more ceph-radosgw instances. See the Multisite chapter in the Red Hat Ceph Storage 2 Object Gateway Guide for details.

Use it: yes

Incorrect forms: multi site, multi-site

See also: federated

yes Object Store (noun)

Description: A core component of the Ceph Storage Cluster. Also referred as RADOS.

Use it: yes

Incorrect forms:

See also: RADOS

yes Object Storage Device (noun)

Description: 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.

Use it: yes

Incorrect forms:

See also: ceph-osd, OSD, OSD daemon

yes OSD Daemon (noun)

Description: Another name of the ceph-osd daemon.

Use it: yes

Incorrect forms:

yes OSD (noun)

Description: The ceph-osd daemon and the underlying data disk.

Use it: yes

See also:

yes PG (noun)

Description: An abbreviation for Placement Group.

Use it: yes

Incorrect forms:

See also: placement group

yes placement group (noun)

Description: Aggregates a series of objects into a group, and maps the group into a series of OSDs. Write "Placement Group" (both first letters in uppercase) only when explaining the PC abbreviation, then write "placement group" (in lowercase). See the Placement Groups section in the Red Hat Ceph Storage Architecture Guide for details.

Use it: yes

Incorrect forms:

See also: PC

yes placement target (noun)

Description: A configurable rule that determines where bucket data is stored.

Use it: yes

Incorrect forms:

See also:

yes pool (noun)

Description: A logical unit in which Ceph stores data. You can create pools for particular types of data, such as for Ceph Block Devices, Ceph Object Gateways, or to separate one group of users from another. See the Pools chapter in the Red Hat Ceph Storage Architecture Guide for details.

Use it: yes

Incorrect forms:

See also:

yes RADOS (noun)

Description: Acronym for Reliable Autonomic Distributed Object Storage. A core component of the Ceph Storage Cluster. Do not expand, unless explaining what the acronym means. Also referred as Object Store.

Use it: yes

Class: noun

Incorrect forms: rados

See also: Object Store

with caution RADOS Block Device (noun)

Description: The block storage component of Ceph. Also known as the Ceph Block Device, which is the preferred form. Use RADOS Block Device only when expanding the RBD abbreviation.

Use it: with caution

Incorrect forms: RADOS block device

with caution RADOS Gateway (noun)

Description: The S3/Swift component of Ceph. Also known as the Ceph Object Gateway, which is the preferred form. Use RADOS Gateway only when expanding the RGW abbreviation.

Use it: with caution

Incorrect forms: RadosGW, RADOS gateway

yes RBD (noun)

Description: abbreviation for RADOS Block Device.

Use it: yes

Incorrect forms: rbd

yes rbd (noun)

Description: A command to create, list, introspect, and remove Ceph Block Device images. Always mark it correctly (rbd).

Use it: yes

Incorrect forms:

yes realm (noun)

Description: A realm is a namespace context for storing a multisite configuration. The notion of a realm enables Ceph to provide multiple namespaces in the same cluster.

Use it: yes

Incorrect forms:

See also: zone group

yes region (noun)

Description: A region is the deprecated term for referring to a zone group. Red Hat Ceph Storage 1.3 uses regions.

Use it: yes

Incorrect forms:

See also: zone group

yes Red Hat Ceph Storage (noun)

Description: Red Hat Ceph Storage is a Red Hat offering of the Ceph storage system.

Use it: yes

Incorrect forms:

See also: Ceph

yes RGW (noun)

Description: abbreviation for RADOS Gateway.

Use it: yes

Incorrect forms:

yes scrubbing (noun)

Description: Scrubbing is a process when Ceph OSD Daemons compare object metadata in one placement group with its replicas in placement groups stored on other OSD node. See the Scrubbing section in the Red Hat Ceph Architecture Guide for details.

Use it: yes

Incorrect forms:

See also:

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.

Use it: yes

Incorrect forms:

See also: bucket sharding

yes snap (noun)

Description: A snap is the snapshot identifier of an object. The only writable version of the object is called head. If an object is a clone, this field includes its sequential identifier. Always mark it correctly (snap).

Use it: yes

Incorrect forms:

See also: snapshot set

yes snapshot set (noun)

Description: The snapshot set stores information about a snapshot as a list of key-values pairs. The pairs are called attributes of a snapshot set.

Use it: yes

Incorrect forms: snapset, snapsets

See also: snap

yes zone (noun)

Description: A zone represents a physical location consisting of a Ceph Storage Cluster and nodes running the Ceph Object Gateway daemons.

Use it: yes

Incorrect forms:

See also: zone group

yes zone group (noun)

Description: A zone group is a list of zones. A zone group always has one master zone, and can have multiple secondary zones. A realm has one master zone group, which manages users and metadata for the realm.

Use it: yes

Incorrect forms: zonegroup, zone-group

See also: zone, realm, region

Red Hat CloudForms

For documentation questions, contact cloudforms-docs@redhat.com.

yes Appliance console (noun)

Description: The appliance console is a command-line based interface built into the Red Hat CloudForms appliance used for setup and configuration.

Use it: yes

Incorrect forms: Appliance Console

See also:

yes Red Hat CloudForms (noun)

Description: Red Hat CloudForms enables enterprises to meet insight, control and automation needs in building and managing virtual infrastructure. Use "Red Hat CloudForms" in the first instance and "CloudForms" in all subsequent instances.

Use it: yes

Incorrect forms: CloudForms Management Engine, CFME

See also:

yes Red Hat CloudForms Appliance (noun)

Description: A virtual machine where the virtual management database (VMDB) and Red Hat CloudForms reside. Use "Red Hat CloudForms" in the first instance and "the appliance" in subsequent instances.

Use it: yes

Incorrect forms: CloudForms Management Engine, CFME

See also:

yes Red Hat CloudForms server (noun)

Description: The application that runs on the Red Hat CloudForms appliance and communicates with the SmartProxy and the VMDB.

Use it: yes

Incorrect forms:

See also:

yes SmartState analysis (noun)

Description: Process run by the SmartProxy which collects the details of a virtual machine or instance. Such details include accounts, drivers, network information, hardware, and security patches. This process is also run by the Red Hat CloudForms server on hosts and clusters. The data is stored in the VMDB.

Use it: yes

Incorrect forms: Smart State, smart state, Smart state, Smartstate, Analysis.

See also:

yes Virtual Management Database (VMDB) (noun)

Description: Database used by the Red Hat CloudForms appliance to store information about your resources, users, and anything else required to manage your virtual enterprise. Use Virtual Management Database (VMDB) in the first instance and VMDB in subsequent instances.

Use it: yes

Incorrect forms:

See also:

yes Worker Appliance (noun)

Description: A Red Hat CloudForms appliance dedicated to a role other than User Interface or database.

Use it: yes

Incorrect forms:

See also:

Red Hat Directory Server

For documentation questions, contact rhel-docs@redhat.com.

yes access control instruction (noun)

Description: In an LDAP directory, an access control instruction (ACI) grants or denies access to entries or attributes. Use "access control instruction" on the first usage and then the abbreviation "ACI" subsequently.

Use it: yes

Incorrect forms:

See also:

yes attribute (noun)

Description: Each entry in an LDAP directory contains attributes. Object classes in an entry control which attributes in an entry are optional and which are required.

Use it: yes

Incorrect forms:

See also:

yes base DN (noun)

Description: In an LDAP directory, the base distinguished name (DN) defines the starting point for operations, such as searches.

Use it: yes

Incorrect forms:

See also: distinguished name

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.

Use it: yes

Incorrect forms:

See also: distinguished name

yes consumer (noun)

Description: In an LDAP replication environment, consumers receive data from suppliers or hubs.

Use it: yes

Incorrect forms: slave

See also: hub, supplier

yes Directory Manager (noun)

Description: The privileged administrative user in Red Hat Directory Server is called the Directory Manager. The distinguished name (DN) of this user is cn=Directory Manager.

Use it: yes

Incorrect forms: DM, directory manager

See also:

yes Directory Server (noun)

Description: The short product name of Red Hat Directory Server. In the title of guides, use the full product name "Red Hat Directory Server" and, elsewhere, the short name "Directory Server". Because it is the product name, both words start with a capital letter. Additionally, this practice distinguishes the Red Hat Directory Server product from other directory servers.

Use it: yes

Incorrect forms: directory server

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.

Use it: yes

Incorrect forms:

See also:

yes hub (noun)

Description: In an LDAP replication environment, hubs receive data from a supplier and replicate the data to consumers.

Use it: yes

Incorrect forms:

See also: consumer

yes LDAP (noun)

Description: The Lightweight Directory Access Protocol (LDAP) defines an industry standard for accessing and maintaining directory servers, such as Red Hat Directory Server. By default, the LDAP protocol is unencrypted. Do not expand the abbreviation on the first usage.

Use it: yes

Incorrect forms: Lightweight Directory Access Protocol

See also: LDAPS, STARTTLS

yes LDAPS (noun)

Description: The Lightweight Directory Access Protocol over Secure Socket Layer (LDAPS) uses the TLS protocol to encrypt LDAP traffic. Do not expand the abbreviation on the first usage.

Use it: yes

Incorrect forms: Lightweight Directory Access Protocol over Secure Socket Layer

See also: LDAP, STARTTLS

no master (noun)

Description: Do not use "master" to refer to a supplier.

Use it: no

Incorrect forms:

See also: supplier

yes object class (noun)

Description: Object classes in an entry control which attributes are optional and which are required. Write as two words when you refer to object classes in general.

Use it: yes

Incorrect forms: objectClass

See also: objectClass

yes objectClass (noun)

Description: The objectClass attribute in an LDAP entry stores the object classes of this entry.

Use it: yes

Incorrect forms: object class, objectclass

See also: object class

yes Red Hat Directory Server (noun)

Description: Red Hat Directory Server (RHDS) is an LDAPv3-compliant directory server and the name of the product. Use the full product name in titles of guides. Outside of titles, refer to the product as "Directory Server". Use the product name without an article. Do not use the acronym "RHDS" in documentation.

Use it: yes

Incorrect forms: RHDS

See also: Directory Server

yes replica (noun)

Description: A replica is a copy of the Directory Server database on a different host. For example, a consumer can also be called a replica because it has a copy of the data received from the supplier.

Use it: yes

Incorrect forms:

See also:

no slave (noun)

Description: Do not use "slave" to refer to a consumer or hub.

Use it: no

Incorrect forms:

See also: consumer, hub

no SSL (noun)

Description: The Secure Socket Layer (SSL) protocol is the insecure predecessor of TLS. Due to the weakness of the protocol, support of SSL has been removed in RHEL 8 and Directory Server 11. When you refer to TLS encryption or certificates, use "TLS".

Use it: no

Incorrect forms: Secure Socket Layer, SSL

See also: TLS

yes STARTTLS (noun)

Description: When an LDAP client wants to use a TLS-encrypted connection after establishing a connection to the unencrypted LDAP port, the client sends the STARTTLS command.

Use it: yes

Incorrect forms: StartTLS, startTLS

See also: LDAP, LDAPS

yes suffix (noun)

Description: The name of the entry at the top of the directory tree is called a suffix. In Directory Server, an instance can store multiple suffixes, and each suffix has its own database.

Use it: yes

Incorrect forms:

See also:

yes supplier (noun)

Description: In an LDAP replication environment, suppliers send data to other servers.

Use it: yes

Incorrect forms: master

See also: consumer

yes TLS (noun)

Description: Transport Layer Security (TLS) is a cryptographic protocol for secure communication over networks. TLS is the successor of the insecure Secure Sockets Layer (SSL) protocol. RHEL 8 and 9, as well as Directory Server 11 and 12, only support TLS version 1.2 and later. Do not expand the abbreviation on the first usage.

Use it: yes

Incorrect forms: SSL, SSL/TLS, TLS/SSL

See also: SSL

Red Hat Data Grid

For documentation questions, contact jdg-docs@redhat.com.

yes Cache Manager (noun)

Description: Cache Manager is an interface that you can use to create caches and manage cache lifecycles. Always spell as two words with capital letters when you refer to the abstract notion of a Cache Manager. When you refer to specific interfaces, such as CacheManager, EmbeddedCacheManager, or RemoteCacheManager, use the appropriate markup language.

Use it: yes

Incorrect forms:

See also:

yes cross-site replication (noun)

Description: A configuration that allows Data Grid clusters to form a global view and back up data across geographically disperse locations. Multiple clusters running in different data centers replicate data between each other to ensure business continuity in the event of an outage and to present a single, unified caching service to applications.

Use it: yes

Incorrect forms: xsite

See also:

yes Data Grid (noun)

Description: The short product name for Red Hat Data Grid. Use "Red Hat Data Grid" in the first instance and "Data Grid" in all subsequent instances.

Use it: yes

Incorrect forms: JBoss Data Grid

See also: Red Hat Data Grid

yes Data Grid Console (noun)

Description: Data Grid Console provides a web interface for creating and managing caches.

Use it: yes

Incorrect forms: JBoss Data Grid Administration Console, Data Grid console

See also:

yes Data Grid Server (noun)

Description: Data Grid Server is a standalone server that exposes any number of caches to clients over a variety of protocols, including Hot Rod, Memcached and REST. Always capitalize when referring to a Data Grid Server instance.

Use it: yes

Incorrect forms:

See also:

yes Hot Rod (adjective)

Description: Hot Rod is a binary TCP client-server protocol used in Red Hat Data Grid. Java, C#, C++, Node.js clients, as well as clients written in other programming languages, can access data that resides in remote caches on Data Grid Server clusters via the Hot Rod endpoint. Write as two words and capitalize the first letter of each word.

Use it: yes

Incorrect forms: hot rod, HotRod, hotrod

See also:

yes Infinispan (noun)

Description: Infinispan is the open-source, community project on which Red Hat Data Grid is built.

Use it: yes

Incorrect forms:

See also:

yes Red Hat Data Grid (noun)

Description: Red Hat Data Grid is a high-performance, distributed in-memory data store. Use "Red Hat Data Grid" in the first instance and "Data Grid" in all subsequent instances. This product name applies to Red Hat Data Grid 7.3 and later versions.

Use it: yes

Incorrect forms: Red Hat JBoss Data Grid, JDG

See also: Data Grid

no Red Hat JBoss Data Grid (noun)

Description: This product name applies to Red Hat Data Grid 7.3 and earlier versions.

Use it: no

Incorrect forms:

See also: Red Hat Data Grid

yes session externalization (noun)

Description: Data Grid clusters can provide external cache containers that store application-specific data. These external caches store HTTP sessions and other data to make applications stateless and achieve elastic scalability as well as high availability.

Use it: yes

Incorrect forms:

See also:

Red Hat Enterprise Linux

For documentation questions, contact rhel-docs@redhat.com.

yes Active Directory forest (noun)

Description: An Active Directory (AD) forest is a set of one or more domain trees which share a common global catalog, directory schema, logical structure, and directory configuration. The forest represents the security boundary within which users, computers, groups, and other objects are accessible.

Use it: yes

Incorrect forms:

See also:

yes Active Directory global catalog (noun)

Description: The global catalog is a feature of Active Directory (AD) that allows a domain controller to provide information on any object in the forest, regardless of whether the object is a member of the domain controller’s domain. Domain controllers with the global catalog feature enabled are referred to as global catalog servers. The global catalog provides a searchable catalog of all objects in every domain in a multi-domain Active Directory Domain Services (AD DS).

Use it: yes

Incorrect forms:

yes Active Directory security identifier (noun)

Description: A security identifier (SID) is a unique ID number assigned to an object in Active Directory, such as a user, group, or host. A SID is the functional equivalent of UIDs and GIDs in Linux.

Use it: yes

Incorrect forms:

See also:

yes Anaconda (noun)

Description: The operating system installer used in Fedora, Red Hat Enterprise Linux, and their derivatives. Anaconda is a set of Python modules and scripts with additional files like Gtk widgets (written in C), systemd units, and dracut libraries. Together, they form a tool that you can use to set parameters for your target operating system.

Use it: yes

Incorrect forms:

See also:

yes Ansible play (noun)

Description: Ansible plays are the building blocks of Ansible playbooks. The goal of an Ansible play is to map a group of hosts to some well-defined roles, represented by Ansible tasks.

Use it: yes

Incorrect forms:

See also: Ansible playbook

yes Ansible playbook (noun)

Description: Playbooks are Ansible’s configuration, deployment, and orchestration language. They can describe a policy you want your remote systems to enforce, or a set of steps in a general IT process. An Ansible playbook is a file that contains one or more Ansible plays.

Use it: yes

Incorrect forms:

See also: Ansible play

yes Ansible task (noun)

Description: An Ansible play can contain multiple tasks. Ansible tasks are units of action in Ansible. The goal of each task is to execute a module, with very specific arguments. An Ansible task is a set of instructions to achieve a state defined, in its broad terms, by a specific Ansible role or module, and fine-tuned by the variables of that role or module.

Use it: yes

Incorrect forms:

See also:

yes Apache web server (noun)

Description: The Apache HTTP Server, colloquially called Apache, is a free and open-source cross-platform web server application, released under the terms of Apache License 2.0. Apache played a key role in the initial growth of the World Wide Web (WWW), and is currently the leading HTTP server. Its process name is httpd, which is short for HTTP daemon. Red Hat Identity Management (IdM) uses the Apache Web Server to display the IdM Web UI, and to coordinate communication between components, such as the Directory Server and the Certificate Authority (CA).

Use it: yes

Incorrect forms:

yes blueprint (noun)

Description: 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.

Use it: yes

Incorrect forms: blue print, BluePrint

See also:

yes certificate (noun)

Description: A certificate is an electronic document used to identify an individual, a server, a company, or other entity and to associate that identity with a public key. A certificate provides generally recognized proof of a person’s identity. Public-key cryptography uses certificates to address the problem of impersonation.

Use it: yes

Incorrect forms:

yes certificate authorities (noun)

Description: An entity that issues digital certificates. In Red Hat Identity Management, the primary CA is ipa, the IdM CA. The ipa CA certificate is one of the following types:

  • Self-signed. In this case, the ipa CA is the root CA.

  • Externally signed. In this case, the ipa CA is subordinated to the external CA.

In IdM, you can also create multiple sub-CAs. Sub-CAs are IdM CAs whose certificates are one of the following types:

  • Signed by the ipa CA.

  • Signed by any of the intermediate CAs between itself and ipa CA. The certificate of a sub-CA cannot be self-signed.

Use it: yes

Incorrect forms:

See also: certificate

yes clean install (noun)

Description: A clean install removes all traces of the previously installed operating system, system data, configurations, and applications and installs the latest version of the operating system.

Use it: yes

Incorrect forms:

yes commit (noun)

Description: A release or image version of the operating system. Image Builder generates an OSTree commit for RHEL for Edge images. You can use these images to install or update RHEL on Edge servers.

Use it: yes

Incorrect forms:

See also: OSTree

yes compose (noun)

Description: Composes are individual builds of a system image, based on a particular version of a particular blueprint. Compose as a term refers to the system image, the logs from its creation, inputs, metadata, and the process itself.

Use it: yes

Incorrect forms:

See also: blueprint

yes control node (noun)

Description: Any machine with Ansible installed. You can run commands and playbooks, invoking /usr/bin/ansible or /usr/bin/ansible-playbook, from any control node. You can use any computer that has Python installed on it as a control node - laptops, shared desktops, and servers can all run Ansible. However, you cannot use a Windows machine as a control node. You can have multiple control nodes.

Use it: yes

Incorrect forms:

See also: Ansible playbook

yes conversion (noun)

Description: An operating system conversion is when you convert your operating system from a different Linux distribution to Red Hat Enterprise Linux.

Use it: yes

Incorrect forms:

See also:

yes cross-forest trust (noun)

Description: A trust establishes an access relationship between two Kerberos realms, allowing users and services in one domain to access resources in another domain. With a cross-forest trust between an Active Directory (AD) forest root domain and an IdM domain, users from the AD forest domains can interact with Linux machines and services from the IdM domain. From the perspective of AD, Identity Management represents a separate AD forest with a single AD domain.

Use it: yes

Incorrect forms:

yes customization (noun)

Description: Customizations are specifications for the system that are not packages. This includes users, groups, and SSH keys.

Use it: yes

Incorrect forms:

See also:

yes Directory Server (noun)

Description: A Directory Server centralizes user identity and application information. It provides an operating system-independent, network-based registry for storing application settings, user profiles, group data, policies, and access control information. Each resource on the network is considered an object by the directory server. Information about a particular resource is stored as a collection of attributes associated with that resource or object. Red Hat Directory Server conforms to LDAP standards.

Use it: yes

Incorrect forms:

See also: LDAP

yes DNS PTR records (noun)

Description: DNS pointer (PTR) records resolve an IP address of a host to a domain or host name. PTR records are the opposite of DNS A and AAAA records, which resolve host names to IP addresses. DNS PTR records enable reverse DNS lookups. PTR records are stored on the DNS server.

Use it: yes

Incorrect forms:

See also:

yes DNS SRV records (noun)

Description: A DNS service (SRV) record defines the hostname, port number, transport protocol, priority and weight of a service available in a domain. You can use SRV records to locate IdM servers and replicas.

Use it: yes

Incorrect forms:

See also:

yes domain controller (noun)

Description: A domain controller (DC) is a host that responds to security authentication requests within a domain and controls access to resources in that domain. IdM servers work as DCs for the IdM domain. A DC authenticates users, stores user account information and enforces security policy for a domain. When a user logs into a domain, the DC authenticates and validates their credentials and either allows or denies access.

Use it: yes

Incorrect forms:

See also:

yes fully qualified domain name (noun)

Description: A fully qualified domain name (FQDN) is a domain name that specifies the exact location of a host within the hierarchy of the Domain Name System (DNS). A device with the hostname myhost in the parent domain example.com has the FQDN myhost.example.com. The FQDN uniquely distinguishes the device from any other hosts called myhost in other domains.

Use it: yes

Incorrect forms:

See also:

yes greenboot (noun)

Description: Generic Health Check Framework for systemd on rpm-ostree based systems.

Use it: yes

Incorrect forms: Greenboot, green boots

See also:

yes GSSAPI (noun)

Description: The Generic Security Service Application Program Interface (GSSAPI, or GSS-API) allows developers to abstract how their applications protect data that is sent to peer applications. Security-service vendors can provide GSSAPI implementations of common procedure calls as libraries with their security software. These libraries present a GSSAPI-compatible interface to application writers who can write their application to use only the vendor-independent GSSAPI. With this flexibility, developers do not have to tailor their security implementations to any particular platform, security mechanism, type of protection, or transport protocol.

Kerberos is the dominant GSSAPI mechanism implementation, which allows Red Hat Enterprise Linux and Microsoft Windows Active Directory Kerberos implementations to be API compatible.

Use it: yes

Incorrect forms:

See also:

yes hidden replica (noun)

Description: A hidden replica is an IdM replica that has all services running and available, but its server roles are disabled, and clients cannot discover the replica because it has no SRV records in DNS.

Hidden replicas are primarily designed for services such as backups, bulk importing and exporting, or actions that require shutting down IdM services. Since no clients use a hidden replica, administrators can temporarily shut down the services on this host without affecting any clients.

Use it: yes

Incorrect forms:

See also: DNS SRV records

yes host system (noun)

Description: The system on which the instrumentation modules, from SystemTap scripts, are compiled, to be loaded on target systems.

Use it: yes

Incorrect forms:

See also: target system

yes ID mapping (noun)

Description: SSSD can use the SID of an AD user to algorithmically generate POSIX IDs in a process called ID mapping. ID mapping creates a map between SIDs in AD and IDs on Linux.

  • When SSSD detects a new AD domain, it assigns a range of available IDs to the new domain. Therefore, each AD domain has the same ID range on every SSSD client machine.

  • When an AD user logs in to an SSSD client machine for the first time, SSSD creates an entry for the user in the SSSD cache, including a UID based on the user’s SID and the ID range for that domain.

  • Because the IDs for an AD user are generated in a consistent way from the same SID, the user has the same UID and GID when logging in to any Red Hat Enterprise Linux system.

Use it: yes

Incorrect forms:

See also: id ranges, SSSD

yes ID ranges (noun)

Description: An ID range is a range of ID numbers assigned to the IdM topology or a specific replica. You can use ID ranges to specify the valid range of UIDs and GIDs for new users, hosts and groups. ID ranges are used to avoid ID number conflicts. There are two distinct types of ID ranges in IdM:

  • IdM ID range

    Use this ID range to define the UIDs and GIDs for users and groups in the whole IdM topology. Installing the first IdM server creates the IdM ID range. You cannot modify the IdM ID range after creating it. However, you can create an additional IdM ID range, for example when the original one nears depletion.

  • Distributed Numeric Assignment (DNA) ID range

    Use this ID range to define the UIDs and GIDs a replica uses when creating new users. Adding a new user or host entry to an IdM replica for the first time assigns a DNA ID range to that replica. An administrator can modify the DNA ID range, but the new definition must fit within an existing IdM ID range.

Note that the IdM range and the DNA range match, but they are not interconnected. If you change one range, ensure you change the other to match.

Use it: yes

Incorrect forms:

See also: ID mapping

yes ID views (noun)

Description: ID views enable you to specify new values for POSIX user or group attributes, and to define on which client host or hosts the new values will apply. See examples of ID views usage:

  • Define different attribute values for different environments.

  • Replace a previously generated attribute value with a different value.

In an IdM-AD trust setup, the Default Trust View is an ID view applied to AD users and groups. Using the Default Trust View, you can define custom POSIX attributes for AD users and groups, thus overriding the values defined in AD.

Use it: yes

Incorrect forms:

See also: POSIX attributes

yes IdM CA server (noun)

Description: An IdM server on which the IdM certificate authority (CA) service is installed and running.

Alternative names: CA server

Use it: yes

Incorrect forms:

yes IdM deployment (noun)

Description: A term that refers to the entirety of your IdM installation. Your IdM deployment has many identifying components:

  • Purpose: whether it is a production environment, as opposed to a testing or development environment.

  • Certificate Authority (CA) configuration: you can use the IdM integrated CA as a self-signed root CA, or as an externally-signed CA. Alternatively, if your environment has an external CA, you do not need to use the IdM integrated CA.

  • DNS: IdM integrated DNS, or external DNS solution.

  • Active Directory (AD) integration: whether you have a purely Linux environment, or if you have configured a trust with a Microsoft AD environment.

Use it: yes

Incorrect forms:

See also:

yes IdM server and replicas (noun)

Description: To install the first server in an IdM deployment, you must use the ipa-server-install command.

Administrators can then use the ipa-replica-install command to install replicas in addition to the first server that was installed. By default, installing a replica creates a replication agreement with the IdM server from which it was created, enabling receiving and sending updates to the rest of IdM.

There is no functional difference between the first server that was installed and a replica. Both are fully functional read/write IdM servers.

Use it: yes

Incorrect forms: master server

See also:

yes IdM CA renewal server (noun)

Description: If your IdM topology contains an integrated certificate authority (CA), one server has the unique role of the CA renewal server. This server maintains and renews IdM system certificates. By default, the first CA server you install fulfills this role, but you can configure any CA server to be the CA renewal server. In a deployment without integrated CA, there is no CA renewal server.

Use it: yes

Incorrect forms: master CA

yes IdM CRL publisher server (noun)

Description: If your IdM topology contains an integrated certificate authority (CA), one server has the unique role of the Certificate revocation list (CRL) publisher server. This server is responsible for maintaining the CRL. By default, the server that fulfills the CA renewal server role also fulfills this role, but you can configure any CA server to be the CRL publisher server. In a deployment without integrated CA, there is no CRL publisher server.

Use it: yes

Incorrect forms:

yes IdM topology (noun)

Description: A term that refers to the structure of your IdM solution, especially the replication agreements between and within individual data centers and clusters.

Use it: yes

Incorrect forms:

See also:

yes in-place upgrade (noun)

Description: During an in-place upgrade, you replace the earlier version with the new version without removing the earlier version first. The installed applications and utilities, along with the configurations and preferences, are incorporated into the new version.

Use it: yes

Incorrect forms:

See also: upgrade, clean install

yes instrumentation module (noun)

Description: The kernel module built from a SystemTap script; the SystemTap module is built on the host system, and will be loaded on the target kernel of the target system.

Use it: yes

Incorrect forms:

yes inventory (noun)

Description: A list of managed nodes. An inventory file is also sometimes called a hostfile. Your inventory can specify information like IP address for each managed node. An inventory can also organize managed nodes, creating and nesting groups for easier scaling.

Use it: yes

Incorrect forms:

See also: managed nodes

yes Kerberos authentication indicators (noun)

Description: Authentication indicators are attached to Kerberos tickets and represent the initial authentication method used to acquire a ticket:

  • otp for two-factor authentication (password + one-time password)

  • radius for Remote Authentication Dial-In User Service (RADIUS) authentication (commonly for 802.1x authentication)

  • pkinit for Public Key Cryptography for Initial Authentication in Kerberos (PKINIT), smart card, or certificate authentication

  • hardened for passwords hardened against brute-force attempts

Use it: yes

Incorrect forms:

See also:

yes Kerberos keytab (noun)

Description: While a password is the default authentication method for a user, keytabs are the default authentication method for hosts and services. A Kerberos keytab is a file that contains a list of Kerberos principals and their associated encryption keys, so a service can retrieve its own Kerberos key and verify a user’s identity. For example, every IdM client has an /etc/krb5.keytab file that stores information about the host principal, which represents the client machine in the Kerberos realm.

Use it: yes

Incorrect forms:

See also: Kerberos principal

yes Kerberos principal (noun)

Description: Unique Kerberos principals identify each user, service, and host in a Kerberos realm. Kerberos principals adhere to the following naming conventions:

  • For users: identifier@REALM, such as admin@EXAMPLE.COM

  • For services: service/fully-qualified-hostname@REALM, such as http/server.example.com@EXAMPLE.COM

  • For hosts: host/fully-qualified-hostname@REALM such as host/client.example.com@EXAMPLE.COM

Use it: yes

Incorrect forms:

See also: Kerberos realm

yes Kerberos protocol (noun)

Description: Kerberos is a network authentication protocol that provides strong authentication for client and server applications by using secret-key cryptography. IdM and Active Directory use Kerberos for authenticating users, hosts and services.

Use it: yes

Incorrect forms:

See also:

yes Kerberos realm (noun)

Description: A Kerberos realm encompasses all the principals managed by a Kerberos Key Distribution Center (KDC). In an IdM deployment, the Kerberos realm includes all IdM users, hosts, and services.

Use it: yes

Incorrect forms:

yes Kerberos ticket policies (noun)

Description: The Kerberos Key Distribution Center (KDC) enforces ticket access control through connection policies, and manages the duration of Kerberos tickets through ticket lifecycle policies. For example, the default global ticket lifetime is one day, and the default global maximum renewal age is one week.

Use it: yes

Incorrect forms:

yes Key Distribution Center (noun)

Description: The Kerberos Key Distribution Center (KDC) is a service that acts as the central, trusted authority that manages Kerberos credential information. The KDC issues Kerberos tickets and ensures the authenticity of data originating from entities within the IdM network.

Use it: yes

Incorrect forms:

See also:

yes LDAP (noun)

Description: The Lightweight Directory Access Protocol (LDAP) is an open, vendor-neutral, application protocol for accessing and maintaining distributed directory information services over a network. Part of this specification is a directory information tree (DIT), which represents data in a hierarchical tree-like structure consisting of the Distinguished Names (DNs) of directory service entries. LDAP is a "lightweight" version of the Directory Access Protocol (DAP) described by the ISO X.500 standard for directory services in a network.

Use it: yes

Incorrect forms:

See also:

yes lightweight sub-CA (noun)

Description: In IdM, a lightweight sub-CA is a certificate authority (CA) whose certificate is signed by an IdM root CA or one of the CAs that are subordinate to it. A lightweight sub-CA issues certificates only for a specific purpose, for example to secure a VPN or HTTP connection.

Use it: yes

Incorrect forms:

yes managed nodes (noun)

Description: The network devices, servers, or both that you manage with Ansible. Managed nodes are also sometimes called “hosts”. Ansible is not installed on managed nodes.

Use it: yes

Incorrect forms:

See also:

with caution migration (noun)

Description: Typically, a migration indicates a change of platform: software or hardware. Moving from Windows to Linux is a migration. Moving a user from one laptop to another or a company from one server to another is a migration. However, most migrations also involve upgrades, and sometimes the terms are used interchangeably.

Use it: with caution

Incorrect forms:

See also: update, upgrade, conversion

yes OSTree (noun)

Description: A tool used for managing Linux-based operating system versions. The OSTree tree view is similar to Git and is based on similar concepts.

Use it: yes

Incorrect forms:

See also:

yes password policy (noun)

Description: A password policy is a set of conditions that the passwords of a particular IdM user group must meet. The conditions can include the following parameters:

  • The length of the password

  • The number of character classes used

  • The maximum lifetime of a password

Use it: yes

Incorrect forms:

See also:

yes POSIX attributes (noun)

Description: POSIX attributes are user attributes for maintaining compatibility between operating systems. In a Red Hat Identity Management environment, POSIX attributes for users include:

  • cn, the user’s name

  • uid, the account name (login)

  • uidNumber, a user number (UID)

  • gidNumber, the primary group number (GID)

  • homeDirectory, the user’s home directory

In a Red Hat Identity Management environment, POSIX attributes for groups include:

  • cn, the group’s name

  • gidNumber, the group number (GID)

These attributes identify users and groups as separate entities.

Use it: yes

Incorrect forms:

See also:

yes refs (noun)

Description: Represents a branch in OSTree. Refs always resolve to the latest commit. For example, rhel/8/x86_64/edge.

Use it: yes

Incorrect forms:

See also: OSTree

yes remote (noun)

Description: The HTTP or HTTPS endpoint that hosts the OSTree content. This is analogous to the baseurl for a yum or dnf repository.

Use it: yes

Incorrect forms:

See also: OSTree

yes replication agreement (noun)

Description: 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. IdM uses two types of replication agreements: domain replication agreements, which replicate identity information, and certificate replication agreements, which replicate certificate information.

Use it: yes

Incorrect forms:

See also: IdM deployment

yes revision (noun)

Description: Revision (Rev) represents SHA-256 for a specific OSTree commit.

Use it: yes

Incorrect forms:

See also: OSTree

yes rpm-ostree (noun)

Description: A hybrid image or system package that hosts operating system updates.

Use it: yes

Incorrect forms:

See also: OSTree

yes smart card (noun)

Description: A smart card is a removable device or card used to control access to a resource. They can be plastic credit card-sized cards with an embedded integrated circuit (IC) chip, small USB devices such as a Yubikey, or other similar devices. Smart cards can provide authentication by allowing users to connect a smart card to a host computer, and software on that host computer interacts with key material stored on the smart card to authenticate the user.

Use it: yes

Incorrect forms:

See also:

yes SSSD (noun)

Description: The System Security Services Daemon (SSSD) is a system service that manages user authentication and user authorization on a RHEL host. SSSD optionally keeps a cache of user identities and credentials retrieved from remote providers for offline authentication.

Use it: yes

Incorrect forms:

See also:

yes SSSD back end (noun)

Description: An System Security Services Daemon back end, often also called a data provider, is an SSSD child process that manages and creates the SSSD cache. This process communicates with an LDAP server, performs different lookup queries and stores the results in the cache. It also performs online authentication against LDAP or Kerberos and applies access and password policy to the user that is logging in.

Use it: yes

Incorrect forms:

See also: LDAP, SSSD

yes static-delta (noun)

Description: Updates to OSTree images are always delta updates. In case of RHEL for Edge images, the TCP overhead can be higher than expected due to the updates to number of files. To avoid TCP overhead, you can generate static-delta between specific commits, and send the update in a single connection. This optimization helps large deployments with constrained connectivity.

Use it: yes

Incorrect forms:

See also: OSTree, commit

yes target kernel (noun)

Description: The kernel of the target system. This is the kernel that loads and runs the instrumentation module.

Use it: yes

Incorrect forms:

yes target system (noun)

Description: The system in which the instrumentation module is being built from SystemTap scripts.

Use it: yes

Incorrect forms:

yes ticket-granting ticket (noun)

Description: After authenticating to a Kerberos Key Distribution Center (KDC), a user receives a ticket-granting ticket (TGT), which is a temporary set of credentials that can be used to request access tickets to other services, such as websites and email. You can use a TGT to request further access, and provide the user with a Single Sign-On experience, as the user only needs to authenticate once in order to access multiple services. TGTs are renewable, and Kerberos ticket policies determine ticket renewal limits and access control.

Use it: yes

Incorrect forms:

yes update (noun)

Description: Sometimes called a software patch, an update is an addition to the current version of the application, operating system, or software that you are running. A software update addresses any issues or bugs to provide a better experience of working with the technology. In Red Hat Enterprise Linux (RHEL), an update relates to a minor release, for example, updating from RHEL 8.1 to 8.2.

Use it: yes

Incorrect forms:

See also:

yes upgrade (noun)

Description: 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

Incorrect forms:

yes web server (noun)

Description: A web server is computer software and underlying hardware that accepts requests for web content, such as pages, images, or applications. A user agent, such as a web browser, requests a specific resource using HTTP, the network protocol used to distribute web content, or its secure variant HTTPS. The web server responds with the content of that resource or an error message. The web server can also accept and store resources sent from the user agent. Red Hat Identity Management (IdM) uses the Apache Web Server to display the IdM Web UI, and to coordinate communication between components, such as the Directory Server and the Certificate Authority (CA).

Use it: yes

Incorrect forms:

Red Hat JBoss BRMS and Red Hat JBoss BPM Suite

For documentation questions, contact brms-docs@redhat.com.

yes asset (noun)

Description: An "asset" is anything that can be stored as a version in the artifact repository. Assets can be business rules, packages, business processes, decision tables, fact models, or domain-specific language (DSL) files.

Use it: yes

Incorrect forms:

yes backward chaining (verb)

Description: "Backward chaining" is a feature of the rule engine. The backward chaining process is often referred to as derivation queries. It is not as common compared to reactive systems because Red Hat JBoss BRMS is primarily reactive forward chaining, that is, it responds to changes in your data. The backward chaining added to the rule engine is for product-like derivations.

Use it: yes

Incorrect forms:

See also:

yes Business Central (noun)

Description: The "Business Central" is a web-based user interface used for both Red Hat JBoss BRMS and Red Hat JBoss BPM Suite. It is the user interface for the business rules manager and has been combined with the core Drools engine and other tools. It enables a business user to manage rules in a multi-user environment and implement changes in a controlled fashion.

Use it: yes

Incorrect forms: Central, BC

See also:

yes Business Resource Planner (noun)

Description: The "Business Resource Planner" is a lightweight, embeddable, planning engine that optimizes planning problems. It helps Java TM programmers solve planning problems efficiently, and it combines optimization heuristics and metaheuristics with very efficient score calculations.

Use it: yes

Incorrect forms: Resource Planner, Planner

See also:

yes business process (noun)

Description: A "business process" is a collection of related, structured tasks that results in achieving a specific target. It is presented as as a flowchart comprising a sequence steps necessary to achieve business goals.

Use it: yes

Incorrect forms:

See also:

yes business rule (noun)

Description: A "business rule" defines a particular aspect of a business that is intended to assert business structure or influence the behaviour of a business. Business rules often focus on access control issues and pertain to business calculations and policies of an organization.

Use it: yes

Incorrect forms:

See also:

yes data enumeration (noun)

Description: "Data enumeration" is an optional type of asset that can be configured to provide drop-down lists for the guided decision table editor.

Use it: yes

Incorrect forms: enum

See also:

yes data model (noun)

Description: "Data model" is a model of a data object. A data object is a custom complex data type, such as a Person object with data fields Name, Address, and Date of Birth.

Use it: yes

Incorrect forms: pojo

See also:

yes Data Modeler (noun)

Description: The "Data Modeler" is a built-in editor for creating facts or data objects as part of a project data model from Business Central. Data objects are custom data types implemented as Java objects. These custom data types can be used in any resource (such as a guided decision table) after they have been imported.

Use it: yes

Incorrect forms:

See also:

yes decision table (noun)

Description: A "decision table" is a collection of rules stored in either a spreadsheet or in the Red Hat JBoss BRMS user interface.

Use it: yes

Incorrect forms:

See also:

yes decision tree (noun)

Description: A "decision tree" is a graphical representation of a decision model in a tree-like manner.

Use it: yes

Incorrect forms:

See also:

yes DRL (noun)

Description: "DRL" is an abbreviation for the Drools Rule Language, which is a file with the .drl extension. A DRL file stores technical rules as text and can be managed in the Red Hat Red Hat JBoss BRMS user interface. A DRL file contains one or more rules.

Use it: yes

Incorrect forms: drl

See also:

yesDSL (noun)

Description: "DSL" is an abbreviation for domain-specific language. DSL is used to create a rule language that is dedicated to your problem domain. A set of DSL definitions consists of transformations from DSL sentences to DRL constructs. These constructs let you use all of the underlying rule language and engine features. You can write rules in DSL rule (DSLR) files, which are translated into DRL files.

Use it: yes

Incorrect forms: dsl

See also:

yes Drools Expert (noun)

Description: The "Drools Expert" is a pattern matching-based rule engine that runs on Java EE application servers, Red Hat JBoss BRMS platform, or bundled with Java applications. It comprises an inference engine, a production memory, and a working memory. Rules are stored in the production memory, and the facts that the inference engine matches the rules against are stored in the working memory.

Use it: yes

Incorrect forms:

See also:

yes guided editor (noun)

Description: The "guided editor" is an editor for creating and editing business rules. Rules edited in the guided editor use the Business Rules Language (BRL) format. The guided editor prompts users for input based on the object model of the rule being edited.

Use it: yes

Incorrect forms: Editor, GUI editor, Business Central editor

See also: Business Central

yes inference engine (noun)

Description: The "inference engine" is a part of the Red Hat JBoss BRMS engine, which matches production facts and data to rules. It is often called the brain of a production rules system because it is able to scale to a large number of rules and facts. It makes inferences based on its existing knowledge and performs the actions based on what it infers from the information.

Use it: yes

Incorrect forms: BRMS engine, engine

See also:

yes Intelligent Process Server (noun)

Description: The "Intelligent Process Server" is a standalone, out-of-the-box component that can be used to instantiate and execute rules and processes. The Intelligent Process Server is created as a WAR file that can be deployed on any web container.

Use it: yes

Incorrect forms: Kie server

See also:

yes KJAR (noun)

Description: Red Hat JBoss BPM Suite provides a simplified and complete deployment mechanism that is based entirely on Apache Maven artifacts. These artifacts, also known as "KJARs", are simple jar files that include a descriptor for the KIE system to produce KieBase and KieSession. The KJAR descriptor is represented as the kmodule.xml file.

Use it: yes

Incorrect forms: kjar, kJAR

See also:

yesKIE (noun)

Description: "KIE" is an abbreviation for Knowledge Is Everything. KIE is a knowledge solution for Red Hat JBoss BRMS and JBoss BPM Suite and is used for the generic parts of a unified API, such as building, deploying, and loading.

Use it: yes

Incorrect forms: kie, Kie, knowledge

See also:

yes KIE API (noun)

Description: The "KIE API" is a knowledge-centric API, where rules and processes are first class citizens. KIE is used for the generic parts of unified API, such as building, deploying, and loading.

Use it: yes

Incorrect forms: kie, Kie, knowledge API

See also:

yes KIE base (noun)

Description: The "KIE base" is a repository of the application’s knowledge definitions. The name of the Java object is KieBase. It contains rules, processes, functions, and type models. A KIE base does not contain runtime data; instead KIE sessions are created from the KieBase into which data can be inserted and process instances started.

Use it: yes

Incorrect forms: kbase, knowledge base

See also:

yes KIE session (noun)

Description: A "KIE session" stores runtime data created from a KIE base. The name of the Java object is KieSession. After the KIE base is loaded, a session can be created to interact with the engine. The session can then be used to start new processes and signal events.

Use it: yes

Incorrect forms: ksession, knowledge session

See also:

yes knowledge store (noun)

Description: "Knowledge store" is a centralized repository for your business knowledge. The knowledge store connects to the Git repository to store various knowledge assets and artifacts at a single location.

Use it: yes

Incorrect forms:

See also:

yes organizational unit (noun)

Description: An "organizational unit" is a directory comprising repositories that store business assets.

Use it: yes

Incorrect forms:

See also:

yes package (noun)

Description: A "package" is a deployable collection of assets. Rules and other assets must be collected into a package before they can be deployed. When a package is built, the assets contained in the package are validated and compiled into a deployable package.

Use it: yes

Incorrect forms:

See also:

yes project (noun)

Description: A "project" is a container that comprises packages of assets (business processes, rules, work definitions, decision tables, fact models, data models, and DSLs) and is located in the knowledge repository. This container defines the properties of the KIE base and KIE session that are applied to its content. You can edit these entities in the project editor in Business Central.

Use it: yes

Incorrect forms:

yes Realtime Decision Server (noun)

Description: The "Realtime Decision Server" is a standalone, built-in component that can be used to instantiate and execute rules through interfaces available for REST, JMS, or a Java client-side applications. Created as a web deployable WAR file, this server can be deployed on any web container. The current version of the Realtime Decision Server is included with default extensions for both Red Hat JBoss BRMS and Red Hat JBoss BPM Suite.

Use it: yes

Incorrect forms: Decision Server, Kie Server

See also:

yes Red Hat JBoss BRMS (noun)

Description: "Red Hat JBoss BRMS" is a comprehensive platform for business rules management, business resource optimization, and complex event processing (CEP). BRMS stands for Business Rules Management System. Organizations can use Red Hat JBoss BRMS to incorporate sophisticated decision logic into line-of-business applications and quickly update underlying business rules as market conditions change.

Use it: yes

Incorrect forms: BRMS, BRM, JBoss BRMS

See also:

yes Red Hat JBoss BPM Suite (noun)

Description: "Red Hat JBoss BPM Suite" is the JBoss platform for Business Process Management (BPM). It enables enterprise business and IT users to document, simulate, manage, automate, and monitor business processes and policies. It is designed to empower business and IT users to collaborate more effectively, so business applications can be changed more easily and quickly.

Use it: yes

Incorrect forms: BPMS, BPM, JBoss BPMS

See also:

yes rule (noun)

Description: A "rule" provides the logic for the rule engine to execute against. A rule includes a name, attributes, a “when” statement on the left side of the rule, and a “then” statement on the right side of the rule.

Use it: yes

Incorrect forms: technical rule

See also:

yes rule template (noun)

Description: A "rule template" enables the user to define a rule structure. Rule templates provide a placeholder for values and data, and they populate templates to generate many rules.

Use it: yes

Incorrect forms:

See also:

yes runtime manager (noun)

Description: The "runtime manager" is an interface that enables and simplifies the usage of a KIE API within the processes. The name of the interface is RuntimeManager. It provides configurable strategies that control actual runtime execution.The strategies are singleton, per request, and per process instance.

Use it: yes

Incorrect forms:

See also: KIE API

yes Scorecard (noun)

Description: "Scorecard" is a risk management tool that is a graphical representation of a formula used to calculate an overall score. It is mostly used by financial institutions or banks to calculate the risk they can take to sell a product in the market. It can predict the likelihood or probability of a certain outcome. Red Hat JBoss BRMS supports additive scorecards that calculates an overall score by adding all partial scores assigned to individual rule conditions.

Use it: yes

Incorrect forms:

See also:

yes truth maintenance system (noun)

Description: A "truth maintenance system" (TMS) refers to the ability of the inference engine to enforce truthfulness when applying rules. The truth maintenance system uses the mechanism of truth maintenance to efficiently handle the inferred information from rules. It provides justified reasoning for each and every action taken by the inference engine and validates the conclusions of the engine. If the inference engine asserts data as a result of firing a rule, the engine uses the truth maintenance to justify the assertion.

Use it: yes

Incorrect forms:

See also:

yes working memory (noun)

Description: "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.

Use it: yes

Incorrect forms:

See also:

Red Hat JBoss Enterprise Application Platform

no ActiveMQ (noun)

Description: Do not use "ActiveMQ" by itself to refer to the built-in messaging technology for JBoss EAP.

Use it: no

Incorrect forms: Active MQ, Active-MQ

with caution ActiveMQ Artemis (noun)

Description: Use "ActiveMQ Artemis" only when describing the technology used to implement the built-in messaging for JBoss EAP.

Use it: with caution

Incorrect forms: Active MQ Artemis, Active-MQ Artemis

yes batch-jberet subsystem (noun)

Description: The "batch-jberet" subsystem is used to configure and manage batch jobs. In general text, write in lowercase as two words separated by a hyphen. Use "Batch subsystem" when referring to the batch-jberet subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes bean-validation subsystem (noun)

Description: The "bean-validation" subsystem is used to configure validation of Java bean object data. In general text, write in lowercase as two words separated by a hyphen. Use "Bean Validation subsystem" when referring to the bean-validation subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes built-in messaging (noun)

Description: "Built-in messaging" is an acceptable term for referring to the built-in messaging system in JBoss EAP. Capitalize "built-in" only at the beginning of a sentence. Other acceptable terms are "JBoss EAP messaging" and "JBoss EAP built-in messaging".

Use it: yes

Incorrect forms: ActiveMQ, ActiveMQ Artemis

yes core-management subsystem (noun)

Description: The "core-management" subsystem is used to register server lifecycle event listeners and track configuration changes. In general text, write in lowercase as two words separated by a hyphen. Use "Core Management subsystem" when referring to the core-management subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes datasource subsystem (noun)

Description: The "datasource" subsystem is used to create and configure data sources and to manage JDBC database drivers. In general text, write in lowercase as one word. Use "Datasource subsystem" when referring to the datasource subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes deployment-scanner subsystem (noun)

Description: The "deployment-scanner" subsystem is used to configure scanners to check for applications to deploy. In general text, write in lowercase as two words separated by a hyphen. Use "Deployment Scanners subsystem" when referring to the deployment-scanner subsystem in titles and headings. When writing the term in its heading form, ensure that you include a plural 's'.

Use it: yes

Incorrect forms:

See also:

no domain mode (noun)

Description: Do not use "domain mode" to refer to the running instance of JBoss EAP server. See the managed domain entry for the correct usage.

Use it: no

Incorrect forms:

See also: managed domain

yes ee subsystem (noun)

Description: The "ee" subsystem is used to configure functionality in the Jakarta Enterprise Edition platform. In general text, write in lowercase as one word. Use "EE subsystem" when referring to the ee subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes ejb3 subsystem (noun)

Description: The "ejb3" subsystem is used to configure Enterprise JavaBeans. In general text, write in lowercase as one word. Use "EJB 3 subsystem" when referring to the ejb3 subsystem in titles and headings. When writing the term in its heading form, ensure that you include a space between 'EJB' and '3'.

Use it: yes

Incorrect forms:

See also:

yes elytron subsystem (noun)

Description: The "elytron" subsystem is used to configure server and application security. Write in lowercase in general text. Use "Elytron subsystem" when referring to the elytron subsystem in titles and headings. See the Security - Elytron entry for the correct usage when referring to the elytron subsystem in the management console.

Use it: yes

Incorrect forms:

See also: Security - Elytron

yes Expansion Pack (noun)

Description: "Expansion Pack" is a JBoss EAP add-on that enhances JBoss EAP with additional features, such as MicroProfile capabilities.

Use it: yes

Incorrect forms:

See also: XP

no HTTP interface (noun)

Description: "HTTP interface" is an interface accessed using hypertext transfer protocol. Do not use “HTTP interface” to refer to the JBoss EAP management console. See the management console entry for the correct usage.

Use it: no

Incorrect forms:

See also: management console

yes iiop-openjdk subsystem (noun)

Description: The "iiop-openjdk" subsystem is used to configure Common Object Request Broker Architecture (CORBA) services. In general text, write in lowercase as two words separated by a hyphen. Use "IIOP subsystem" when referring to the iiop-openjdk subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes io subsystem (noun)

Description: The "io" subsystem is used to define workers and buffer pools used by other subsystems. In general text, write in lowercase as one word. Use "IO subsystem" when referring to the io subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes jaxrs subsystem (noun)

Description: The "jaxrs" subsystem enables the deployment and functionality of RESTful web services through the Java API for RESTful Web Services (JAX-RS). In general text, write in lowercase as one word. Use "JAX-RS subsystem" when referring to the jaxrs subsystem in titles and headings. When writing the term in its heading form, ensure that you include a hyphen between 'JAX' and 'RS'.

Use it: yes

Incorrect forms:

See also:

no JBoss AMQ (noun)

Description: Do not use "JBoss AMQ" to refer to the Red Hat messaging queue product. This product has been renamed "Red Hat AMQ".

Use it: no

Incorrect forms:

See also: Red Hat AMQ

yes JBoss EAP (noun)

Description: "JBoss EAP" is the approved shortened form of Red Hat JBoss Enterprise Application Platform.

Use it: yes

Incorrect forms: EAP, JBoss

yes JBoss EAP built-in messaging (noun)

Description: "JBoss EAP built-in messaging" is an acceptable term for referring to the built-in messaging system in JBoss EAP. Other acceptable terms are "built-in messaging" and "JBoss EAP messaging".

Use it: yes

Incorrect forms: ActiveMQ, ActiveMQ Artemis

yes JBoss EAP messaging (noun)

Description: "JBoss EAP messaging" is an acceptable term for referring to the built-in messaging system in JBoss EAP. Other acceptable terms are "built-in messaging" and "JBoss EAP built-in messaging".

Use it: yes

Incorrect forms: ActiveMQ, ActiveMQ Artemis

yes jca subsystem (noun)

Description: The "jca" subsystem is used to configure settings for the Jakarta EE Connector Architecture (JCA) container. In general text, write in lowercase as one word. Use "JCA subsystem" when referring to the jca subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes jdr subsystem (noun)

Description: The "jdr" subsystem is used to gather diagnostic data to support troubleshooting. In general text, write in lowercase as one word. Use "JDR subsystem" when referring to the jdr subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes jgroups subsystem (noun)

Description: The "jgroups" subsystem is used to configure protocol stacks and communication mechanisms for servers in a cluster. In general text, write in lower case as one word. Use "JGroups subsystem" when referring to the jgroups subsystem in titles and headings. When writing the term in its heading form, ensure that you include an uppercase 'G'.

Use it: yes

Incorrect forms:

See also:

yes jmx subsystem (noun)

Description: The "jmx" subsystem is used to configure remote Java Management Extensions (JMX) access. In general text, write in lowercase as one word. Use "JMX subsystem" when referring to the jmx subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes jpa subsystem (noun)

Description: The "jpa" subsystem is used to manage requirements of the Java Persistence API. In general text, write in lowercase as one word. Use "JPA subsystem" when referring to the jpa subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes jsf subsystem (noun)

Description: The "jsf" subsystem is used to manage JavaServer Faces implementations. In general text, write in lowercase as one word. Use "JSF subsystem" when referring to the jsf subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes jsr77 subsystem (noun)

Description: The "jsr77" subsystem provides Java EE management capabilities defined by the JSR-77 specification. In general text, write in lowercase as one word. Use "JSR-77 subsystem" when referring to the jsr77 subsystem in titles and headings. When writing the term in its heading form, ensure that you include a hyphen between 'JSR' and '77'.

Use it: yes

Incorrect forms:

See also:

yes keystore (noun)

Description: A "keystore" is a repository for private and self-certified security certificates. Write in lowercase as one word. This is in contrast to a "truststore", which stores trusted security certificates.

Use it: yes

Incorrect forms: key store

See also: truststore

yes load balance (verb)

Description: The compound verb "load balance" means to distribute processing requests among a set of servers.

Use it: yes

Incorrect forms: load-balance, load-balancing

See also:

yes logging subsystem (noun)

Description: 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.

Use it: yes

Incorrect forms:

See also:

yes mail subsystem (noun)

Description: The "mail" subsystem is used to configure mail services for applications deployed to JBoss EAP. Write in lowercase in general text. Use "Mail subsystem" when referring to the mail subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes managed domain (noun)

Description: A "managed domain" is a group of JBoss EAP instances managed from a single control point. This is the appropriate way to refer to the managed domain operating mode. For example, "When running the JBoss EAP server in a managed domain".

Use it: yes

Incorrect forms: domain mode

See also: domain mode

yes management CLI (noun)

Description: Use "management CLI" to refer to the command line interface for the JBoss EAP management tool. Do not capitalize "management" unless it starts a sentence.

Use it: yes

Incorrect forms: CLI, native interface

See also: CLI, native interface

yes management console (noun)

Description: Use "management console" to refer to the web-based JBoss EAP management console. Do not capitalize "management" unless it starts a sentence.

Use it: yes

Incorrect forms: GUI, HTTP interface

See also: HTTP interface

yes messaging-activemq subsystem (noun)

Description: The "messaging-activemq" subsystem is used to configure messaging in JBoss EAP. In general text, write in lowercase as two words separated by a hyphen. Use "Messaging subsystem" when referring to the messaging-activemq subsystem in titles and headings. See the Messaging - ActiveMQ entry for the correct usage when referring to the messaging-activemq subsystem in the management console.

Use it: yes

Incorrect forms:

yes Messaging - ActiveMQ (noun)

Description: Use "Messaging - ActiveMQ" when describing the messaging-activemq subsystem in the management console. Write as two capitalized words separated by two spaces and a hyphen. Ensure that "MQ" is also in uppercase.

Use it: yes

Incorrect forms:

yes messaging subsystem (noun)

Description: "Messaging subsystem" is an acceptable generic term for referring to the messaging-activemq subsystem. Capitalize "messaging" only at the beginning of a sentence. However, see the Messaging - ActiveMQ entry for the correct usage when referring to the messaging-activemq subsystem in the management console.

Use it: yes

Incorrect forms:

no Microsoft Windows (noun)

Description: Do not use "Microsoft Windows" to refer to the Windows Server product by Microsoft or to Windows-specific commands and scripts such as standalone.bat. See the Windows Server entry for the correct usage.

Use it: no

Incorrect forms:

See also: Windows Server

yes modcluster subsystem (noun)

Description: The "modcluster" subsystem is used to configure modcluster worker nodes. In general text, write in lowercase as one word. Use "ModCluster subsystem" when referring to the modcluster subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes naming subsystem (noun)

Description: The "naming" subsystem is used to manage Java naming and directory interface (JNDI) namespaces and interfaces. Write in lowercase in general text. Use "Naming subsystem" when referring to the naming subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

no native interface (noun)

Description: Do not use "native interface" to refer to the command line interface for the JBoss EAP management tool. See the management CLI entry for the correct usage.

Use it: no

Incorrect forms:

See also: management CLI

Description: 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'.

Use it: yes

Incorrect forms:

See also:

Description: The "picketlink-identity-management" subsystem is used to configure identity management services. In general text, write in lowercase as three words separated by hyphens. Use "PicketLink Identity Management subsystem" when referring to the picketlink-identity-management subsystem in titles and headings. When writing the term in its heading form, ensure that you include an uppercase 'L'.

Use it: yes

Incorrect forms:

yes pojo subsystem (noun)

Description: The "pojo" subsystem enables deployment of applications containing JBoss Microcontainer services. In general text, write in lowercase as one word. Use "POJO subsystem" when referring to the pojo subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes Red Hat AMQ (noun)

Description: "Red Hat AMQ" is the official name of the Red Hat messaging queue product.

Use it: yes

Incorrect forms: JBoss AMQ, Red Hat JBoss AMQ

See also: JBoss AMQ

yes Red Hat Customer Portal (noun)

Description: "Red Hat Customer Portal" is the official name of the customer portal at https://access.redhat.com.

Use it: yes

Incorrect forms: Customer Portal

See also:

yes Red Hat JBoss Enterprise Application Platform (noun)

Description: "Red Hat JBoss Enterprise Application Platform" is an enterprise-grade Java application server. Spell out on first use in a guide, and use the approved abbreviation "JBoss EAP" thereafter.

Use it: yes

Incorrect forms: Red Hat JBoss EAP, JBoss Enterprise Application Platform

See also: JBoss EAP

yes remoting subsystem (noun)

Description: The "remoting" subsystem is used to configure inbound and outbound connections for local and remote servers. Write in lowercase in general text. Use "Remoting subsystem" when referring to the remoting subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes request-controller subsystem (noun)

Description: The "request-controller" subsystem is used to configure settings to suspend servers or to shut them down gracefully. In general text, write in lowercase as two words separated by a hyphen. Use "Request Controller subsystem" when referring to the request-controller subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes resource-adapters subsystem (noun)

Description: The "resource-adapters" subsystem is used to configure and maintain resource adapters for communication between Java EE applications and an Enterprise Information System (EIS). In general text, write in lowercase as two words separated by a hyphen. Use "Resource Adapters subsystem" when referring to the resource-adapters subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also: Resource Adapters

yes rts subsystem (noun)

Description: The "rts" subsystem is an implementation of REST AT that is not supported in JBoss EAP. In general text, write in lowercase as one word. Use "RTS subsystem" when referring to the rts subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes sar subsystem (noun)

Description: The "sar" subsystem enables deployment of SAR archives containing MBean services. In general text, write in lowercase as one word. Use "SAR subsystem" when referring to the sar subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes security subsystem (noun)

Description: The legacy security subsystem in JBoss EAP is called "security". Write in lowercase in general text. Use "Security subsystem" when referring to the legacy security subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes Security - Elytron (noun)

Description: Use “Security - Elytron” when describing the elytron subsystem in the management console. Write as two capitalized words separated by two spaces and a hyphen.

Use it: yes

Incorrect forms:

See also: elytron

yes security-manager subsystem (noun)

Description: The "security-manager" subsystem is used to configure security policies used by the Java Security Manager. In general text, write in lowercase as two words separated by a hyphen. Use "Security Manager subsystem" when referring to the security-manager subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes singleton subsystem (noun)

Description: The "singleton" subsystem is used to configure the behavior of singleton deployments. Write in lowercase in general text. Use "Singleton subsystem" when referring to the singleton subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

no standalone mode (noun)

Description: Do not use "standalone mode" to refer to the standalone operating mode of JBoss EAP server. See the standalone server entry for the correct usage.

Use it: no

Incorrect forms:

See also: standalone server

yes standalone server (noun)

Description: Use "standalone server" to refer to the standalone operating mode of JBoss EAP server. For example, when running JBoss EAP as a standalone server.

Use it: yes

Incorrect forms: standalone mode

See also: standalone mode

yes transactions subsystem (noun)

Description: The "transactions" subsystem is used to configure options in the Transaction Manager. Write in lowercase in general text. Use "Transactions subsystem" when referring to the transactions subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes truststore (noun)

Description: A "truststore" is a repository of trusted security certificates. Write in lowercase as one word. This is in contrast to a "keystore", which stores private and self-certified certificates.

Use it: yes

Incorrect forms: trust store

See also: keystore

yes undertow subsystem(noun)

Description: The "undertow" subsystem is used to configure the JBoss EAP web server and servlet container settings. Write in lowercase in general text. Use "Undertow subsystem" when referring to the undertow subsystem in titles and headings. See the WebHTTP - Undertow entry for the correct usage when referring to the undertow subsystem in the management console.

Use it: yes

Incorrect forms:

See also: webhttp-undertow

yes WebHTTP - Undertow (noun)

Description: Use "WebHTTP - Undertow" when describing the undertow subsystem in the management console. Write as two capitalized words separated by two spaces and a hyphen. Ensure that "HTTP" is also in uppercase.

Use it: yes

Incorrect forms:

See also: undertow

yes Web services (noun)

Description: Use "Web services" when referring to the general concept of Web services. Write as two words. Capitalize "Web" and write "services" in lowercase.

Use it: yes

Incorrect forms: webservices, web services, Web Services

See also:

yes webservices subsystem (noun)

Description: The "webservices" subsystem is used to configure the Web services provider. In general text, write in lowercase as one word. Use "Web Services subsystem" when referring to the webservices subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes weld subsystem (noun)

Description: The "weld" subsystem is used to configure Contexts and Dependency Injection (CDI) functionality for JBoss EAP. Write in lowercase in general text. Use "Weld subsystem" when referring to the weld subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

yes Windows Server (noun)

Description: Use "Windows Server" to refer to the Windows Server product by Microsoft or to Windows-specific commands and scripts such as standalone.bat. Do not precede the product name with "Microsoft".

Use it: yes

Incorrect forms: Microsoft Windows Server, Microsoft Windows, Windows

See also: Microsoft Windows

yes XP (noun)

Description: "XP" is an acceptable shortened form of "Expansion Pack". Write in upper case.

Use it: yes

Incorrect forms: Xp, xp

See also: Expansion Pack

yes xts subsystem (noun)

Description: The "xts" subsystem is used to configure settings for coordinating Web services in a transaction. In general text, write in lowercase as one word. Use "XTS subsystem" when referring to the xts subsystem in titles and headings.

Use it: yes

Incorrect forms:

See also:

Red Hat JBoss Fuse

For documentation questions, contact fuse-docs@redhat.com.

with caution Camel context (noun)

Description: Every Camel application is based on a CamelContext object, which is the Camel runtime. The CamelContext object keeps track of and provides access to all services loaded in it, such as components, endpoints, routes, data formats, languages, and registry. In the routing context .xml file, the object is represented by the <camelContext> element, which encloses all <route> elements and their routing rules. In Camel DSL, CamelContext instantiates a new DefaultCamelContext in which to add and configure routes and their routing rules. Use only when referencing code (element or method), otherwise use the generic term routing context when talking about the application’s .xml/DSL file or the file’s routing rules.

Use it: with caution

Incorrect forms:

See also: routing context

yes canvas (noun)

Description: In Fuse tooling, the route editor provides a canvas (Design tab) on which to build routes graphically, using components and Enterprise Integration Patterns (EIPs) available in the Palette.

Use it: yes

Incorrect forms:

See also: Design tab, EIP

yes component (noun)

Description: A component is a factory for creating endpoints in a Camel route. For example, you would use the Twitter component to create Twitter endpoints. In Fuse tooling, the Palette’s Components drawer contains the Camel components that you can add to your route in the route editor. Each component represents a connection to a specific service or application, such as Atom, CXF, Bean, File, and so on.

Use it: yes

Incorrect forms:

See also: connection, endpoint

yes Configurations tab (noun)

Description: In Fuse tooling, the route editor’s Configurations tab enables you to add configuration shared globally by all routes in a multiroute routing context. You can select existing endpoints, data formats, or beans from the list or create and add new ones.

Use it: yes

Incorrect forms: Configurations view

yes connection (noun)

Description: In Fuse Ignite, you create a connection using a Fuse Ignite connector. You can then use the connection in a Fuse Ignite 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

Incorrect forms:

See also: connector

yes connector (noun)

Description: In Fuse Ignite, 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

Incorrect forms:

See also: connection

yes consumer (noun)

Description: In Camel, 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

Incorrect forms:

yes Design tab (noun)

Description: In Fuse tooling, the route editor’s Design tab displays a graphical representation of the routing context.

Use it: yes

Incorrect forms: Design view

yes EIP (noun)

Description: Enterprise Integration Pattern. A pattern language providing a technology-independent vocabulary and visual notation for designing and documenting enterprise integration solutions. Each pattern provides a proven solution for a recurring problem in integrating disparate applications and services across different enterprises. Camel implements numerous patterns for asynchronous messaging. In Fuse tooling, these patterns are located in the Palette and filed in separate drawers according to function (Routing, Control Flow, Transformation, and Miscellaneous).

Use it: yes

Incorrect forms:

See also: component

with caution endpoint (noun)

Description: In Camel, 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

Incorrect forms:

yes FUSE_HOME (noun)

Description: Fuse installation directory. Use this when describing which directory to use.

Use it: yes

Incorrect forms: INSTALL_DIR, installDir

See also:

yes Fuse Ignite (noun)

Description: Fuse Ignite is the name of the new integration as a service (iPaaS) offering. When writing documentation for Fuse Ignite, do not use common Camel terms such as endpoint, consumer, producer. It is assumed that Fuse Ignite users know nothing about Camel.

Use it: yes

Incorrect forms: Ignite

See also: Syndesis

yes Fuse tooling (noun)

Description: Fuse tooling is a plugin to Developer Studio that enables rapid design, development, debugging, testing, and publishing of Camel applications on a variety of servers, such as Fuse, EAP, Wildfly, and OpenShift.

Use it: yes

Incorrect forms:

See also:

yes integration (noun)

Description: An integration is a Camel route created in Fuse Ignite.

Use it: yes

Incorrect forms:

See also:

yes message (noun)

Description: In Camel, the message is the fundamental structure for moving data through a route. A message consists of a body (also known as payload), headers, and attachments (optional). Messages flow in one direction from sender to receiver. Headers contain metadata, such as sender IDs, content encoding hints, and so on. Attachments can be text, image, audio, or video files and are typically used with email and web service components.

Use it: yes

Incorrect forms:

See also: message exchange

yes message exchange (noun)

Description: In Camel, message exchanges deal with conversations and can flow in both directions. They encapsulate messages in containers while the messages are in route to their target endpoints. A message exchange consists of an exchange ID that identifies the conversation, a MEP setting to indicate whether the exchange is one- or two-way (request-reply), an Exception field that is set whenever an error occurs during routing, and global-level properties that users can store/retrieve at any time during the lifecycle of the exchange.

Use it: yes

Incorrect forms:

See also: message, MEP

yes MEP (noun)

Description: Message Exchange Pattern. In Camel, the MEP is the part of the message exchange that selects between one of two messaging modes: one-way (InOnly) or request-reply (InOut). The default is InOnly.

Use it: yes

Incorrect forms:

See also: message exchange

yes node (noun)

See node in the General Conventions chapter.

yes PID (noun)

Description: The persistent identifier (PID) of a registered OSGi service is used to identify the service across container restarts. In Fuse (Karaf), PIDs map to .cfg configuration files located in the FUSE_HOME/etc/ directory. A .cfg file contains a list of attribute/value pairs that configure a service. You can edit any .cfg file to configure/reconfigure the corresponding OSGi service.

Use it: yes

Incorrect forms:

See also:

yes processor (noun)

Description: In a Camel route, a processor is a node that is capable of using, creating, or modifying an incoming message exchange. Processors are typically implementations of EIPs, but can be custom made.

Use it: yes

Incorrect forms:

See also: route, EIP

yes producer (noun)

Description: In Camel, a producer is an endpoint that acts as the source of messages exiting a route. It can create and send processed messages to their target destination, such as external systems or services. The producer populates the messages it creates with data that is compatible with the target destination. A route can have multiple producers.

Use it: yes

Incorrect forms:

See also: consumer

yes Properties View (noun)

Description: In Fuse tooling, Properties view displays, by default, the properties of the node that is selected on the canvas for editing. It also displays the selected node’s user documentation on the Documentation tab.

Use it: yes

Incorrect forms: Properties editor

See also:

yes route (noun)

Description: In Camel, 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

Incorrect forms:

yes route editor (noun)

Description: In Fuse tooling, the route editor is the tool you use to construct the route or routes in your routing context. It provides two methods that you can use interchangeably. You build a context graphically in the Design tab. You code a context in XML in the Source tab.

Use it: yes

Incorrect forms: Camel editor

See also: Design tab, Source tab

yes routing context (noun)

Description: A routing context specifies the routing rules for a Camel application. Among other things, routing rules specify the source and type of input, how to process it, and where to send the output when processing is done. In Fuse tooling, the routing context is provided in a .xml file, the name of which depends on the configuration framework used. For Spring-based projects, the default name of the routing context file is camelContext.xml. For Blueprint-based projects, the default name of the routing context file is blueprint.xml.

Use it: yes

Incorrect forms:

yes routing rules (noun)

Description: Routing rules are declarative statements (written in Java or XML DSL) that define the paths which messages take from their origin (source) to their target destination (sink). Routing rules start with a consumer endpoint (from) and typically end with one or more producer endpoints (to). Between consumer and producer endpoints, messages can enter various processors, which might transform them or redirect them to other processors or to specific producer endpoints. In Fuse tooling, you can view and edit a project’s routing rules on the route editor’s Source tab. On the Design tab, you can build and view routing rules graphically.

Use it: yes

Incorrect forms:

yes Source tab (noun)

Description: In Fuse tooling, the route editor’s Source tab displays the XML code that corresponds to the graphical representation of the routing context displayed on the Design tab. You can edit and save changes to the routing context on either tab. Changes saved on one tab are immediately propagated and saved on the other tab.

Use it: yes

Incorrect forms: Source view

yes Syndesis (noun)

Description: The community name for Fuse Ignite.

Use it: yes

Incorrect forms:

See also: Fuse Ignite

yes URI (noun)

Description: Uniform Resource Identifier. A string of characters that indentifies a resource, it enables interaction with representations of the resource over a network using schemes with specific syntax and associated protocols. In Camel, URIs are used to create and configure endpoints. Camel URIs have a specific syntax: scheme:context_path?options. scheme specifies the component to use to create and handle endpoints of its type; context_path specifies the location of the input data; and options, in the form of property=value pairs, configure the behavior of the created endpoints. For example, the URI file:data/orders?delay=5000 in the consumer endpoint <from uri="file:data/orders?delay=5000" /> employs the File component to create a file endpoint, whose input source, the data/orders directory, is polled for files at 5 second intervals.

Use it: yes

Incorrect forms: uri

See also: endpoint, URN

yes URN (noun)

Description: Uniform Resource Name. A URN is a special URI that identifies, by name, a resource located in a specific namespace. A URN can be used to talk about a resource without implying its location or access details.

Use it: yes

Incorrect forms: urn

See also: URI

Red Hat OpenShift

yes action (noun)

Description: In the context of authorization in OpenShift Container Platform, an action consists of project, verb, and resource.

Use it: yes

Incorrect forms:

See also: project, verb, resource

yes API objects (noun)

Description: API objects are the resources that can be exposed by an API server at an endpoint for interrogation.

For general references to a term that is also an API object, use lower case and separate multi-word API objects. For example:

  • pod

  • node

  • daemon set

  • config map

Example general term usage: You must have at least one secret, config map, or service account.

However, if you are interacting with the API object, such as when defining or editing an object, use the proper PascalCase Kind for the object and mark it up in monospace. For example:

  • Pod

  • Node

  • DaemonSet

  • ConfigMap

Example object-specific usage: The default amount of CPU that a container can use if not specified in the Pod spec.

Use it: yes

Incorrect forms:

See also: API server, endpoint

yes API server (noun)

Description: A REST API endpoint for interacting with the system. New deployments and configurations can be created with this endpoint, and the state of the system can be interrogated through this endpoint as well.

Use it: yes

Incorrect forms:

See also: endpoint

yes application (noun)

Description: Although the term application is not an specific API object type in OpenShift Container Platform, customers still create and host applications on OpenShift Container Platform, and using the term within certain contexts is acceptable. For example, the term application might refer to some combination of an image, a Git repository, or a replication controller, and this application might be running PHP, MySQL, Ruby, JBoss, or something else.

Use it: yes

Incorrect forms:

See also: app

yes authorization (noun)

Description: An authorization determines whether an identity is allowed to perform any action. It consists of identity and action.

Use it: yes

Incorrect forms:

See also: action, identity

yes build (noun)

Description: The process of transforming input parameters into a resulting object. Most often, the process is used to transform input parameters or source code into a runnable image.

Use it: yes

Incorrect forms:

See also:

yes build config (noun)

Description: A build config describes a single build definition and a set of triggers for when a new build should be created. The API object for a build config is BuildConfig.

Use it: yes

Incorrect forms:

See also: build, API objects

yes cluster (noun)

See cluster in the General Conventions part.

yes config map (noun)

Description: A config map holds configuration data for pods to consume. The API object for a config map is ConfigMap.

Use it: yes

Incorrect forms: configmap, configuration map

See also: API objects

yes container (noun)

See container in the General Conventions part.

yes controller (noun)

Description: An object that reads APIs, applies changes to other objects, and reports status or write back to the object.

Use it: yes

Incorrect forms:

See also:

yes custom resource (noun)

Description: A custom resource (CR) is a resource implemented through the Kubernetes CustomResourceDefinition API. Although CRs have the same behaviors as the built-in set of Kubernetes and OpenShift Container Platform resources, CRs are added either manually or by installing Operators. Therefore, CRs might not be available on all clusters by default. Every CR is part of an API group.

Use it: yes

Incorrect forms:

See also:

yes custom resource definition (noun)

Description: A custom resource definition (CRD) defines a new, unique object Kind in the cluster and lets the Kubernetes API server handle its entire lifecycle.

Use it: yes

Incorrect forms:

See also:

yes deployment (noun)

Description: A statement of intent by a user to deploy a new version of a configuration. To avoid confusion, do not refer to an overall OpenShift Container Platform installation, instance, or cluster as an "OpenShift deployment".

The API object for a deployment can be either a Kubernetes-native Deployment object (which uses replication controllers) or an OpenShift-specific DeploymentConfig object (which uses replica sets).

Use it: yes

Incorrect forms: deployment configuration

See also: API objects

yes Dockerfile (noun)

Description: Docker can build images automatically by reading the instructions from a Dockerfile. A Dockerfile is a text document that contains all the commands you would normally execute manually in order to build a Docker image.

Use it: yes

Incorrect forms: dockerfile

See also:

yes endpoint (noun)

Description: The servers that back a service.

Use it: yes

Incorrect forms:

See also:

yes identity (noun)

Description: Both the user name and list of groups the user belongs to.

Use it: yes

Incorrect forms:

See also:

yes image (noun)

Description: An image is a pre-built, binary file that contains all of the necessary components to run a single container; a container is the working instantiation of an image. Additionally, an image defines certain information about how to interact with containers created from the image, such as what ports are exposed by the container. OpenShift Container Platform uses the same image format as Docker; existing Docker images can easily be used to build containers through OpenShift Container Platform. Additionally, OpenShift Container Platform provides a number of ways to build images, either from a Dockerfile or directly from source hosted in a Git repository.

Use it: yes

Incorrect forms:

See also:

yes image stream (noun)

Description: A series of Docker images identified by one or more tags. Image streams are capable of aggregating images from a variety of sources into a single view, including images stored in the integrated Docker repository of OpenShift Container Platform, images from external Docker registries, and other image streams. The API object for an image stream is ImageStream.

Use it: yes

Incorrect forms:

See also: image

yes init container (noun)

Description: A container that you can use to reorganize configuration scripts and binding code. An init container differs from a regular container in that it always runs to completion. Each init container must complete successfully before the next one is started. A pod can have init containers in addition to application containers.

Use it: yes

Incorrect forms:

See also:

yes installer-provisioned infrastructure (noun)

Description: If the installation program deploys and configures the infrastructure that the cluster runs on, it is an installer-provisioned infrastructure installation.

Use it: yes

Incorrect forms: IPI

See also:

yes kubelet (noun)

Description: The agent that controls a Kubernetes node. Each node runs a kubelet, which handles starting and stopping containers on a node, based on the required state defined by the master.

Use it: yes

Incorrect forms: Kubelet

See also:

yes Kubernetes master (noun)

Description: The Kubernetes-native equivalent to the OpenShift master. An OpenShift system runs OpenShift masters, not Kubernetes masters, and an OpenShift master provides a superset of the functionality of a Kubernetes master, so it is generally preferred to use the term OpenShift master.

Use it: yes

Incorrect forms:

See also: OpenShift master

yes label (noun)

Description: Objects used to organize, group, or select API objects. For example, pods are "tagged" with labels, and then services use label selectors to identify the pods they proxy to. This makes it possible for services to reference groups of pods, even treating pods with potentially different containers as related entities.

Use it: yes

Incorrect forms:

See also:

no minion (noun)

Description: Deprecated. Use node instead.

Use it: no

Incorrect forms:

See also: node

with caution namespace (noun)

Description: Typically synonymous with project in OpenShift parlance, which is preferred.

Use it: with caution

Incorrect forms:

See also: project

yes node (noun)

See node in the General Conventions part.

yes OKD (noun)

Description: The name of the open source, upstream project of OpenShift Container Platform (previously known as OpenShift Origin before August 3, 2018). OKD is a distribution of Kubernetes optimized for continuous application development and multitenant deployment. Officially, the initialism does not stand for anything.

Use it: yes

Incorrect forms: O.K.D., okd, OpenShift Kubernetes Distribution, OpenShift Origin

See also:

yes OpenShift (noun)

Description: The OpenShift product name should be paired with its product distribution or variant name whenever possible. For example:

  • OpenShift Container Platform

  • OpenShift Online

  • OpenShift Dedicated

  • OpenShift Kubernetes Engine

Previously, the upstream distribution was called OpenShift Origin, however it is now called OKD; use of the OpenShift Origin name is deprecated.

Avoid using the name "OpenShift" on its own when referring to something that applies to all distributions, as OKD does not have OpenShift in its name. However, the following components currently use "OpenShift" in the name and are allowed for use across all distribution documentation:

  • OpenShift Ansible Broker (deprecated in 4.2 / removed in 4.4)

  • OpenShift Pipeline

  • OpenShift SDN

Use it: yes, as described above

Incorrect forms:

See also: OKD

yes OpenShift CLI (noun)

Description: The oc tool is the command-line interface of OpenShift Container Platform 3 and 4.

Use it: yes

Incorrect forms:

See also:

yes OpenShift Container Registry (noun)

Description: The integrated container registry that is deployed as part of an OpenShift Container Platform installation. This container registry adds the ability to easily provision new image repositories. With OpenShift Container Registry users can automatically have a place for their builds to push the resulting images. OpenShift Container Platform has an installation option you can use to have the OpenShift Container Registry deployed, but with none of the other build options enabled.

Use it: yes

Incorrect forms:

yes OpenShift master (noun)

Description: Provides a REST endpoint for interacting with the system and manages the state of the system, ensuring that all containers expected to be running are actually running and that other requests such as builds and deployments are serviced. New deployments and configurations are created with the REST API, and the state of the system can be interrogated through this endpoint as well. An OpenShift master comprises the API server, scheduler, and SkyDNS.

Use it: yes

Incorrect forms:

no OpenShift Origin (noun)

Description: The previous name of the open source, upstream project of OpenShift Container Platform. This project has been renamed OKD.

Use it: no

Incorrect forms:

See also: OKD

yes Operator

See Operator in the General Conventions part.

yes pod (noun)

Description: Pods come from the Kubernetes concept of the same name. A pod is a set of one or more containers deployed together to act as if they are on a single host, sharing an internal IP, ports, and local storage. OpenShift Container Platform treats pods as immutable. Any changes to the underlying image, Pod configuration, or environment variable values, cause new pods to be created and phase out the existing pods. Being immutable also means that any state is not maintained between pods when they are recreated. The API object for a pod is Pod.

Use it: yes

Incorrect forms:

See also: container, API objects

yes project (noun)

Description: An OpenShift Container Platform project corresponds to a Kubernetes namespace. They organize and group objects in the system, such as services and deployments, as well as provide security policies specific to those resources.

Use it: yes

Incorrect forms:

See also: action

yes quick start (noun)

Description: Two types of quick starts exist in OpenShift Container Platform:

  • Quick starts that provide a guided tutorial in the web console.

  • Quick start templates that enable users to start creating new applications quickly.

Ensure that you provide context about which type of quick start you are referring to.

Use it: yes

Incorrect forms: quickstart, Quickstart

See also:

yes Red Hat OpenShift Cluster Manager (noun)

Description: A managed service for Red Hat OpenShift that lets users create, subscribe, and manage different types of OpenShift clusters from a single user interface. After the first mention, you can use OpenShift Cluster Manager. OpenShift Cluster Manager is part of the Red Hat Hybrid Cloud Console.

Use it: yes

Incorrect forms: OCM, Cluster Manager, the OpenShift Cluster Manager, the OpenShift Cluster Manager site

See also:

yes Red Hat OpenShift Container Platform (noun)

Description: A Red Hat private, on-premise cloud application deployment and hosting platform.

Use it: yes

Incorrect forms: OpenShift, OpenShift CP, Openshift, OCP

See also:

yes Red Hat OpenShift Dedicated (noun)

Description: A Red Hat managed public cloud application deployment and hosting service.

Use it: yes

Incorrect forms: Openshift, OpenShift, OD, Dedicated

See also:

yes Red Hat OpenShift Online (noun)

Description: A Red Hat public cloud application deployment and hosting platform.

Use it: yes

Incorrect forms: Openshift, OpenShift, Openshift online, OO

See also:

yes replication controller (noun)

Description: A Kubernetes object that ensures a specified number of pods for an application are running at a given time. The replication controller automatically reacts to changes to deployed pods, both the removal of existing pods, for example, deletion or crashing, or the addition of extra pods that are not wanted. The pods are automatically added or removed from the service to ensure its uptime.

Use it: yes

Incorrect forms:

See also:

yes route (noun)

Description: A route exposes a service at a hostname, like www.example.com, so that external clients can reach it by name.

Use it: yes

Incorrect forms:

See also:

yes scheduler (noun)

Description: Component of the Kubernetes master or OpenShift master 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.

Use it: yes

Incorrect forms:

See also:

yes service (noun)

Description: 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

Incorrect forms:

See also:

yes SkyDNS (noun)

Description: A component of the Kubernetes master or OpenShift master that provides cluster-wide DNS resolution of internal hostnames for services and pods.

Use it: yes

Incorrect forms:

See also:

yes Source-to-Image (S2I) (noun)

Description: 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.

Use it: yes

Incorrect forms: STI, source to image

See also:

yes spec (noun)

Description: In addition to "spec file", which is permitted when it relates to RPM spec files, you can also use "spec" for general usage when you describe Kubernetes or OpenShift Container Platform object specs, manifests, or definitions.

Example of correct usage:

Update the Pod spec to reflect the changes.

Use it: yes

Incorrect forms: Spec

See also:

yes template (noun)

Description: A template describes a set of objects that can be parameterized and processed to produce a list of objects for creation by OpenShift Container Platform.

Use it: yes

Incorrect forms:

See also:

yes user-provisioned infrastructure (noun)

Description: If the user must deploy and configure separate virtual or physical hosts as part of the cluster deployment process, it is a user-provisioned infrastructure installation.

Use it: yes

Incorrect forms: UPI

See also:

yes verb (noun)

Description: A get, list, create, or update operation.

Use it: yes

Incorrect forms:

See also: action, project, resource

Red Hat OpenShift Container Storage

backing store (noun)

Description: A type of storage resource for Multicloud Object Gateway to store data, for example, from RADOS gateway (RGW), Amazon Web Services S3, Azure Blob Storage, IBM Cloud Object Storage.

Use it: yes

Incorrect forms:

See also:

Container Storage Interface (noun)

Description: The Container Storage Interface (CSI) is a standard for exposing arbitrary block and file storage systems to containerized workloads on Container Orchestration Systems like Kubernetes, and in particular Red Hat OpenShift Container Platform. This allows OpenShift Container Platform to consume storage from third-party storage providers that implement the CSI interface as persistent storage.

Use it: yes

Incorrect forms:

See also:

Multicloud Object Gateway (noun)

Description: Multicloud Object Gateway (MCG) is a lightweight object storage service for OpenShift Container Platform you can use to start with a small storage service and then scale according to your requirements on-premise, in multiple clusters, and with cloud-native storage.

Multicloud Object Gateway (MCG) is a lightweight object storage service for OpenShift Container Platform that you can use to start with a small storage service and then scale according to your requirements on-premise, in multiple clusters, and with cloud-native storage.

Use it: yes

Incorrect forms:

See also:

namespace bucket (noun)

Description: Namespace buckets enable connecting data repositories on different providers together so that the interaction with data is possible through a single unified view. Data written to namespace buckets are plain and not deduped, compressed, or encrypted. The data can be consumed directly from the repository.

Use it: yes

Incorrect forms:

See also:

namespace store (noun)

Description: A type of a resource for Multicloud Object Gateway that namespace buckets use to store plain data. The supported stores are Amazon Web Services (AWS) S3, Microsoft Azure, and AWS S3 compatible.

Use it: yes

Incorrect forms:

See also:

object bucket (noun)

Description: A container to store objects.

Use it: yes

Incorrect forms:

See also:

object bucket claim (noun)

Description: Creates a new bucket and an application account in Multicloud Object Gateway or RADOS Gateway (RGW) with permissions to the bucket, including a new access key and secret access key. You can use object bucket claim to request an AWS S3 compatible bucket for the workloads.

Use it: yes

Incorrect forms:

See also:

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.

Use it: yes

Incorrect forms:

See also:

persistent volume claim (noun)

Description: A persistent volume claim (PVC) is a request for storage by a user.

Use it: yes

Incorrect forms:

See also:

Red Hat OpenShift Container Storage (noun)

Description: Red Hat software-defined storage for containers that helps to develop and deploy applications quickly and efficiently across cloud platforms.

Use it: yes

Incorrect forms: OCS

See also:

Rook (noun)

Description: Rook is an orchestrator for multiple storage solutions, each with a specialized Kubernetes Operator to automate management.

Use it: yes

Incorrect forms:

See also:

Rook-Ceph Operator (noun)

Description: The Rook-Ceph Operator automates the packaging, deployment, management, upgrading, and scaling of persistent storage and file, block, and object services.

Use it: yes

Incorrect forms:

See also:

storage class (noun)

Description: Use storage classes to describe the types of storage a product offers. OpenShift Container Storage offers block, shared file system, and object classes.

Use it: yes

Incorrect forms:

See also:

Red Hat OpenStack Platform

Upstream references: OpenStack.org Glossary

For documentation questions, contact rhos-docs@redhat.com.

yes director (noun)

Description: The Red Hat OpenStack Platform (RHOSP) director is a toolset for installing and managing a complete OpenStack environment. Write in lowercase. For example: "Use director to create a RHOSP environment."

Use it: yes

Incorrect forms: The director, Director

See also:

yes instance (noun)

Description: An instance is a running virtual machine, or a virtual machine in a known state such as suspended, that can be used like a hardware server. Use the term "instance" instead of "virtual machine" unless specifically called out in the user interface or a configuration file.

Use it: yes

Incorrect forms:

See also:

yes OpenStack services (noun)

Description: For definitions of all upstream OpenStack services, see the OpenStack.org Glossary. The following RHOSP documentation conventions apply:

  • Use the component name instead of the code name. For example: "Block Storage" instead of "cinder". Exception: "heat templates" as opposed to "Orchestration service templates".

  • Write the component name in uppercase.

  • Write "service" in lowercase if the component name includes "service".

  • Write the code name in lowercase in parentheses after the component name, and after "service", on the first use of the component name in a module.

  • Include the word "OpenStack" before the component name only if necessary to differentiate from other product services.

Examples of correct usage: Networking service (neutron), Shared File Systems service (manila), Identity service, OpenStack Networking service.

Use it: yes

Incorrect forms: Block storage service, compute, Horizon

See also:

yes overcloud (noun)

Description: The overcloud is the resulting RHOSP environment that is created by using the undercloud. Write in lowercase.

Use it: yes

Incorrect forms: Overcloud

See also: undercloud

with caution Red Hat Enterprise Linux OpenStack Platform (noun)

Description: Spell out in full. This product name applies to Red Hat Enterprise Linux OpenStack Platform 7 and earlier versions.

Use it: with caution

Incorrect forms: RHELOSP, RHEL-OSP

yes Red Hat OpenStack Platform (noun)

Description: On first use in a module, use the complete product name and the abbreviation in parentheses: "Red Hat OpenStack Platform (RHOSP)". After the first instance, use "RHOSP". This product name applies to RHOSP version 8 and later. If you need to use the indefinite article before "RHOSP", use 'a' not 'an'.

Use it: yes

Incorrect forms: OpenStack Platform, RHOS, RH-OSP

yes undercloud (noun)

Description: The undercloud is the director node. It is a single-system within the RHOSP installation that includes components for provisioning and managing the RHOSP nodes that form your environment, known as the overcloud. Write in lowercase.

Use it: yes

Incorrect forms: Undercloud

See also: overcloud, node

Red Hat Satellite 6

For documentation questions, contact satellite-doc-list@redhat.com.

yes Capsule Server (noun)

Description: Capsule Server is an additional server that acts as a proxy to the Satellite and can provide services such as DHCP, DNS, and TFTP. Use the two-word name on first use in a section; the single term 'Capsule' is acceptable thereafter.

Use it: yes

Incorrect forms: Capsule server, capsule

See also:

yes Content View (noun)

Description: A Content View is a subset of Library content created by intelligent filtering. Use the two-word name in full on first use in a section; the abbreviation 'CV' is acceptable thereafter.

Use it: yes

Incorrect forms: Content view, content view

yes Composite Content View (noun)

Description: A Composite Content View is a collection of Content Views. Use the three-word name in full on first use in a section; the abbreviation 'CCV' is acceptable thereafter.

Use it: yes

Incorrect forms: Composite Content view, composite content view, Composite View, composite view

See also: Content View

yes Facter (noun)

Description: Facter is the Puppet system inventory tool.

Use it: yes

Incorrect forms: facter

See also:

yes Subscription Manifest (noun)

Description: A Subscription Manifest is a mechanism for transferring subscriptions from Red Hat Customer Portal to Red Hat Satellite 6. Use the two-word name in full on first use in a section; the word 'manifest' is acceptable thereafter.

Use it: yes

Incorrect forms: Subscription manifest

See also:

yes Puppet (noun)

Description: Puppet is a tool for applying and managing system configurations.

Use it: yes

Incorrect forms: puppet

See also:

no Puppetize (verb)

Description: To apply Puppet manifests and methods to a system. This is unnecessary industry jargon or slang.

Use it: no

Incorrect forms: puppetize

See also: Puppet

yes Puppet Forge (noun)

Description: Puppet Forge is a Puppet Labs Git repository for community supplied Puppet modules.

Use it: yes

Incorrect forms: puppet forge

See also:

yes Product (noun)

Description: A Red Hat Satellite Product is a collection of repositories.

Use it: yes

Incorrect forms: product

See also:

yes Satellite Server (noun)

Description: Satellite Server synchronizes the content from Red Hat Customer Portal and other sources, and provides life cycle management, user and group role-based access control, integrated subscription management, as well as GUI, CLI, and API access. It is the core component of Red Hat Satellite, the systems management tool for Linux-based infrastructure. Use the two-word name on first use in a section; the single term 'Satellite' is acceptable thereafter.

Use it: yes

Incorrect forms: Satellite server

See also:

with caution Foreman (noun)

Description: The upstream project from which the provisioning and life cycle management functions of Satellite Server are drawn. Use only when required to mention the upstream project. In Red Hat Virtualization, use Foreman/Satellite when referring directly to the UI element. Do not use Foreman or Foreman/Satellite to refer to Red Hat Satellite in other cases. A bug is open to get this element changed to Satellite. (BZ#1428205 Change Foreman/Satellite to Satellite)

Use it: with caution

Incorrect forms: foreman

See also:

with caution Katello (noun)

Description: The upstream project from which the subscription and repository management functions of Satellite Server are drawn. Use only when required to mention the upstream project.

Use it: with caution

Incorrect forms: katello

See also:

Red Hat Single Sign-On

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.

Use it: yes

Incorrect forms:

See also:

yes assertion

Description: An assertion provides information about a user. This usually pertains to an XML blob that is included in a SAML authentication response that provided identity metadata about an authenticated user.

Use it: yes

Incorrect forms:

See also:

yes authentication

Description: Authentication is the process of identifying and validating a user.

Use it: yes

Incorrect forms:

See also:

yes authentication flow

Description: An authentication flow is a workflow that a user must perform when interacting with certain aspects of the system. A login flow can define what credential types are required. A registration flow defines what profile information a user must enter and whether something like reCAPTCHA must be used to filter out bots. Credential reset flow defines what actions a user must take before they can reset their password.

Use it: yes

Incorrect forms:

See also:

yes client adapter

Description: Client adapters are libraries that make it easy to secure applications and services with Red Hat Single Sign-On. Red Hat Single Sign-On has a number of adapters for different platforms that you can download. There are also third-party adapters you can use for environments that Red Hat does not cover.

Use it: yes

Incorrect forms:

See also:

yes client role

Description: A client role is a role namespace that is dedicated to a client. Each client can define roles that are specific to it.

Use it: yes

Incorrect forms:

See also:

yes client scope

Description: When a client is registered, you must define protocol mappers and role scope mappings for that client. To simplify the task of creating clients, you might decide to store a client scope so that you can share some common settings. This is also useful for requesting some claims or roles to be conditionally based on the value of scope parameter. Red Hat Single Sign-On provides the concept of a client scope for this.

Use it: yes

Incorrect forms:

See also:

yes client

Description: A client is an entity that can request Red Hat Single Sign-On to authenticate a user. Most often, clients are applications and services that want to use Red 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 Hat Single Sign-On.

Use it: yes

Incorrect forms:

See also:

yes composite role

Description: A composite role is a role that can be associated with other roles. For example a superuser composite role can be associated with the sales-admin and order-entry-admin roles. If a user is mapped to the superuser role they also inherit the sales-admin and order-entry-admin roles.

Use it: yes

Incorrect forms:

See also:

Description: Consent is when you as an admin want a user to give permission to a client before that client can participate in the authentication process. After a user provides their credentials, Red Hat Single Sign-On opens a screen identifying the client requesting a login and what identity information is requested of the user. Users can decide whether or not to grant the request.

Use it: yes

Incorrect forms:

See also:

yes credentials

Description: Credentials are pieces of data that Red Hat Single Sign-On uses to verify the identity of a user. Some examples are passwords, one-time passwords, digital certificates, or even fingerprints.

Use it: yes

Incorrect forms:

See also:

yes direct grant

Description: A direct grant is a way for a client to obtain an access token on behalf of a user through a REST invocation.

Use it: yes

Incorrect forms:

See also:

yes event

Description: An event is an audit stream that administrators view and connect to.

Use it: yes

Incorrect forms:

See also:

yes group

Description: A group manages a collection of users. You can define attributes for a group. You can also map roles to a group. Users that become members of a group inherit the attributes and role mappings that group defines.

Use it: yes

Incorrect forms:

See also:

yes identity provider

Description: An identity provider (IDP) is a service that authenticates a user. Red Hat Single Sign-On is an IDP.

Use it: yes

Incorrect forms:

See also:

yes identity provider federation

Description: Red Hat Single Sign-On can be configured to delegate authentication to one or more IDPs. Social login through Facebook or Google+ is an example of identity provider federation. You can also hook Red Hat Single Sign-On to delegate authentication to any other OpenID Connect or SAML 2.0 IDP.

Use it: yes

Incorrect forms:

See also:

yes identity provider mappers

Description: When doing IDP federation, you can map incoming tokens and assertions to user and session attributes. This helps you propagate identity information from the external IDP to your client requesting authentication.

Use it: yes

Incorrect forms:

See also:

yes identity token

Description: An identity token provides identity information about the user and is part of the OpenID Connect specification.

Use it: yes

Incorrect forms:

See also:

yes protocol mapper

Description: For each client, you can tailor what claims and assertions are stored in the OIDC token or SAML assertion. You do this for each client by creating and configuring protocol mappers.

Use it: yes

Incorrect forms:

See also:

yes realm

Description: A realm manages a set of users, credentials, roles, and groups. A user belongs to and logs into a realm. Realms are isolated from one another and can only manage and authenticate the users that they control.

Use it: yes

Incorrect forms:

See also:

yes required action

Description: A required action is an action that a user must perform during the authentication process. A user cannot complete the authentication process until these actions are complete. For example, an admin might schedule users to reset their passwords every month. An update password required action is set for all these users.

Use it: yes

Incorrect forms:

See also:

yes role

Description: A role identifies a type or category of user. administrator, user, manager, and employee are all typical roles that might exist in an organization. Applications often assign access and permissions to specific roles rather than individual users because dealing with users can be too granular and hard to manage.

Use it: yes

Incorrect forms:

See also:

yes service account

Description: Each client has a built-in service account to obtain an access token.

Use it: yes

Incorrect forms:

See also:

yes session

Description: 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.

Use it: yes

Incorrect forms:

See also:

yes theme

Description: A theme defines HTML templates and stylesheets that you can override as you require. Every screen that Red Hat Single Sign-On provides is backed by a theme.

Use it: yes

Incorrect forms:

See also:

yes user federation provider

Description: Red Hat Single Sign-On can store and manage users. Often, companies already have LDAP or Active Directory services that store user and credential information. You can point Red Hat Single Sign-On to validate credentials from those external stores and pull in identity information.

Use it: yes

Incorrect forms:

See also:

yes user role mapping

Description: A user role mapping defines a mapping between a role and a user. A user can be associated with zero or more roles. This role mapping information can be encapsulated into tokens and assertions so that applications can decide access permissions on various resources they manage.

Use it: yes

Incorrect forms:

See also:

Red Hat Virtualization

For documentation questions, contact rhev-docs@redhat.com.

yes Administration Portal (noun)

Description: The Administration Portal is a graphical user interface provided by the Red Hat Virtualization Manager. It can be used to manage all the administrative resources in the environment and can be accessed by any supported web browser.

Always use "Administration Portal", including the capital P. When other departments (or upstream) use "webadmin" or "Administrator portal", this is what they are referring to.

Use it: yes

Incorrect forms: Admin Portal, webadmin, webadmin portal, Administrator Portal, Administration portal

See also:

yes Cockpit web interface (noun)

Description: Cockpit is a web-based server administration user interface, and is not exclusive to Red Hat Virtualization.

Use it: yes

Incorrect forms:

yes collect (verb)

Description: Use "collect" when discussing the Red Hat Virtualization log collector (ovirt-log-collector). Do not use "gather", which is reserved for discussing Red Hat Virtualization metrics. See the comments in BZ#1418659 Add fluentd configuration for parsing engine.log for the discussion regarding this decision.

Use it: yes

Incorrect forms: gather

See also: gather

yes Data Warehouse (noun)

Description: The Manager includes a comprehensive management history database, which any application can use to extract a range of information at the data center, cluster, and host levels. Installing Data Warehouse creates the ovirt_engine_history database, to which the Manager is configured to log information for reporting purposes.

Data Warehouse is mandatory in Red Hat Virtualization.

Always spell out in full and capitalize as shown here, unless part of a command. Use "Data Warehouse", not "the Data Warehouse", unless "Data Warehouse" functions as an adjective, for example, "the Data Warehouse package" or "the Data Warehouse service".

Use it: yes

Incorrect forms: DWH, data warehouse, Dataware House

See also: Monitoring Portal

yes details view (noun)

Description: The details view displays detailed information about a selected item.

Use it: yes

Incorrect forms: details pane

See also:

yes gather (verb)

Description: Use "gather" when discussing Red Hat Virtualization metrics. Do not use "collect", which is reserved for discussing the Red Hat Virtualization log collector (ovirt-log-collector). See the comments in BZ#1418659 Add fluentd configuration for parsing engine.log for the discussion regarding this decision.

Use it: yes

Incorrect forms: collect

See also: collect

yes header bar (noun)

Description: The header bar contains the following buttons: * collapse/expand text labels in the side bar

  • Bookmarks

  • Tags

  • Tasks

  • Events and alerts

  • Help/About

  • Currently logged in user, SSH key Options.

Use it: yes

Incorrect forms: title bar

See also:

yes host (noun)

Description: Hosts are servers that provide the processing capabilities and memory resources used to run virtual machines. There are two types of hosts: Red Hat Enterprise Linux host and Red Hat Virtualization Host. Use "host" to refer to hosts in general, not "hypervisor", "hypervisor host", or "virtualization host". When referring to a specific type of host, use "Red Hat Enterprise Linux host" or "Red Hat Virtualization Host".

Use it: yes

Incorrect forms: hypervisor, hypervisor host, virtualization host

yes LUN (noun)

Description: A LUN (logical unit number) is a number used to identify a logical unit, which is a device addressed by the SCSI protocol, or Storage Area Network protocols which encapsulate SCSI, such as Fibre Channel or iSCSI.

Always capitalize as shown, with the exception of UI content.

Use it: yes

Incorrect forms: Lun, lun

See also:

yes Manager virtual machine (noun)

Description: "Manager virtual machine" refers specifically to the virtual machine created during self-hosted engine deployment. Use this term when referring to the machine (for example, "Log in to the Manager virtual machine"); the Manager itself can still be referred to as such (for example, "Add a host to the Manager").

Use it: yes

Incorrect forms: self-hosted engine virtual machine, engine VM

See also: self-hosted engine

yes MOM (noun)

Description: The Memory Overcommitment Manager is a policy-driven tool that can be used to manage overcommitment on hosts.

Use "Memory Overcommitment Manager (MOM)" for the first instance in a section, and "MOM" for subsequent instances.

Use it: yes

Incorrect forms: MoM, Mom, mom

See also:

yes Monitoring Portal (noun)

Description: The Monitoring Portal is a graphical user interface used to display reports based on data collected from the Data Warehouse PostgreSQL database. The Monitoring Portal is implemented by using the Grafana web-based UI tool to display the reports as dashboards.

Use it: yes

Incorrect forms:

See also: Data Warehouse

yes Red Hat Enterprise Linux host (noun)

Description: You can use Red Hat Enterprise Linux servers that are subscribed to the appropriate entitlements as hosts in Red Hat Virtualization.

Always spell out the full product name of the host, and do not capitalize the term "host". Use it: yes

Incorrect forms: RHEL host, RHEL-H

See also: host

yes Red Hat Virtualization (noun)

Description: Red Hat Virtualization is an enterprise-grade server and desktop virtualization platform built on Red Hat Enterprise Linux.

Use "Red Hat Virtualization". Always spell out in full, except as part of "RHVH" or when repetition in a single paragraph hampers readability.

Use it: yes

Incorrect forms: RHV

yes Red Hat Virtualization Host (noun)

Description: Red Hat Virtualization Host is the host in Red Hat Virtualization. It is a minimal operating system based on Red Hat Enterprise Linux, is distributed as an ISO file from the Customer Portal, and contains only the packages required for the machine to act as a host.

Use "Red Hat Virtualization Host (RHVH)" for the first instance in a section. You can use "RHVH" in subsequent instances. Do not use "the Host" or capitalize the term "host" when it is not used with the full product name..

Use it: yes

Incorrect forms: RHV-H, Red Hat Virtualization Hypervisor, RHV Host, the Host

See also: host

yes Red Hat Virtualization Manager (noun)

Description: The Red Hat Virtualization Manager is a server that manages and provides access to the resources in the Red Hat Virtualization environment.

Use "Red Hat Virtualization Manager". Spell out in full for the first instance in a section. Use "the Manager" for subsequent instances. Do not use "the engine", which is the oVirt (upstream) term.

Use it: yes

Incorrect forms: RHVM, RHV-M, RHV Manager, engine

See also:

yes resource tab (noun)

Description: Hosts, virtual machines, storage, and other resources in Red Hat Virtualization can be managed by using their associated tab.

Use the name of the tab when you refer to it, for example, "the Storage tab".

Use it: yes

Incorrect forms:

See also:

yes results list (noun)

Description: The results list shows the resources managed under each resource tab. For example, the results list for the Hosts tab shows all hosts attached to the Red Hat Virtualization Manager.

Use it: yes

Incorrect forms:

See also: resource tab

yes self-hosted engine (noun)

Description: A self-hosted engine is a virtualized environment in which the Manager, or engine, runs on a virtual machine on the hosts managed by that Manager. The virtual machine is created as part of the host configuration, and the Manager is installed and configured in parallel to the host configuration process.

Use all lower case, unless used in a title or at the beginning of a sentence.

Use it: yes

Incorrect forms: hosted engine, hosted-engine

yes self-hosted engine node (noun)

Description: A self-hosted engine is a virtualized environment in which the Manager, or engine, runs on a virtual machine on the hosts managed by that Manager. A self-hosted engine node is a host that has self-hosted engine packages installed so that it can host the Manager virtual machine. Regular hosts can also be attached to a self-hosted engine environment, but cannot host the Manager virtual machine.

Use all lower case, unless used in a title or at the beginning of a sentence.

Use it: yes

Incorrect forms: hosted engine host, hosted-engine host, self-hosted engine host, hosted engine node, hosted-engine node

See also: self-hosted engine

yes sparse (adjective)

Description: A disk is sparse when its unused disk space is taken from the virtual machine and returned to the host. In the past, the term sparse has been used to describe thin provisioned storage; however, with the addition of the sparsify feature in Red Hat Virtualization 4.1, these terms should not be used interchangeably as a thin provisioned disk might not be a sparse disk.

Use it: yes

Incorrect forms:

yes sparsify (verb)

Description: To take unused disk space from a virtual machine and return it to the host.

Use it: yes

Incorrect forms:

See also: sparse

yes SPICE (noun)

Description: SPICE stands for "Simple Protocol for Independent Computing Environments". It is a remote connection protocol for viewing a virtual machine in a graphical console from a remote client.

Always capitalize as shown, except in commands, packages, or UI content.

Use it: yes

Incorrect forms: Spice, spice

See also:

yes standalone Manager (noun)

Description: Use "Standalone Manager" specifically, and only, in the context of differentiating between a "regular" Red Hat Virtualization environment and a self-hosted engine environment. Use "the Red Hat Virtualization Manager" or "the Manager" in all other cases. See the Red Hat Virtualization Product Guide for details.

Use it: yes

Incorrect forms: standard Manager, standard environment

yes Storage Pool Manager (noun)

Description: The Storage Pool Manager (SPM) is a role given to one of the hosts in a data center, enabling it to manage the storage domains of the data center.

Use "Storage Pool Manager (SPM)" for the first instance in a section, and "SPM" for subsequent instances.

Use it: yes

Incorrect forms:

See also:

yes sub-version (noun)

Description: A template sub-version is a new template version created from an existing template.

Use it: yes

Incorrect forms: sub version, subversion

See also:

yes sysprep (noun)

Description: Sysprep is a tool that automates the configuration of Windows virtual machines. Red Hat Virtualization enhances Sysprep by building a tailored auto-answer file for each virtual machine.

With the exception of "sysprep file", which has a specific function, use "sysprep" on its own when referring to the tool.

Use it: yes

Incorrect forms: sysprep tool, sysprep process, sysprep function

See also:

yes VM Portal (noun)

Description: The VM Portal is a graphical user interface provided by the Red Hat Virtualization Manager. It has limited permissions for managing virtual machine resources and is targeted at end users.

Always use "VM Portal" and capitalize the product name.

Use it: yes

Incorrect forms: VM portal, vm portal, Virtual Machine Portal, User Portal