Skip to content

Add ImageCache for multi container support #7661

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
knative-prow-robot merged 5 commits into from
Apr 29, 2020
Merged

Add ImageCache for multi container support #7661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fffc03e
Add ImageCache for multi container support
savitaashture Apr 21, 2020
3d476b3
Fix review comments
savitaashture Apr 21, 2020
7a885a2
fix review comments
savitaashture Apr 24, 2020
88df5eb
Add comments for clear information
savitaashture Apr 27, 2020
a75a254
Remove using the image value when there are no digests
savitaashture Apr 27, 2020
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
4 changes: 2 additions & 2 deletions pkg/reconciler/revision/cruds.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ func (c *Reconciler) checkAndUpdateDeployment(ctx context.Context, rev *v1.Revis
return d, nil
}

func (c *Reconciler) createImageCache(ctx context.Context, rev *v1.Revision) (*caching.Image, error) {
image := resources.MakeImageCache(rev)
func (c *Reconciler) createImageCache(rev *v1.Revision, containerName, imageDigest string) (*caching.Image, error) {
image := resources.MakeImageCache(rev, containerName, imageDigest)

return c.cachingclient.CachingV1alpha1().Images(image.Namespace).Create(image)
}
Expand Down
23 changes: 13 additions & 10 deletions pkg/reconciler/revision/reconcile_resources.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
"k8s.io/apimachinery/pkg/api/equality"
apierrs "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"knative.dev/pkg/kmeta"
"knative.dev/pkg/logging"
"knative.dev/pkg/logging/logkey"
v1 "knative.dev/serving/pkg/apis/serving/v1"
Expand Down Expand Up @@ -113,18 +114,20 @@ func (c *Reconciler) reconcileImageCache(ctx context.Context, rev *v1.Revision)
logger := logging.FromContext(ctx)

ns := rev.Namespace
imageName := resourcenames.ImageCache(rev)
_, err := c.imageLister.Images(ns).Get(imageName)
Copy link
Copy Markdown
Member

@mattmoor mattmoor Apr 22, 2020

Choose a reason for hiding this comment

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

Are we not updating the Image resource when the digest changes?

if apierrs.IsNotFound(err) {
_, err := c.createImageCache(ctx, rev)
if err != nil {
return fmt.Errorf("failed to create image cache %q: %w", imageName, err)
// Revisions are immutable.
// Updating image results to new revision so there won't be any chance of resource leak.
for _, container := range rev.Status.ContainerStatuses {
Comment thread
mattmoor marked this conversation as resolved.
imageName := kmeta.ChildName(resourcenames.ImageCache(rev), "-"+container.Name)
if _, err := c.imageLister.Images(ns).Get(imageName); apierrs.IsNotFound(err) {
if _, err := c.createImageCache(rev, container.Name, container.ImageDigest); err != nil {
return fmt.Errorf("failed to create image cache %q: %w", imageName, err)
}
logger.Infof("Created image cache %q", imageName)
} else if err != nil {
return fmt.Errorf("failed to get image cache %q: %w", imageName, err)
}
logger.Infof("Created image cache %q", imageName)
} else if err != nil {
return fmt.Errorf("failed to get image cache %q: %w", imageName, err)
}

}
return nil
}

Expand Down
9 changes: 2 additions & 7 deletions pkg/reconciler/revision/resources/imagecache.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,10 @@ import (
)

// MakeImageCache makes an caching.Image resources from a revision.
func MakeImageCache(rev *v1.Revision) *caching.Image {
image := rev.Status.DeprecatedImageDigest
if image == "" {
image = rev.Spec.GetContainer().Image
}

func MakeImageCache(rev *v1.Revision, containerName, image string) *caching.Image {
img := &caching.Image{
ObjectMeta: metav1.ObjectMeta{
Name: names.ImageCache(rev),
Name: kmeta.ChildName(names.ImageCache(rev), "-"+containerName),
Namespace: rev.Namespace,
Labels: makeLabels(rev),
Annotations: kmeta.FilterMap(rev.GetAnnotations(), func(k string) bool {
Expand Down
152 changes: 145 additions & 7 deletions pkg/reconciler/revision/resources/imagecache_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,11 @@ import (

func TestMakeImageCache(t *testing.T) {
tests := []struct {
name string
rev *v1.Revision
want *caching.Image
name string
rev *v1.Revision
containerName string
image string
want *caching.Image
}{{
name: "simple container",
rev: &v1.Revision{
Expand All @@ -55,13 +57,19 @@ func TestMakeImageCache(t *testing.T) {
},
},
Status: v1.RevisionStatus{
ContainerStatuses: []v1.ContainerStatuses{{
Name: "user-container",
ImageDigest: "busybox@sha256:deadbeef",
}},
DeprecatedImageDigest: "busybox@sha256:deadbeef",
},
},
containerName: "user-container",
image: "busybox@sha256:deadbeef",
want: &caching.Image{
ObjectMeta: metav1.ObjectMeta{
Namespace: "foo",
Name: "bar-cache",
Name: "bar-cache-user-container",
Labels: map[string]string{
serving.RevisionLabelKey: "bar",
serving.RevisionUID: "1234",
Expand All @@ -83,6 +91,127 @@ func TestMakeImageCache(t *testing.T) {
Image: "busybox@sha256:deadbeef",
},
},
}, {
name: "multiple containers",
rev: &v1.Revision{
ObjectMeta: metav1.ObjectMeta{
Namespace: "foo",
Name: "bar",
Annotations: map[string]string{
"a": "b",
serving.RevisionLastPinnedAnnotationKey: "c",
},
UID: "1234",
},
Spec: v1.RevisionSpec{
ContainerConcurrency: ptr.Int64(1),
PodSpec: corev1.PodSpec{
Containers: []corev1.Container{{
Image: "ubuntu",
Ports: []corev1.ContainerPort{{
ContainerPort: 80,
}},
}, {
Image: "busybox",
}},
},
},
Status: v1.RevisionStatus{
ContainerStatuses: []v1.ContainerStatuses{{
Name: "user-container1",
ImageDigest: "ubuntu@sha256:deadbeef1",
}, {
Name: "user-container",
ImageDigest: "busybox@sha256:deadbeef",
}},
DeprecatedImageDigest: "busybox@sha256:deadbeef",
},
},
containerName: "user-container1",
image: "ubuntu@sha256:deadbeef1",
want: &caching.Image{
ObjectMeta: metav1.ObjectMeta{
Namespace: "foo",
Name: "bar-cache-user-container1",
Labels: map[string]string{
serving.RevisionLabelKey: "bar",
serving.RevisionUID: "1234",
AppLabelKey: "bar",
},
Annotations: map[string]string{
"a": "b",
},
OwnerReferences: []metav1.OwnerReference{{
APIVersion: v1.SchemeGroupVersion.String(),
Kind: "Revision",
Name: "bar",
UID: "1234",
Controller: ptr.Bool(true),
BlockOwnerDeletion: ptr.Bool(true),
}},
},
Spec: caching.ImageSpec{
Image: "ubuntu@sha256:deadbeef1",
},
},
}, {
name: "Image cache for multiple containers when image digests are empty",
rev: &v1.Revision{
ObjectMeta: metav1.ObjectMeta{
Namespace: "foo",
Name: "bar",
Annotations: map[string]string{
"a": "b",
serving.RevisionLastPinnedAnnotationKey: "c",
},
UID: "1234",
},
Spec: v1.RevisionSpec{
ContainerConcurrency: ptr.Int64(1),
PodSpec: corev1.PodSpec{
Containers: []corev1.Container{{
Name: "user-container",
Image: "ubuntu",
Ports: []corev1.ContainerPort{{
ContainerPort: 80,
}},
}, {
Name: "user-container1",
Image: "busybox",
}},
},
},
Status: v1.RevisionStatus{
ContainerStatuses: []v1.ContainerStatuses{{}},
},
},
containerName: "user-container",
image: "",
want: &caching.Image{
ObjectMeta: metav1.ObjectMeta{
Namespace: "foo",
Name: "bar-cache-user-container",
Labels: map[string]string{
serving.RevisionLabelKey: "bar",
serving.RevisionUID: "1234",
AppLabelKey: "bar",
},
Annotations: map[string]string{
"a": "b",
},
OwnerReferences: []metav1.OwnerReference{{
APIVersion: v1.SchemeGroupVersion.String(),
Kind: "Revision",
Name: "bar",
UID: "1234",
Controller: ptr.Bool(true),
BlockOwnerDeletion: ptr.Bool(true),
}},
},
Spec: caching.ImageSpec{
Image: "",
},
},
}, {
name: "with service account",
rev: &v1.Revision{
Expand All @@ -96,15 +225,24 @@ func TestMakeImageCache(t *testing.T) {
PodSpec: corev1.PodSpec{
ServiceAccountName: "privilegeless",
Containers: []corev1.Container{{
Name: "user-container",
Image: "busybox",
}},
},
},
Status: v1.RevisionStatus{
ContainerStatuses: []v1.ContainerStatuses{{
Name: "user-container",
ImageDigest: "busybox@sha256:deadbeef",
}},
},
},
containerName: "user-container",
image: "busybox@sha256:deadbeef",
want: &caching.Image{
ObjectMeta: metav1.ObjectMeta{
Namespace: "foo",
Name: "bar-cache",
Name: "bar-cache-user-container",
Labels: map[string]string{
serving.RevisionLabelKey: "bar",
serving.RevisionUID: "1234",
Expand All @@ -121,15 +259,15 @@ func TestMakeImageCache(t *testing.T) {
}},
},
Spec: caching.ImageSpec{
Image: "busybox",
Image: "busybox@sha256:deadbeef",
ServiceAccountName: "privilegeless",
},
},
}}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got := MakeImageCache(test.rev)
got := MakeImageCache(test.rev, test.containerName, test.image)
if diff := cmp.Diff(test.want, got); diff != "" {
t.Errorf("MakeImageCache (-want, +got) = %v", diff)
}
Expand Down
36 changes: 13 additions & 23 deletions pkg/reconciler/revision/revision_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ func testReadyPA(rev *v1.Revision) *av1alpha1.PodAutoscaler {
return pa
}

func newTestControllerWithConfig(t *testing.T, deploymentConfig *deployment.Config, configs []*corev1.ConfigMap, opts ...reconcilerOption) (
func newTestControllerWithConfig(t *testing.T, configs []*corev1.ConfigMap, opts ...reconcilerOption) (
context.Context,
[]controller.Informer,
*controller.Impl,
Expand Down Expand Up @@ -233,12 +233,14 @@ func addResourcesToInformers(t *testing.T, ctx context.Context, rev *v1.Revision
fakepainformer.Get(ctx).Informer().GetIndexer().Add(pa)
}

imageName := resourcenames.ImageCache(rev)
image, err := fakecachingclient.Get(ctx).CachingV1alpha1().Images(rev.Namespace).Get(imageName, metav1.GetOptions{})
if err != nil {
t.Errorf("Caching.Images.Get(%v) = %v", imageName, err)
} else {
fakeimageinformer.Get(ctx).Informer().GetIndexer().Add(image)
for _, v := range rev.Spec.Containers {
imageName := kmeta.ChildName(resourcenames.ImageCache(rev), "-"+v.Name)
image, err := fakecachingclient.Get(ctx).CachingV1alpha1().Images(rev.Namespace).Get(imageName, metav1.GetOptions{})
if err != nil {
t.Errorf("Caching.Images.Get(%v) = %v", imageName, err)
} else {
fakeimageinformer.Get(ctx).Informer().GetIndexer().Add(image)
}
}

deploymentName := resourcenames.Deployment(rev)
Expand Down Expand Up @@ -299,8 +301,7 @@ func TestResolutionFailed(t *testing.T) {

// TODO(mattmoor): add coverage of a Reconcile fixing a stale logging URL
func TestUpdateRevWithWithUpdatedLoggingURL(t *testing.T) {
deploymentConfig := getTestDeploymentConfig()
ctx, _, controller, watcher := newTestControllerWithConfig(t, deploymentConfig, []*corev1.ConfigMap{{
ctx, _, controller, watcher := newTestControllerWithConfig(t, []*corev1.ConfigMap{{
ObjectMeta: metav1.ObjectMeta{
Namespace: system.Namespace(),
Name: metrics.ConfigMapName(),
Expand Down Expand Up @@ -341,16 +342,7 @@ func TestUpdateRevWithWithUpdatedLoggingURL(t *testing.T) {
}

func TestRevWithImageDigests(t *testing.T) {
deploymentConfig := getTestDeploymentConfig()
ctx, _, controller, _ := newTestControllerWithConfig(t, deploymentConfig, []*corev1.ConfigMap{{
ObjectMeta: metav1.ObjectMeta{
Name: config.DefaultsConfigName,
Namespace: system.Namespace(),
},
Data: map[string]string{
"container-name-template": "user-container",
},
}})
ctx, _, controller, _ := newTestControllerWithConfig(t, nil)

rev := testRevision(corev1.PodSpec{
Containers: []corev1.Container{{
Expand Down Expand Up @@ -541,8 +533,7 @@ func TestGlobalResyncOnConfigMapUpdateRevision(t *testing.T) {

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
controllerConfig := getTestDeploymentConfig()
ctx, informers, ctrl, watcher := newTestControllerWithConfig(t, controllerConfig, nil)
ctx, informers, ctrl, watcher := newTestControllerWithConfig(t, nil)

ctx, cancel := context.WithCancel(ctx)
grp := errgroup.Group{}
Expand Down Expand Up @@ -678,8 +669,7 @@ func TestGlobalResyncOnConfigMapUpdateDeployment(t *testing.T) {

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
controllerConfig := getTestDeploymentConfig()
ctx, informers, ctrl, watcher := newTestControllerWithConfig(t, controllerConfig, nil)
ctx, informers, ctrl, watcher := newTestControllerWithConfig(t, nil)

ctx, cancel := context.WithCancel(ctx)
grp := errgroup.Group{}
Expand Down
Loading