Skip to content

pkg/cvo: Report current tasks #152

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

Closed
wking wants to merge 1 commit into from
+70 −6
Closed

pkg/cvo: Report current tasks #152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 18 additions & 1 deletion pkg/cvo/cvo_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import (
apiextclientv1 "k8s.io/apiextensions-apiserver/pkg/client/clientset/clientset/typed/apiextensions/v1beta1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
Expand All @@ -32,6 +33,7 @@ import (
clientset "github.com/openshift/client-go/config/clientset/versioned"
"github.com/openshift/client-go/config/clientset/versioned/fake"

"github.com/openshift/cluster-version-operator/lib"
"github.com/openshift/cluster-version-operator/pkg/payload"
)

Expand Down Expand Up @@ -881,6 +883,21 @@ func TestOperator_sync(t *testing.T) {
name: "after desired update is cancelled, revert to progressing",
syncStatus: &SyncWorkerStatus{
Actual: configv1.Update{Image: "image/image:v4.0.1", Version: "4.0.1"},
Current: []*payload.Task{
{
Manifest: &lib.Manifest{
GVK: schema.GroupVersionKind{Kind: "Deployment", Version: "v1"},
Obj: &unstructured.Unstructured{
Object: map[string]interface{}{
"metadata": map[string]interface{}{
"namespace": "openshift-cluster-version",
"name": "cluster-verion-operator",
},
},
},
},
},
},
Fraction: 0.334,
},
optr: Operator{
Expand Down Expand Up @@ -978,7 +995,7 @@ func TestOperator_sync(t *testing.T) {
{Type: configv1.OperatorAvailable, Status: configv1.ConditionFalse},
{Type: configv1.OperatorFailing, Status: configv1.ConditionFalse},
// we correct the message that was incorrect from the previous state
{Type: configv1.OperatorProgressing, Status: configv1.ConditionTrue, Message: "Working towards 4.0.1: 33% complete"},
{Type: configv1.OperatorProgressing, Status: configv1.ConditionTrue, Message: "Working towards 4.0.1: 33% complete (Deployment openshift-cluster-version/cluster-verion-operator)"},
{Type: configv1.RetrievedUpdates, Status: configv1.ConditionFalse},
},
},
Expand Down
7 changes: 6 additions & 1 deletion pkg/cvo/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import (
"bytes"
"encoding/json"
"fmt"
"strings"

"github.com/golang/glog"

Expand Down Expand Up @@ -259,7 +260,11 @@ func (optr *Operator) syncStatus(original, config *configv1.ClusterVersion, stat
case len(validationErrs) > 0:
message = fmt.Sprintf("Reconciling %s: the cluster version is invalid", version)
case status.Fraction > 0:
message = fmt.Sprintf("Working towards %s: %.0f%% complete", version, status.Fraction*100)
tasks := make([]string, 0, len(status.Current))
for _, task := range status.Current {
Copy link
Contributor

@smarterclayton smarterclayton Apr 1, 2019

Choose a reason for hiding this comment

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

This is going to be too large, and I don't want to show resource names here.

Copy link
Member Author

@wking wking Apr 1, 2019

Choose a reason for hiding this comment

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

This is going to be too large...

Can you think of away to attach as structured data, so the consumer can make the verbosity/rendering calls?

tasks = append(tasks, task.KindName())
}
message = fmt.Sprintf("Working towards %s: %.0f%% complete (%s)", version, status.Fraction*100, strings.Join(tasks, ", "))
Copy link
Contributor

@smarterclayton smarterclayton Apr 1, 2019

Choose a reason for hiding this comment

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

The only thing that should ever show up in this message is 1-2 operator names, that's it.

Copy link
Contributor

@smarterclayton smarterclayton Apr 1, 2019

Choose a reason for hiding this comment

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

I don't want to keep showing operator names either. The only time we should have anything other than a % is when a specific operator has taken longer than a certain amount of time (has completed a sync period)

Copy link
Member Author

@wking wking Apr 1, 2019

Choose a reason for hiding this comment

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

The only thing that should ever show up in this message is 1-2 operator names, that's it.

So what to show when you're, say, blocked on a RoleBinding? Collapse to the namespace?

Copy link
Member Author

@wking wking Apr 1, 2019 •
edited
Loading

Choose a reason for hiding this comment

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

The only time we should have anything other than a % is when a specific operator has taken longer than a certain amount of time (has completed a sync period)

The issue here is that the installer doesn't know about sync periods, and wants to know what was blocking the CVO when the installer decided to give up on waiting. If the CVO starts right in on another sync cycle (which it does, right?), it seems very unlikely that the last message received by the installer would include blockers, unless we include them in every message.

Copy link
Contributor

@deads2k deads2k Apr 8, 2019

Choose a reason for hiding this comment

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

I don't want to keep showing operator names either. The only time we should have anything other than a % is when a specific operator has taken longer than a certain amount of time (has completed a sync period)

This or the namespace is sufficient to find the next level of debugging. We have enough operators that indicating which one the CVO is stuck on is pretty useful. In cases where we aren't currently waiting on a CO, knowing the namespace is good enough for most purposes.

case status.Step == "RetrievePayload":
if len(reason) == 0 {
reason = "DownloadingUpdate"
Expand Down
38 changes: 35 additions & 3 deletions pkg/cvo/sync_worker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ type SyncWorkerStatus struct {
Step string
Failure error

Current []*payload.Task
Fraction float32

Completed int
Expand Down Expand Up @@ -480,17 +481,21 @@ func (w *SyncWorker) apply(ctx context.Context, payloadUpdate *payload.Update, w

glog.V(4).Infof("Running sync for %s", task)
glog.V(5).Infof("Manifest: %s", string(task.Manifest.Raw))
cr.BeginTask(task)

ov, ok := getOverrideForManifest(work.Overrides, task.Manifest)
if ok && ov.Unmanaged {
cr.FinishTask(task, false)
glog.V(4).Infof("Skipping %s as unmanaged", task)
continue
}

if err := task.Run(ctx, version, w.builder, work.State); err != nil {
cr.FinishTask(task, false)
return err
}
cr.Inc()

cr.FinishTask(task, true)
glog.V(4).Infof("Done syncing for %s", task)
}
return nil
Expand Down Expand Up @@ -530,10 +535,34 @@ type consistentReporter struct {
reporter StatusReporter
}

func (r *consistentReporter) Inc() {
// Begin task appends the given task to status.Current.
func (r *consistentReporter) BeginTask(task *payload.Task) {
r.lock.Lock()
defer r.lock.Unlock()
r.status.Current = append(r.status.Current, task)
}

// FinishTask atomically removes the given task from status.Current
// and, if success is true, increments done.
func (r *consistentReporter) FinishTask(task *payload.Task, success bool) {
r.lock.Lock()
defer r.lock.Unlock()
r.done++

if success {
r.done++
}

for i, tsk := range r.status.Current {
if tsk == task {
copy(r.status.Current[i:], r.status.Current[i+1:])
Copy link
Contributor

@abhinavdahiya abhinavdahiya Apr 1, 2019

Choose a reason for hiding this comment

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

This is not great :(

Copy link
Member Author

@wking wking Apr 1, 2019

Choose a reason for hiding this comment

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

This is not great :(

This is the recommended way to delete from a slice of pointers while preserving ordering, per this. Did you have an alternative you prefer?

r.status.Current[len(r.status.Current)-1] = nil
r.status.Current = r.status.Current[:len(r.status.Current)-1]
if len(r.status.Current) == 0 {
r.status.Current = nil
}
return
}
}
}

func (r *consistentReporter) Update() {
Expand All @@ -543,6 +572,7 @@ func (r *consistentReporter) Update() {
metricPayload.WithLabelValues(r.version, "applied").Set(float64(r.done))
copied := r.status
copied.Step = "ApplyResources"
copied.Current = append([]*payload.Task(nil), r.status.Current...)
copied.Fraction = float32(r.done) / float32(r.total)
r.reporter.Report(copied)
}
Expand All @@ -552,6 +582,7 @@ func (r *consistentReporter) Error(err error) {
defer r.lock.Unlock()
copied := r.status
copied.Step = "ApplyResources"
copied.Current = append([]*payload.Task(nil), r.status.Current...)
copied.Fraction = float32(r.done) / float32(r.total)
copied.Failure = err
r.reporter.Report(copied)
Expand All @@ -572,6 +603,7 @@ func (r *consistentReporter) Complete() {
copied.Completed = r.completed + 1
copied.Initial = false
copied.Reconciling = true
copied.Current = nil
copied.Fraction = 1
r.reporter.Report(copied)
}
Expand Down
3 changes: 2 additions & 1 deletion pkg/cvo/sync_worker_test.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 (
"fmt"
"reflect"
"testing"
"time"

Expand Down Expand Up @@ -70,7 +71,7 @@ func Test_statusWrapper_Report(t *testing.T) {
if !ok {
t.Fatalf("no event")
}
if evt != tt.next {
if !reflect.DeepEqual(evt, tt.next) {
t.Fatalf("unexpected: %#v", evt)
}
}
Expand Down
9 changes: 9 additions & 0 deletions pkg/payload/task.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ func (st *Task) String() string {
return fmt.Sprintf("%s \"%s/%s\" (%d of %d)", strings.ToLower(st.Manifest.GVK.Kind), ns, st.Manifest.Object().GetName(), st.Index, st.Total)
}

// KindName returns the kind, namespace (if set), and name of the task.
func (st *Task) KindName() string {
ns := st.Manifest.Object().GetNamespace()
if len(ns) == 0 {
return fmt.Sprintf("%s %s", st.Manifest.GVK.Kind, st.Manifest.Object().GetName())
}
return fmt.Sprintf("%s %s/%s", st.Manifest.GVK.Kind, ns, st.Manifest.Object().GetName())
}

// Run attempts to create the provided object until it succeeds or context is cancelled. It returns the
// last error if context is cancelled.
func (st *Task) Run(ctx context.Context, version string, builder ResourceBuilder, state State) error {
Expand Down