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

Improve CRD documentation (kubectl explain) #2439

Closed
weyfonk opened this issue May 17, 2024 · 1 comment
Closed

Improve CRD documentation (kubectl explain) #2439

weyfonk opened this issue May 17, 2024 · 1 comment

Comments

@weyfonk
Copy link
Contributor

weyfonk commented May 17, 2024

While Fleet CRDs are documented here, it is much more convenient to many users to be able to view information about a resource and its fields using kubectl explain.

We should ensure that the output of that command is as complete as possible for Fleet CRDs.
Some of the work is done, but some field types and resource descriptions are missing, eg:

$ kc explain bundle.spec
KIND:     Bundle                                                    
VERSION:  fleet.cattle.io/v1alpha1                                                                                                      
                                                                    
RESOURCE: spec <Object>                                             
                                                                    
DESCRIPTION:                                                                                                                            
     <empty>                                                        

FIELDS:                                                             
   correctDrift <Object>                                                                                                                
     CorrectDrift specifies how drift correction should work.

   defaultNamespace     <>                                          
     DefaultNamespace is the namespace to use for resources that do not specify
     a namespace. This field is not used to enforce or lock down the deployment
     to a specific namespace.                                       

   deleteCRDResources   <boolean>                                   
     DeleteCRDResources deletes CRDs. Warning! this will also delete all your
     Custom Resources.                                              

   deleteNamespace      <boolean>                                   
     DeleteNamespace can be used to delete the deployed namespace when removing
     the bundle                                                     

   dependsOn    <>                                                  
     DependsOn refers to the bundles which must be ready before this bundle can
     be deployed.                                                   
[...]
@manno
Copy link
Member

manno commented May 22, 2024

Description for spec and status can be empty if the resource has a description.
For 0.10-rc I can also see types for all fields in bundle.

Please re-open if any public resources are missing descriptions for their fields.

@manno manno closed this as completed May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

No branches or pull requests

2 participants