Skip to content

Bug 2071998: pkg/cvo/updatepayload: Event when forcing through a sig-verification failure #763

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
openshift-merge-robot merged 2 commits into from
May 24, 2022
Merged

Bug 2071998: pkg/cvo/updatepayload: Event when forcing through a sig-verification failure #763

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
690fa69
vendor: Bump library-go for verification error details
wking Apr 21, 2022
5ad3c14
pkg/cvo/updatepayload: Event when forcing through a sig-verification …
wking Apr 7, 2022
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
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ require (
github.com/imdario/mergo v0.3.8 // indirect
github.com/openshift/api v0.0.0-20220504105152-6f735e7109c8
github.com/openshift/client-go v0.0.0-20220504114320-6aec01bb0754
github.com/openshift/library-go v0.0.0-20220512194226-3c66b317b110
github.com/openshift/library-go v0.0.0-20220523142556-5bcfed822fc6
github.com/pkg/errors v0.9.1
github.com/prometheus/client_golang v1.11.1
github.com/prometheus/client_model v0.2.0
Expand Down
4 changes: 2 additions & 2 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,8 +488,8 @@ github.com/openshift/api v0.0.0-20220504105152-6f735e7109c8/go.mod h1:F/eU6jgr6Q
github.com/openshift/build-machinery-go v0.0.0-20211213093930-7e33a7eb4ce3/go.mod h1:b1BuldmJlbA/xYtdZvKi+7j5YGB44qJUJDZ9zwiNCfE=
github.com/openshift/client-go v0.0.0-20220504114320-6aec01bb0754 h1:E/SORtM8rYRq5vp7zlSyxUeH1v71QZAFXW7FkAggw0Q=
github.com/openshift/client-go v0.0.0-20220504114320-6aec01bb0754/go.mod h1:0KyRH70L+vAGs8wkOkqbsE9qR4lgjW2ugJsCzl1nj5w=
github.com/openshift/library-go v0.0.0-20220512194226-3c66b317b110 h1:5lgF3YD1XwaJVtasYsWKFTwI3ZUwuVMcMAwJf2x4YSY=
github.com/openshift/library-go v0.0.0-20220512194226-3c66b317b110/go.mod h1:1QSdymJBGXSOgBj7tWhj4cV+i1+AvkQ/Tq78ebWjXCU=
github.com/openshift/library-go v0.0.0-20220523142556-5bcfed822fc6 h1:HSmUjhgHhwxdNPvq8xPf19BV67wf1GIepefPOl7dsIU=
github.com/openshift/library-go v0.0.0-20220523142556-5bcfed822fc6/go.mod h1:1QSdymJBGXSOgBj7tWhj4cV+i1+AvkQ/Tq78ebWjXCU=
github.com/opentracing/opentracing-go v1.1.0/go.mod h1:UkNAQd3GIcIGf0SeVgPpRdFStlNbqXla1AfSYxPUl2o=
github.com/pascaldekloe/goe v0.0.0-20180627143212-57f6aae5913c/go.mod h1:lzWF7FIEvWOWxwDKqyGYQf6ZUaNfKdP144TG7ZOy1lc=
github.com/pborman/uuid v1.2.0/go.mod h1:X/NO0urCmaxf9VXbdlT7C2Yzkj2IKimNn4k+gtPdI/k=
Expand Down
24 changes: 19 additions & 5 deletions pkg/cvo/sync_worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cvo

import (
"context"
"errors"
"fmt"
"math/rand"
"reflect"
Expand All @@ -14,7 +15,7 @@ import (
"github.com/prometheus/client_golang/prometheus"
"golang.org/x/time/rate"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/util/errors"
apierrors "k8s.io/apimachinery/pkg/util/errors"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/tools/record"
Expand Down Expand Up @@ -283,6 +284,19 @@ func (w *SyncWorker) syncPayload(ctx context.Context, work *SyncWork,
})
return nil, err
}
if info.VerificationError != nil {
msg := ""
for err := info.VerificationError; err != nil; err = errors.Unwrap(err) {
details := err.Error()
if !strings.Contains(msg, details) {
// library-go/pkg/verify wraps the details, but does not include them
// in the top-level error string. If we have an error like that,
// include the details here.
msg = fmt.Sprintf("%s\n%s", msg, details)
}
}
w.eventRecorder.Eventf(cvoObjectRef, corev1.EventTypeWarning, "RetrievePayload", msg)
}
Copy link
Member

@LalatenduMohanty LalatenduMohanty Apr 21, 2022

Choose a reason for hiding this comment

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

@wking Any reason you are not calling reporter.ReportPayload after the w.eventRecorder.Eventf

reporter.ReportPayload(LoadPayloadStatus{
			Step:               "RetrievePayload",
			Message:            msg,
			Release:            desired,
			LastTransitionTime: time.Now(),

Copy link
Member Author

@wking wking Apr 21, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

we just want this event for the narrow "update was forced, release was not verified" case. I didn't think it was worth tying into ClusterVersion reporting (we will report there when we accept the update, which because of force, we will soon after this event)


w.eventRecorder.Eventf(cvoObjectRef, corev1.EventTypeNormal, "LoadPayload", "Loading payload version=%q image=%q", desired.Version, desired.Image)
payloadUpdate, err := payload.LoadUpdate(info.Directory, desired.Image, w.exclude, w.includeTechPreview, w.clusterProfile,
Expand Down Expand Up @@ -1081,12 +1095,12 @@ func summarizeTaskGraphErrors(errs []error) error {
// we ignore context errors (canceled or timed out) since they don't
// provide good feedback to users and are an internal detail of the
// server
err := errors.FilterOut(errors.NewAggregate(errs), isContextError)
err := apierrors.FilterOut(apierrors.NewAggregate(errs), isContextError)
if err == nil {
klog.V(2).Infof("All errors were context errors: %v", errs)
return nil
}
agg, ok := err.(errors.Aggregate)
agg, ok := err.(apierrors.Aggregate)
if !ok {
errs = []error{err}
} else {
Expand Down Expand Up @@ -1181,7 +1195,7 @@ func newClusterOperatorsNotAvailable(errs []error) error {
sort.Strings(names)
name := strings.Join(names, ", ")
return &payload.UpdateError{
Nested: errors.NewAggregate(errs),
Nested: apierrors.NewAggregate(errs),
UpdateEffect: updateEffect,
Reason: "ClusterOperatorsNotAvailable",
Message: fmt.Sprintf("Some cluster operators are still updating: %s", name),
Expand Down Expand Up @@ -1228,7 +1242,7 @@ func newMultipleError(errs []error) error {
return errs[0]
}
return &payload.UpdateError{
Nested: errors.NewAggregate(errs),
Nested: apierrors.NewAggregate(errs),
Reason: "MultipleErrors",
Message: fmt.Sprintf("Multiple errors are preventing progress:\n* %s", strings.Join(messages, "\n* ")),
}
Expand Down
3 changes: 2 additions & 1 deletion pkg/cvo/updatepayload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,8 @@ func (r *payloadRetriever) RetrievePayload(ctx context.Context, update configv1.
if !update.Force {
return PayloadInfo{}, vErr
}
klog.Warningf("An image was retrieved from %q that failed verification: %v", update.Image, vErr)
vErr.Message = fmt.Sprintf("Target release version=%q image=%q cannot be verified, but continuing anyway because the update was forced: %v", update.Version, update.Image, err)
klog.Warning(vErr)
info.VerificationError = vErr
} else {
info.Verified = true
Expand Down
10 changes: 10 additions & 0 deletions pkg/payload/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,20 @@ func (e *UpdateError) Error() string {
return e.Message
}

// Cause supports github.com/pkg/errors.Cause [1].
//
// [1]: https://pkg.go.dev/github.com/pkg/errors#readme-retrieving-the-cause-of-an-error
func (e *UpdateError) Cause() error {
return e.Nested
}

// Unwrap supports errors.Unwrap [1].
//
// [1]: https://pkg.go.dev/errors#Unwrap
func (e *UpdateError) Unwrap() error {
return e.Nested
}

// reasonForUpdateError provides a succint explanation of a known error type for use in a human readable
// message during update. Since all objects in the image should be successfully applied, messages
// should direct the reader (likely a cluster administrator) to a possible cause in their own config.
Expand Down
10 changes: 8 additions & 2 deletions vendor/github.com/openshift/library-go/pkg/verify/store/configmap/configmap.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 12 additions & 2 deletions vendor/github.com/openshift/library-go/pkg/verify/store/parallel/parallel.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion vendor/github.com/openshift/library-go/pkg/verify/store/serial/serial.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 10 additions & 15 deletions vendor/github.com/openshift/library-go/pkg/verify/store/sigstore/sigstore.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 15 additions & 2 deletions vendor/github.com/openshift/library-go/pkg/verify/store/store.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 5 additions & 6 deletions vendor/github.com/openshift/library-go/pkg/verify/verify.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion vendor/modules.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ github.com/openshift/client-go/image/clientset/versioned/scheme
github.com/openshift/client-go/image/clientset/versioned/typed/image/v1
github.com/openshift/client-go/security/clientset/versioned/scheme
github.com/openshift/client-go/security/clientset/versioned/typed/security/v1
# github.com/openshift/library-go v0.0.0-20220512194226-3c66b317b110
# github.com/openshift/library-go v0.0.0-20220523142556-5bcfed822fc6
## explicit
github.com/openshift/library-go/pkg/config/clusterstatus
github.com/openshift/library-go/pkg/config/leaderelection
Expand Down