Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ClusterOutput attributes enabledNamespaces and protected are undocumented #1900

Open
christopher-demarco opened this issue Jan 2, 2025 · 0 comments
Labels
bug Something isn't working documentation
Milestone

Comments

@christopher-demarco
Copy link

christopher-demarco commented Jan 2, 2025

Describe the bug:

ClusterOutput.spec.enabledNamespaces is completely undocumented:

  • The CRD contains no description.
  • The docs site does not contain that string except in the rendered CRDs, with no commentary.
  • The codebase itself contains no comments.

ClusterOutput.spec.protected is not adequately documented:

  • The CRD contains no description.
  • The codebase contains no comments, although it is possible to determine its function by reading the code.
  • The docs site only mentions the attribute in a "What's New" announcement.

Moreover, it appears that enabledNamespaces is not even used by the operator; I could only find it being declared in the CRD/schema specs. If it is truly unused, it should be removed from the CRD.

Expected behaviour:

The CRD should ship with descriptions of what the attributes actually do.

The documentation should include descriptions of what the attributes actually do.

Non-function attributes should either be noted as such, or removed.

Steps to reproduce the bug:

N/A

Additional context:

My use case for noticing this was that I'm hoping to find a way to constrain access on a ClusterFlow to only a subset of Flows; the names of these attributes suggest that they might be applicable.

Environment details:

N/A

/kind bug

@christopher-demarco christopher-demarco added the bug Something isn't working label Jan 2, 2025
@pepov pepov modified the milestones: 5.x, 5.0 Jan 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation
Projects
None yet
Development

No branches or pull requests

3 participants