Add to README #220
Add to README #220
Conversation
README.md
Outdated
| ```golang | ||
| controllergen.Run(args.Options{ | ||
| OutputPackage: "github.com/rancher/rancher/pkg/generated", | ||
| Boilerplate: "scripts/boilerplate.go.txt", | ||
| Groups: map[string]args.Group{ | ||
| "management.cattle.io": { | ||
| PackageName: "management.cattle.io", | ||
| Types: []interface{}{ | ||
| // All structs with an embedded ObjectMeta field will be picked up | ||
| "./pkg/apis/management.cattle.io/v3", | ||
| v3.ProjectCatalog{}, | ||
| v3.ClusterCatalog{}, | ||
| }, | ||
| GenerateTypes: true, | ||
| }, | ||
| "ui.cattle.io": { | ||
| PackageName: "ui.cattle.io", | ||
| Types: []interface{}{ | ||
| "./pkg/apis/ui.cattle.io/v1", | ||
| }, | ||
| GenerateTypes: true, | ||
| }, | ||
| }, | ||
| }) | ||
| ``` |
There was a problem hiding this comment.
It would be helpful to add comments on member variables in this piece of code so that someone looking at this for the first time understands what each piece is being used for?
If no comments are added here, then a link to the struct in code with comments should be added.
There was a problem hiding this comment.
Do you mean in options or the catalog structs?
There was a problem hiding this comment.
Maybe both? comments for the args.Options, but now I am curious about where the embedded Catalog structs are defined. Were they generated beforehand somehow? Or can these structs be any struct that has an embedded k8s.io/apimachinery/pkg/apis/meta/v1.ObjectMeta struct?
| ```golang | |
| controllergen.Run(args.Options{ | |
| OutputPackage: "github.com/rancher/rancher/pkg/generated", | |
| Boilerplate: "scripts/boilerplate.go.txt", | |
| Groups: map[string]args.Group{ | |
| "management.cattle.io": { | |
| PackageName: "management.cattle.io", | |
| Types: []interface{}{ | |
| // All structs with an embedded ObjectMeta field will be picked up | |
| "./pkg/apis/management.cattle.io/v3", | |
| v3.ProjectCatalog{}, | |
| v3.ClusterCatalog{}, | |
| }, | |
| GenerateTypes: true, | |
| }, | |
| "ui.cattle.io": { | |
| PackageName: "ui.cattle.io", | |
| Types: []interface{}{ | |
| "./pkg/apis/ui.cattle.io/v1", | |
| }, | |
| GenerateTypes: true, | |
| }, | |
| }, | |
| }) | |
| ``` | |
| ```golang | |
| controllergen.Run(args.Options{ | |
| // Location to store generated packages. | |
| OutputPackage: "github.com/rancher/rancher/pkg/generated", | |
| // Whatever Boilerplate is. | |
| Boilerplate: "scripts/boilerplate.go.txt", | |
| // Things you want to generate. Is the key always the APIGroup. | |
| Groups: map[string]args.Group{ | |
| "management.cattle.io": { | |
| // Does this have to match the APIGroup? | |
| PackageName: "management.cattle.io", | |
| // List of string package names or structs? can they be pointers? | |
| Types: []interface{}{ | |
| // All structs with an embedded ObjectMeta field will be picked up | |
| "./pkg/apis/management.cattle.io/v3", | |
| v3.ProjectCatalog{}, | |
| v3.ClusterCatalog{}, | |
| }, | |
| // What gets generated if this is false? | |
| GenerateTypes: true, | |
| }, | |
| "ui.cattle.io": { | |
| PackageName: "ui.cattle.io", | |
| Types: []interface{}{ | |
| "./pkg/apis/ui.cattle.io/v1", | |
| }, | |
| GenerateTypes: true, | |
| }, | |
| }, | |
| }) |
There was a problem hiding this comment.
It's the latter. The Catalog is generated above since it is in the named package and directly has the ObjectMeta field. The ClusterCatalog and ProjectCatalog types are explicitly named because they don't directly have the ObjectMeta field and instead embed a struct that does. They are both basically namespaced versions of the Catalog type. I have added explanations for this and provided an additional example for a simpler type.
|
Related to #205 |
README.md
Outdated
|
|
||
| ## Useful Definitions: | ||
| ### factory: | ||
| Controllers are categorized by their API group and bundled into a struct called a factory. |
There was a problem hiding this comment.
The factory is used for generating controllers, right?
There was a problem hiding this comment.
I have updated this comment multiple times as I've revised the definition to add more detail here as I think the current explanation isn't sufficient. I have updated it to better explain what "factory" is referring to and what they do. Lmk what your thoughts on the change and if it clarifies anything.
README.md
Outdated
| Watch(namespace string, opts metav1.ListOptions) (watch.Interface, error) | ||
| // Patch will create or updates the given object. Patch type specifies the how the data is structured, i.e. json |
There was a problem hiding this comment.
I think this is conditionally true. If the patch type is application/apply-patch+yaml, then yes. The second part about patch type is incorrect though. I've updated to give a more general description of patch, fixed the inaccuracy, and provided some additional documentation links since this is a more complicated method which does not seem well understood by the Kubernetes community in general.
rmweir
force-pushed
the
add-docs
branch
2 times, most recently
from
de86f07 to
5cf5062
Compare
No description provided.