Skip to content

Incorrect Descriptions for max and min Resource Fields in YAML Schema #2

@RajivBB

Description

@RajivBB

Description:

The current descriptions for the max and min resource fields in the YAML schema are misleading and logically inverted. These fields describe resource limits for containers, but the descriptions currently conflict with their actual functionality.

Current Behavior

  • max description:
description: Maximum allowed resource a container can request or limit. Cannot be assigned below this.

This description incorrectly suggests that the resource cannot be assigned below the maximum value, which conflicts with the definition of a "maximum" limit.

  • min description:
description: Smallest allowed resource a container can request or limit. Cannot be assigned above this.

This description incorrectly suggests that the resource cannot be assigned above the minimum value, which contradicts the purpose of a "minimum" value.

Expected Behavior

  • max description should clarify that the resource cannot be assigned above this value:
description: Maximum allowed resource a container can request or limit. Cannot be assigned above this.
  • min description should clarify that the resource cannot be assigned below this value:
description: Smallest allowed resource a container can request or limit. Cannot be assigned below this.

Suggested Fix

  • Update the max description to:
description: Maximum allowed resource a container can request or limit. Cannot be assigned above this.
  • Update the min description to:
description: Smallest allowed resource a container can request or limit. Cannot be assigned below this.

Metadata

Metadata

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions