Skip to content

Commit

Permalink
kubernetesdiscovery: propagate PodLogStreamTemplate (#4726)
Browse files Browse the repository at this point in the history
  • Loading branch information
nicks committed Jul 2, 2021
1 parent cd45491 commit 0be34b8
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 17 deletions.
27 changes: 12 additions & 15 deletions internal/controllers/core/kubernetesdiscovery/reconciler.go
Expand Up @@ -6,8 +6,6 @@ import (
"sync"
"time"

"github.com/tilt-dev/tilt/internal/engine/runtimelog"

errorutil "k8s.io/apimachinery/pkg/util/errors"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
Expand Down Expand Up @@ -61,10 +59,6 @@ type Reconciler struct {
ownerFetcher k8s.OwnerFetcher
dispatcher Dispatcher
ctrlClient ctrlclient.Client
// startTime of the reconciler used for filtering logs when creating PodLogStream objects.
//
// TODO(milas): we should have a better way of sharing this across a Tilt session
startTime time.Time

// restartDetector compares a previous version of status with the latest and emits log events
// for any containers on the pod that restarted.
Expand Down Expand Up @@ -131,7 +125,6 @@ func NewReconciler(ctrlClient ctrlclient.Client, kCli k8s.Client, ownerFetcher k
ownerFetcher: ownerFetcher,
restartDetector: restartDetector,
dispatcher: st,
startTime: time.Now(),
watchedNamespaces: make(map[k8s.Namespace]nsWatch),
uidWatchers: make(map[types.UID]watcherSet),
watchers: make(map[watcherID]watcher),
Expand Down Expand Up @@ -628,8 +621,14 @@ func (w *Reconciler) createPodLogStream(ctx context.Context, kd v1alpha1.Kuberne
manifest := kd.Annotations[v1alpha1.AnnotationManifest]
spanID := string(k8sconv.SpanIDForPod(model.ManifestName(manifest), k8s.PodID(pod.Name)))

plsTemplate := kd.Spec.PodLogStreamTemplateSpec

// If there's no podlogtream template, create a default one.
if plsTemplate == nil {
plsTemplate = &v1alpha1.PodLogStreamTemplateSpec{}
}

// create PLS
sinceTime := apis.NewTime(w.startTime)
pls := v1alpha1.PodLogStream{
ObjectMeta: metav1.ObjectMeta{
Name: plsKey.Name,
Expand All @@ -640,13 +639,11 @@ func (w *Reconciler) createPodLogStream(ctx context.Context, kd v1alpha1.Kuberne
},
},
Spec: v1alpha1.PodLogStreamSpec{
Pod: pod.Name,
Namespace: pod.Namespace,
SinceTime: &sinceTime,
IgnoreContainers: []string{
string(runtimelog.IstioInitContainerName),
string(runtimelog.IstioSidecarContainerName),
},
Pod: pod.Name,
Namespace: pod.Namespace,
SinceTime: plsTemplate.SinceTime,
IgnoreContainers: plsTemplate.IgnoreContainers,
OnlyContainers: plsTemplate.OnlyContainers,
},
}

Expand Down
13 changes: 12 additions & 1 deletion internal/controllers/core/kubernetesdiscovery/reconciler_test.go
Expand Up @@ -23,6 +23,7 @@ import (

"k8s.io/apimachinery/pkg/types"

"github.com/tilt-dev/tilt/pkg/apis"
"github.com/tilt-dev/tilt/pkg/apis/core/v1alpha1"

"github.com/stretchr/testify/require"
Expand Down Expand Up @@ -279,6 +280,15 @@ func TestReconcileCreatesPodLogStream(t *testing.T) {
f.kClient.UpsertPod(pod2)

key := types.NamespacedName{Namespace: "some-ns", Name: "kd"}
sinceTime := apis.NewTime(time.Now())
podLogStreamTemplateSpec := &v1alpha1.PodLogStreamTemplateSpec{
SinceTime: &sinceTime,
IgnoreContainers: []string{
string(runtimelog.IstioInitContainerName),
string(runtimelog.IstioSidecarContainerName),
},
}

kd := &v1alpha1.KubernetesDiscovery{
ObjectMeta: metav1.ObjectMeta{Namespace: key.Namespace, Name: key.Name},
Spec: v1alpha1.KubernetesDiscoverySpec{
Expand All @@ -294,6 +304,7 @@ func TestReconcileCreatesPodLogStream(t *testing.T) {
Name: pod2.Name,
},
},
PodLogStreamTemplateSpec: podLogStreamTemplateSpec,
},
}

Expand All @@ -320,7 +331,7 @@ func TestReconcileCreatesPodLogStream(t *testing.T) {
for _, pls := range podLogStreams.Items {
assert.Equal(t, ns.String(), pls.Spec.Namespace)

timecmp.AssertTimeEqual(t, f.pw.startTime, pls.Spec.SinceTime)
timecmp.AssertTimeEqual(t, sinceTime, pls.Spec.SinceTime)

assert.ElementsMatch(t,
[]string{runtimelog.IstioInitContainerName.String(), runtimelog.IstioSidecarContainerName.String()},
Expand Down
12 changes: 12 additions & 0 deletions internal/engine/k8swatch/manifest_subscriber.go
Expand Up @@ -3,6 +3,7 @@ package k8swatch
import (
"context"
"fmt"
"time"

"k8s.io/apimachinery/pkg/api/equality"
apierrors "k8s.io/apimachinery/pkg/api/errors"
Expand All @@ -15,6 +16,7 @@ import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/types"

"github.com/tilt-dev/tilt/internal/engine/runtimelog"
"github.com/tilt-dev/tilt/internal/store"
"github.com/tilt-dev/tilt/pkg/apis"
"github.com/tilt-dev/tilt/pkg/apis/core/v1alpha1"
Expand All @@ -24,13 +26,15 @@ type ManifestSubscriber struct {
cfgNS k8s.Namespace
client ctrlclient.Client
lastUpdate map[types.NamespacedName]*v1alpha1.KubernetesDiscoverySpec
startTime time.Time
}

func NewManifestSubscriber(cfgNS k8s.Namespace, client ctrlclient.Client) *ManifestSubscriber {
return &ManifestSubscriber{
cfgNS: cfgNS,
client: client,
lastUpdate: make(map[types.NamespacedName]*v1alpha1.KubernetesDiscoverySpec),
startTime: time.Now(),
}
}

Expand Down Expand Up @@ -226,6 +230,7 @@ func (m *ManifestSubscriber) kubernetesDiscoveryFromManifest(_ context.Context,
}
}

sinceTime := apis.NewTime(m.startTime)
kd := &v1alpha1.KubernetesDiscovery{
ObjectMeta: metav1.ObjectMeta{
Name: key.Name,
Expand All @@ -238,6 +243,13 @@ func (m *ManifestSubscriber) kubernetesDiscoveryFromManifest(_ context.Context,
Spec: v1alpha1.KubernetesDiscoverySpec{
Watches: watchRefs,
ExtraSelectors: extraSelectors,
PodLogStreamTemplateSpec: &v1alpha1.PodLogStreamTemplateSpec{
SinceTime: &sinceTime,
IgnoreContainers: []string{
string(runtimelog.IstioInitContainerName),
string(runtimelog.IstioSidecarContainerName),
},
},
},
}

Expand Down
3 changes: 3 additions & 0 deletions pkg/apis/core/v1alpha1/generated.proto

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

4 changes: 4 additions & 0 deletions pkg/apis/core/v1alpha1/kubernetesdiscovery_types.go
Expand Up @@ -76,12 +76,16 @@ type KubernetesDiscoverySpec struct {
//
// +optional
PortForwardTemplateSpec *PortForwardTemplateSpec `json:"portForwardTemplateSpec,omitempty" protobuf:"bytes,3,opt,name=portForwardTemplateSpec"`

// PodLogStreamTemplateSpec describes the data model for PodLogStreams
// that KubernetesDiscovery should set up.
//
// The KubernetesDiscovery controller will attach PodLogStream objects
// to all active pods it discovers.
//
// If no template is specified, the controller will stream all
// pod logs available from the apiserver.
//
// +optional
PodLogStreamTemplateSpec *PodLogStreamTemplateSpec `json:"podLogStreamTemplateSpec,omitempty" protobuf:"bytes,4,opt,name=podLogStreamTemplateSpec"`
}
Expand Down
2 changes: 1 addition & 1 deletion pkg/openapi/zz_generated.openapi.go

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

0 comments on commit 0be34b8

Please sign in to comment.