docs: update go structs with updated format for docgen #8198
Conversation
|
|
I think this need to be planned properly with exact ideas on what is going to be dropped, moved, removed, etc. Can we do it with more transitional changes and less breaking changes? How it's going to look in the end and so on. So far it won't pass the CI even. |
This is a draft so I don't expect it to pass just yet. I posted in our private Slack I would like to discuss this week. This is just here in the form it is now to help illustrate the changes so we can have a more meaningful discussion. |
andrewrynhard
force-pushed
the
docs
branch
2 times, most recently
from
eb16550 to
0b24336
Compare
|
Picking this back up finally. Not ready for review yet but I want to use CI for testing. I plan on basing other PRs off of this one and going through a series of PRs that we can get aligned and push through. |
andrewrynhard
force-pushed
the
docs
branch
2 times, most recently
from
a23d5cc to
24b7ef6
Compare
|
Not ready for review. Using CI to test. |
andrewrynhard
force-pushed
the
docs
branch
17 times, most recently
from
39a6532 to
82b5b14
Compare
andrewrynhard
force-pushed
the
docs
branch
3 times, most recently
from
0d279b8 to
57e68c8
Compare
|
This PR is stale because it has been open 45 days with no activity. |
Updates Go types for compatibility with an external implementation of docgen. Signed-off-by: Andrew Rynhard <[email protected]>
| @@ -195,7 +195,7 @@ func (in *Input) init() ([]config.Document, error) { | |||
| cluster.AllowSchedulingOnControlPlanes = pointer.To(in.Options.AllowSchedulingOnControlPlanes) | |||
| } else { | |||
| // backwards compatibility for Talos versions older than 1.2 | |||
| cluster.AllowSchedulingOnMasters = pointer.To(in.Options.AllowSchedulingOnControlPlanes) //nolint:staticcheck | |||
| cluster.AllowSchedulingOnMasters = pointer.To(in.Options.AllowSchedulingOnControlPlanes) | |||
There was a problem hiding this comment.
this is a regression - the field was deprecated, and should stay so to avoid accidental use
| // Specifies the machine's role within the cluster. The roles can be either "controlplane" or "worker". | ||
| // The "controlplane" role hosts etcd and the Kubernetes control plane components such as API Server, Controller Manager, Scheduler. | ||
| // The "worker" role is available for scheduling workloads. | ||
| MachineType string `yaml:"type" docgen:"{'values':['controlplane','worker'],'in':'1.5'}"` |
There was a problem hiding this comment.
not sure what in means, but this field was there forever, not since Talos 1.5
|
@smira This PR is a draft as I work out some things with the framework. You can ignore this PR for now. I will mark this as ready for review when the time comes. Thanks. |
No description provided.