Skip to content

Annotate fields with dots and other unusual characters in the name #14

@NickVolynkin

Description

@NickVolynkin

Sometimes we have complex field names in values.yaml.
There should be a way to annotate such fields.

packages/apps/tenant/values.yaml, showing two possible options to define nvidia.com/gpu as a field name.

## @param resourceQuotas {resourceQuotas} Define resource quotas for the tenant
## @field resourceQuotas."nvidia.com/gpu" {quantity} GPU quota
## @field resourceQuotas[nvidia.com/gpu] {quantity} GPU quota
# resourceQuotas:
#   nvidia.com/gpu: 4
resourceQuotas: {}

packages/apps/kafka/values.yaml, see topics.[i].config.*

## @section Application-specific parameters
##
## @param topics {[]topic} Topics configuration
## @field topic {topic} Topic
## @field topic.name {string} Topic name
## @field topic.partitions {int} Number of partitions
## @field topic.replicas {int} Number of replicas
## @field topic.config {[]value} Topic configuration
## Example:
## topics:
##   - name: Results
##     partitions: 1
##     replicas: 3
##     config:
##       min.insync.replicas: 2
##   - name: Orders
##     config:
##       cleanup.policy: compact
##       segment.ms: 3600000
##       max.compaction.lag.ms: 5400000
##       min.insync.replicas: 2
##     partitions: 1
##     replicas: 3
##
topics: []

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions