Skip to content

OTA-1531: [1/x] cvo: refactor option processing #1184

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 6, 2025
Merged

OTA-1531: [1/x] cvo: refactor option processing #1184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a37ab26
cvo: separate option validation and cvo execution
petr-muller Apr 29, 2025
40257c9
cvo: refactor always enabled caps processing
petr-muller Apr 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions cmd/cluster-version-operator/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package main

import (
"context"

"github.com/spf13/cobra"
"k8s.io/klog/v2"

Expand All @@ -15,10 +16,12 @@ func init() {
Use: "start",
Short: "Starts Cluster Version Operator",
Long: "",
Run: func(cmd *cobra.Command, args []string) {
PreRunE: func(_ *cobra.Command, _ []string) error {
// To help debugging, immediately log version
klog.Info(version.String)

return opts.ValidateAndComplete()
},
Run: func(_ *cobra.Command, _ []string) {
if err := opts.Run(context.Background()); err != nil {
klog.Fatalf("error: %v", err)
}
Expand Down
79 changes: 41 additions & 38 deletions pkg/start/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/fields"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/informers"
"k8s.io/client-go/kubernetes"
Expand Down Expand Up @@ -132,7 +133,7 @@ func NewOptions() *Options {
}
}

func (o *Options) Run(ctx context.Context) error {
func (o *Options) ValidateAndComplete() error {
if o.NodeName == "" {
return fmt.Errorf("node-name is required")
}
Expand All @@ -152,25 +153,29 @@ func (o *Options) Run(ctx context.Context) error {
(o.PromQLTarget.KubeSvc.Namespace == "" || o.PromQLTarget.KubeSvc.Name == "") {
return fmt.Errorf("--use-dns-for-services is disabled, so --metrics-service and --metrics-namespace must be set")
}
if len(o.PayloadOverride) > 0 {
klog.Warningf("Using an override payload directory for testing only: %s", o.PayloadOverride)
}
if len(o.Exclude) > 0 {
klog.Infof("Excluding manifests for %q", o.Exclude)
}
alwaysEnableCaps, unknownCaps := parseAlwaysEnableCapabilities(o.AlwaysEnableCapabilities)
if len(unknownCaps) > 0 {
return fmt.Errorf("--always-enable-capabilities was set with unknown capabilities: %v", unknownCaps)

if parsed, err := url.Parse(o.PrometheusURLString); err != nil {
return fmt.Errorf("error parsing promql url: %v", err)
} else {
o.PromQLTarget.URL = parsed
}

// Inject the cluster ID into PromQL queries in HyperShift
o.InjectClusterIdIntoPromQL = o.HyperShift

// parse the prometheus url
var err error
o.PromQLTarget.URL, err = url.Parse(o.PrometheusURLString)
if err != nil {
return fmt.Errorf("error parsing promql url: %v", err)
if err := validateCapabilities(o.AlwaysEnableCapabilities); err != nil {
return fmt.Errorf("--always-enable-capabilities: %w", err)
}

return nil
}

func (o *Options) Run(ctx context.Context) error {
if len(o.PayloadOverride) > 0 {
klog.Warningf("Using an override payload directory for testing only: %s", o.PayloadOverride)
}
if len(o.Exclude) > 0 {
klog.Infof("Excluding manifests for %q", o.Exclude)
}

// initialize the core objects
Expand All @@ -185,7 +190,7 @@ func (o *Options) Run(ctx context.Context) error {
}

// initialize the controllers and attempt to load the payload information
controllerCtx, err := o.NewControllerContext(cb, alwaysEnableCaps)
controllerCtx, err := o.NewControllerContext(cb)
if err != nil {
return err
}
Expand Down Expand Up @@ -470,7 +475,7 @@ type Context struct {

// NewControllerContext initializes the default Context for the current Options. It does
// not start any background processes.
func (o *Options) NewControllerContext(cb *ClientBuilder, alwaysEnableCapabilities []configv1.ClusterVersionCapability) (*Context, error) {
func (o *Options) NewControllerContext(cb *ClientBuilder) (*Context, error) {
client := cb.ClientOrDie("shared-informer")
kubeClient := cb.KubeClientOrDie(internal.ConfigNamespace, useProtobuf)
operatorClient := cb.OperatorClientOrDie("operator-client")
Expand All @@ -490,6 +495,7 @@ func (o *Options) NewControllerContext(cb *ClientBuilder, alwaysEnableCapabiliti

cvoKubeClient := cb.KubeClientOrDie(o.Namespace, useProtobuf)
o.PromQLTarget.KubeClient = cvoKubeClient

cvo, err := cvo.New(
o.NodeName,
o.Namespace, o.Name,
Expand All @@ -511,7 +517,7 @@ func (o *Options) NewControllerContext(cb *ClientBuilder, alwaysEnableCapabiliti
o.PromQLTarget,
o.InjectClusterIdIntoPromQL,
o.UpdateService,
alwaysEnableCapabilities,
stringsToCapabilities(o.AlwaysEnableCapabilities),
Copy link
Member Author

@petr-muller petr-muller May 6, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the main point of the change - all other o.Members are passed into NewControllerContext via Options, and the method relies on their earlier validation. Treating one Options member in a different way makes the interface messy.

)
if err != nil {
return nil, err
Expand Down Expand Up @@ -618,25 +624,22 @@ func (c *Context) InitializeFromPayload(ctx context.Context, restConfig *rest.Co
return nil
}

// parseAlwaysEnableCapabilities parses the string list of capabilities
// into two lists of configv1.ClusterVersionCapability: known and unknown.
func parseAlwaysEnableCapabilities(caps []string) ([]configv1.ClusterVersionCapability, []configv1.ClusterVersionCapability) {
var (
knownCaps []configv1.ClusterVersionCapability
unknownCaps []configv1.ClusterVersionCapability
)
for _, c := range caps {
known := false
for _, kc := range configv1.KnownClusterVersionCapabilities {
if configv1.ClusterVersionCapability(c) == kc {
knownCaps = append(knownCaps, kc)
known = true
break
}
}
if !known {
unknownCaps = append(unknownCaps, configv1.ClusterVersionCapability(c))
}
func stringsToCapabilities(names []string) []configv1.ClusterVersionCapability {
caps := make([]configv1.ClusterVersionCapability, len(names))
for i, c := range names {
caps[i] = configv1.ClusterVersionCapability(c)
}
return caps
}

func validateCapabilities(caps []string) error {
unknown := sets.New(caps...)
for _, kc := range configv1.KnownClusterVersionCapabilities {
unknown.Delete(string(kc))
}

if len(unknown) > 0 {
return fmt.Errorf("unknown capabilities: %s", sets.List(unknown))
}
return knownCaps, unknownCaps
return nil
}
27 changes: 15 additions & 12 deletions pkg/start/start_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,15 +184,16 @@ func TestIntegrationCVO_initializeAndUpgrade(t *testing.T) {
options.ReleaseImage = payloadImage1
options.PayloadOverride = filepath.Join(dir, "0.0.1")
options.leaderElection = getLeaderElectionConfig(ctx, cfg)
alwaysEnableCapabilities := []configv1.ClusterVersionCapability{
configv1.ClusterVersionCapabilityIngress,
options.AlwaysEnableCapabilities = []string{string(configv1.ClusterVersionCapabilityIngress)}
if err := options.ValidateAndComplete(); err != nil {
t.Fatalf("incorrectly initialized options: %v", err)
}
controllers, err := options.NewControllerContext(cb, alwaysEnableCapabilities)
controllers, err := options.NewControllerContext(cb)
if err != nil {
t.Fatal(err)
}

worker := cvo.NewSyncWorker(retriever, cvo.NewResourceBuilder(cfg, cfg, nil, nil), 5*time.Second, wait.Backoff{Steps: 3}, "", "", record.NewFakeRecorder(100), payload.DefaultClusterProfile, alwaysEnableCapabilities)
worker := cvo.NewSyncWorker(retriever, cvo.NewResourceBuilder(cfg, cfg, nil, nil), 5*time.Second, wait.Backoff{Steps: 3}, "", "", record.NewFakeRecorder(100), payload.DefaultClusterProfile, stringsToCapabilities(options.AlwaysEnableCapabilities))
controllers.CVO.SetSyncWorkerForTesting(worker)

lock, err := createResourceLock(cb, options.Namespace, options.Name)
Expand Down Expand Up @@ -318,15 +319,16 @@ func TestIntegrationCVO_gracefulStepDown(t *testing.T) {
options.ReleaseImage = payloadImage1
options.PayloadOverride = filepath.Join(dir, "0.0.1")
options.leaderElection = getLeaderElectionConfig(ctx, cfg)
alwaysEnableCapabilities := []configv1.ClusterVersionCapability{
configv1.ClusterVersionCapabilityIngress,
options.AlwaysEnableCapabilities = []string{string(configv1.ClusterVersionCapabilityIngress)}
if err := options.ValidateAndComplete(); err != nil {
t.Fatalf("incorrectly initialized options: %v", err)
}
controllers, err := options.NewControllerContext(cb, alwaysEnableCapabilities)
controllers, err := options.NewControllerContext(cb)
if err != nil {
t.Fatal(err)
}

worker := cvo.NewSyncWorker(retriever, cvo.NewResourceBuilder(cfg, cfg, nil, nil), 5*time.Second, wait.Backoff{Steps: 3}, "", "", record.NewFakeRecorder(100), payload.DefaultClusterProfile, alwaysEnableCapabilities)
worker := cvo.NewSyncWorker(retriever, cvo.NewResourceBuilder(cfg, cfg, nil, nil), 5*time.Second, wait.Backoff{Steps: 3}, "", "", record.NewFakeRecorder(100), payload.DefaultClusterProfile, stringsToCapabilities(options.AlwaysEnableCapabilities))
controllers.CVO.SetSyncWorkerForTesting(worker)

lock, err := createResourceLock(cb, options.Namespace, options.Name)
Expand Down Expand Up @@ -514,15 +516,16 @@ metadata:
options.ReleaseImage = payloadImage1
options.PayloadOverride = payloadDir
options.leaderElection = getLeaderElectionConfig(ctx, cfg)
alwaysEnableCapabilities := []configv1.ClusterVersionCapability{
configv1.ClusterVersionCapabilityIngress,
options.AlwaysEnableCapabilities = []string{string(configv1.ClusterVersionCapabilityIngress)}
if err := options.ValidateAndComplete(); err != nil {
t.Fatalf("incorrectly initialized options: %v", err)
}
controllers, err := options.NewControllerContext(cb, alwaysEnableCapabilities)
controllers, err := options.NewControllerContext(cb)
if err != nil {
t.Fatal(err)
}

worker := cvo.NewSyncWorker(retriever, cvo.NewResourceBuilder(cfg, cfg, nil, nil), 5*time.Second, wait.Backoff{Steps: 3}, "", "", record.NewFakeRecorder(100), payload.DefaultClusterProfile, alwaysEnableCapabilities)
worker := cvo.NewSyncWorker(retriever, cvo.NewResourceBuilder(cfg, cfg, nil, nil), 5*time.Second, wait.Backoff{Steps: 3}, "", "", record.NewFakeRecorder(100), payload.DefaultClusterProfile, stringsToCapabilities(options.AlwaysEnableCapabilities))
controllers.CVO.SetSyncWorkerForTesting(worker)

lock, err := createResourceLock(cb, options.Namespace, options.Name)
Expand Down