Skip to content

Multiline descriptions are malformed when accessed using kubectl get #189

@g-awmalik

Description

@g-awmalik

Quite a few ContraintTemplates have descriptions in multi-line formart e.g. K8sPodDisruptionBudget:

"Disallow the following scenarios when deploying PodDisruptionBudgets or resources that implement the replica subresource (e.g. Deployment, ReplicationController, ReplicaSet, StatefulSet):
1. Deployment of PodDisruptionBudgets with .spec.maxUnavailable == 0
2. Deployment of PodDisruptionBudgets with .spec.minAvailable == .spec.replicas of the resource with replica subresource
This will prevent PodDisruptionBudgets from blocking voluntary disruptions such as node draining.

  https://kubernetes.io/docs/concepts/workloads/pods/disruptions/"

When viewed using kubectl get this shows up as:

"Disallow the following scenarios when deploying PodDisruptionBudgets or resources that implement the replica subresource (e.g. Deployment, ReplicationController, ReplicaSet, StatefulSet): 1. Deployment of PodDisruptionBudgets with .spec.maxUnavailable == 0 2. Deployment of PodDisruptionBudgets with .spec.minAvailable == .spec.replicas of the resource with replica subresource This will prevent PodDisruptionBudgets from blocking voluntary disruptions such as node draining. https://kubernetes.io/docs/concepts/workloads/pods/disruptions/"

As evident here, the multiline format is not honored. I'd like to propose redoing the descriptions so they're single-lined and are readable when using kubectl get.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions