Check API for optional vs required for next revision

sivchari commented 4 months ago

This issue is similar with https://github.com/kubernetes-sigs/cluster-api/issues/6416 I listed the fields that we should discuss about which the data type is better for each field for next revision.

I listed the field that is optional, but the type isn't pointer or that isn't optional, but the type is pointer. ref: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#optional-vs-required

They have the +optional comment tag in Go. They are a pointer type in the Go definition (e.g. AwesomeFlag *SomeFlag) or have a built-in nil value (e.g. maps and slices). The API server should allow POSTing and PUTing a resource with this field unset.

Sorry if this is too delicated for the community, but I think it should do it to be good stable API because.

Thanks.

ClusterSpec

[ ] .ClusterNetwork.ServiceDomain
[ ] .Topology.Controlplane
[ ] .Topology.Controlplane.Metadata
[ ] .Topology.Workers.MachineDeployments.Metadata
[ ] .Topology.Workers.MachinePools.Metadata
[ ] .Topology.Variables.DefinitionFrom

ClusterStatus

[ ] .FailureDomains
[ ] .FailureDomains.ControlPlane
[ ] .FailureDomains.Attributes
[ ] .Phase
[ ] .InfrastructureReady
[ ] .ControlPlaneReady
[ ] .Conditions
[ ] .ObservedGeneration

ClusterClassSpec

[ ] .Infrastructure
[ ] .ControlPlane
[ ] .ControlPlane.Metadata
[ ] .Workers
[ ] .Workers.MachineDeployments.MinReadySeconds
[ ] .Workers.MachineDeployments.Strategy
[ ] .Workers.MachineDeployments.Template.Metadata
[ ] .Workers.MachinePools.MinReadySeconds
[ ] .Workers.MachinePools.Template.Metadata
[ ] .Variables..Metadata
[ ] .Patches.Example
[ ] .Patches.UniqueItems
[ ] .Patches.Format
[ ] .Patches.Pattern
[ ] .Patches.ExclusiveMaximum
[ ] .Patches.ExclusiveMinimum
[ ] .Patches.XPreserveUnknownFields
[ ] .Patches.XValidations.Message
[ ] .Patches.XValidations.MessageExpression
[ ] .Patches.XValidations.Reason
[ ] .Patches.XValidations.FieldPath
[ ] .PatchesDefinitions.Selector.MatchResources.ControlPlane
[ ] .PatchesDefinitions.Selector.MatchResources.InfrastructureCluster

ClusterClassStatus

[ ] .Conditions
[ ] ObservedGeneration
[ ] .Variables.DefinitionsConflict
[ ] .Variables.Definitions.Metadata

MachineStatus

[ ] .Addresses
[ ] .Phase
[ ] .BootstrapReady
[ ] .InfrastructureReady
[ ] .ObservedGeneration
[ ] .Conditions

MachineDeploymentSpec

[ ] .Paused
[ ] .Strategy.Type

MachineDeploymentStatus

[ ] .ObservedGeneration
[ ] .Selector
[ ] .Replicas
[ ] .UpdatedReplicas
[ ] .ReadyReplicas
[ ] .AvailableReplicas
[ ] .UnavailableReplicas
[ ] .Phase
[ ] .Conditions

MachineHealthCheckStatus

[ ] .ExpectedMachines
[ ] .CurrentHealthy
[ ] .RemediationsAllowed
[ ] .ObservedGeneration
[ ] .Conditions

MachineSetSpec

[ ] .MinReadySeconds
[ ] .DeletePolicy
[ ] .Template
[ ] .Template.ObjectMeta
[ ] .Template.Spec

MachineSetStatus

[ ] .Selector
[ ] .Replicas
[ ] .FullyLabeledReplicas
[ ] .ReadyReplicas
[ ] .AvailableReplicas
[ ] .ObservedGeneration
[ ] .Conditions

KubeadmConfigSpec

[ ] .ClusterConfiguration.Etcd
[ ] .ClusterConfiguration.Etcd.Local.DataDir
[ ] .ClusterConfiguration.Etcd.Local.ExtraArgs
[ ] .ClusterConfiguration.Networking
[ ] .ClusterConfiguration.Networking.ServiceSubnet
[ ] .ClusterConfiguration.Networking.PodSubnet
[ ] ..ClusterConfiguration.Networking.DNSDomain
[ ] ..ClusterConfiguration.KubernetesVersion
[ ] .ClusterConfiguration.ControlPlaneEndpoint
[ ] .ClusterConfiguration.APIServer
[ ] .ClusterConfiguration.APIServer.ControlPlaneComponent.ExtraVolumes.ReadyOnly
[ ] .ClusterConfiguration.APIServer.ControlPlaneComponent.ExtraVolumes.PathType
[ ] .ClusterConfiguration.ControllerManager
[ ] .ClusterConfiguration.Scheduler
[ ] .ClusterConfiguration.DNS
[ ] .ClusterConfiguration.CertificatesDir
[ ] .ClusterConfiguration.ImageRepository
[ ] .ClusterConfiguration.ClusterName
[ ] .InitConfiguration.BootstrapTokens.Token
[ ] .InitConfiguration.BootstrapTokens.Description
[ ] .InitConfiguration.NodeRegistration
[ ] .InitConfiguration.NodeRegistration.Name
[ ] .InitConfiguration.NodeRegistration.CRISocket
[ ] .InitConfiguration.NodeRegistration.ImagePullPolicy
[ ] .InitConfiguration.LocalAPIEndpoint.AdvertiseAddress
[ ] .InitConfiguration.LocalAPIEndpoint.BindPort
[ ] .InitConfiguration.Patches.Directory
[ ] .JoinConfiguration.NodeRegistration
[ ] .JoinConfiguration.CACertPath
[ ] .JoinConfiguration.Discovery.BootstrapToken.APIServerEndpoint
[ ] .JoinConfiguration.Discovery.BootstrapToken.UnsageSkipCAVerification
[ ] .JoinConfiguration.Discovery.File.KubeConfig.Server
[ ] .JoinConfiguration.Discovery.File.KubeConfig.TLSServerName
[ ] .JoinConfiguration.Discovery.File.KubeConfig.InsecureSkipTLSVerify
[ ] .JoinConfiguration.Discovery.File.KubeConfig.ProxyURL
[ ] .JoinConfiguration.Discovery.TLSBootstrapToken
[ ] .JoinConfiguration.ControlPlane.LocalEndpoint
[ ] JoinConfiguration.SkipPhases
[ ] .Files.Owner
[ ] .Files.Permissions
[ ] .Files.Encoding
[ ] .Files.Append
[ ] .Fiels.Content
[ ] .Format
[ ] .Ignition.ContainerLinuxConfig.AdditionalConfig
[ ] .Ignition.ContainerLinuxConfig.Strict

KubeadmConfigStatus

[ ] .Ready
[ ] .DataSecretName
[ ] .FailureReason
[ ] .FailureMessage
[ ] .ObservedGeneration
[ ] .Conditions

KubeadmControlPlaneSpec

[ ] .MachineTemplate.ObjectMeta
[ ] .RolloutStrategy.Type
[ ] .RemediationStrategy.RetryPeriod

KubeadmControlPlaneStatus

[ ] .Selector
[ ] .Replicas
[ ] .UpdatedReplicas
[ ] .ReadyReplicas
[ ] .UnavailableReplicas
[ ] .Initialized
[ ] .Body
[ ] .FailureReason
[ ] .ObservedGeneration
[ ] .Conditions

KubeadmControlPlaneTemplateSpec

[ ] .Template.ObjectMeta
[ ] .Template.Spec.MachineTemplate.ObjectMeta

k8s-ci-robot commented 4 months ago

This issue is currently awaiting triage.

If CAPI contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.

fabriziopandini commented 4 months ago

We have to take a closer look Some time ago we even considered to implement a linter to enforce some rules about optional vs required. But first we need to figure out if the rules defined in API conventions apply to CRDs / To CAPI (we found some nuances in the past)

k8s-triage-robot commented 1 month ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue as fresh with /remove-lifecycle stale
Close this issue with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot commented 1 day ago

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues.

This bot triages un-triaged issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue as fresh with /remove-lifecycle rotten
Close this issue with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

kubernetes-sigs / cluster-api