Skip to content

improve CRD schema descriptions for kubectl explain usability #4383

@lhajouji

Description

@lhajouji

Summary

When using kubectl explain on Argo Rollouts resources like AnalysisRun or Rollout, most fields — especially spec and status — have no description or very minimal info. This makes it hard to understand what each field does without checking the docs or source code.

It would be great to add proper descriptions in the Go structs so that the CRD schema provides more useful output through kubectl explain.

Use Cases

  • Get quick help directly in the terminal without switching to docs
  • Make it easier for new users to understand the structure of Argo Rollouts objects
  • Improve clarity for teams writing manifests or automating deployments

Message from the maintainers:

Impacted by this bug? Give it a 👍. We prioritize the issues with the most 👍.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions