Skip to content
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

feat: bubble up image size as pod events #106

Closed
wants to merge 3 commits into from
+682 −6
Closed

feat: bubble up image size as pod events #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4b98501
feat: bubble up image size as pod events
vadasambar Jan 11, 2024
0b894e1
chore: rename `warm-metal` -> `container-image-csi-driver`
vadasambar Feb 20, 2024
063d239
chore: rename `warm-metal` -> `container-image-csi-driver`
vadasambar Feb 20, 2024
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
3 changes: 3 additions & 0 deletions charts/warm-metal-csi-driver/templates/nodeplugin-rbac.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ apiVersion: rbac.authorization.k8s.io/v1
metadata:
name: {{ include "warm-metal-csi-driver.fullname" . }}-nodeplugin
rules:
- apiGroups: [""]
resources: ["pods"]
verbs: ["get", "list"]
- apiGroups: [""]
resources: ["events"]
verbs: ["get", "list", "watch", "create", "update", "patch"]
Expand Down
17 changes: 17 additions & 0 deletions cmd/plugin/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,22 @@ import (
goflag "flag"
"fmt"
"net/url"
"strings"
"time"

"github.com/container-storage-interface/spec/lib/go/csi"
flag "github.com/spf13/pflag"
"github.com/warm-metal/container-image-csi-driver/pkg/backend"
"github.com/warm-metal/container-image-csi-driver/pkg/backend/containerd"
"github.com/warm-metal/container-image-csi-driver/pkg/imagesize"

"github.com/warm-metal/container-image-csi-driver/pkg/backend/crio"
"github.com/warm-metal/container-image-csi-driver/pkg/cri"
"github.com/warm-metal/container-image-csi-driver/pkg/metrics"
"github.com/warm-metal/container-image-csi-driver/pkg/secret"
"github.com/warm-metal/container-image-csi-driver/pkg/watcher"
csicommon "github.com/warm-metal/csi-drivers/pkg/csi-common"
"k8s.io/apimachinery/pkg/api/resource"
"k8s.io/klog/v2"
)

Expand Down Expand Up @@ -56,6 +60,7 @@ var (
watcherResyncPeriod = flag.Duration("watcher-resync-period", 30*time.Minute, "The resync period of the pvc watcher.")
mode = flag.String("mode", "", "The mode of the driver. Valid values are: node, controller")
nodePluginSA = flag.String("node-plugin-sa", "csi-image-warm-metal", "The name of the ServiceAccount used by the node plugin.")
maxImageSize = flag.String("max-image-size", "", "if warm metal finds an image exceeding max image size it creates a warning event on the pod (empty or unset means no event should be logged)")
)

func main() {
Expand All @@ -79,6 +84,13 @@ func main() {
if len(*mode) == 0 {
klog.Fatalf("The mode of the driver is required.")
}
var size *resource.Quantity
size = nil
if flag.CommandLine.Changed("max-image-size") {
// remove beginning and trailing `"` if it is present
s := resource.MustParse(strings.Trim(*maxImageSize, "\""))
size = &s
}

server := csicommon.NewNonBlockingGRPCServer()

Expand Down Expand Up @@ -145,6 +157,11 @@ func main() {
)
}

if size != nil {
klog.Infof("'--max-image-size' is set to '%v'", size.String())
imagesize.Initialize(size)
defer imagesize.Warner.Cleanup()
}
metrics.StartMetricsServer(metrics.RegisterMetrics())
server.Wait()
}
14 changes: 14 additions & 0 deletions cmd/plugin/node_server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ const (
ctxKeyImage = "image"
ctxKeyPullAlways = "pullAlways"
ctxKeyEphemeralVolume = "csi.storage.k8s.io/ephemeral"
ctxKeyPodName = "csi.storage.k8s.io/pod.name"
ctxKeyPodNamespace = "csi.storage.k8s.io/pod.namespace"
)

type ImagePullStatus int
Expand Down Expand Up @@ -87,6 +89,16 @@ func (n NodeServer) NodePublishVolume(ctx context.Context, req *csi.NodePublishV
return
}

if len(req.VolumeContext[ctxKeyPodName]) == 0 {
err = status.Error(codes.InvalidArgument, "VolumeContext must have pod name")
return
}

if len(req.VolumeContext[ctxKeyPodNamespace]) == 0 {
err = status.Error(codes.InvalidArgument, "VolumeContext must have pod namespace")
return
}

if req.VolumeContext[ctxKeyEphemeralVolume] != "true" &&
req.VolumeCapability.AccessMode.Mode != csi.VolumeCapability_AccessMode_SINGLE_NODE_READER_ONLY &&
req.VolumeCapability.AccessMode.Mode != csi.VolumeCapability_AccessMode_MULTI_NODE_READER_ONLY {
Expand Down Expand Up @@ -137,6 +149,8 @@ func (n NodeServer) NodePublishVolume(ctx context.Context, req *csi.NodePublishV
Image: image,
PullSecrets: req.Secrets,
Logger: valuesLogger,
Pod: req.VolumeContext[ctxKeyPodName],
Namespace: req.VolumeContext[ctxKeyPodNamespace],
Comment on lines +152 to +153
Copy link
Collaborator

Choose a reason for hiding this comment

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

Adding these might also help fix the bug in current logs where pod and namespace are empty in the log messages for printing image size.

}

if e := n.pullExecutor.StartPulling(po); e != nil {
Expand Down
18 changes: 16 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,14 @@ require (
github.com/container-storage-interface/spec v1.6.0
github.com/containerd/containerd v1.6.8
github.com/containers/storage v1.43.0
github.com/distribution/reference v0.5.0
github.com/docker/cli v24.0.7+incompatible
github.com/docker/distribution v2.8.1+incompatible
github.com/docker/docker v24.0.7+incompatible
github.com/golang/protobuf v1.5.2
github.com/google/uuid v1.2.0
github.com/mitchellh/go-ps v1.0.0
github.com/opencontainers/go-digest v1.0.0
github.com/opencontainers/image-spec v1.1.0-rc2
github.com/pkg/errors v0.9.1
github.com/prometheus/client_golang v1.12.1
Expand All @@ -31,6 +36,7 @@ require (

require (
github.com/Azure/azure-sdk-for-go v55.0.0+incompatible // indirect
github.com/Azure/go-ansiterm v0.0.0-20210617225240-d185dfc1b5a1 // indirect
github.com/Azure/go-autorest v14.2.0+incompatible // indirect
github.com/Azure/go-autorest/autorest v0.11.27 // indirect
github.com/Azure/go-autorest/autorest/adal v0.9.20 // indirect
Expand All @@ -53,10 +59,14 @@ require (
github.com/containerd/ttrpc v1.1.0 // indirect
github.com/containerd/typeurl v1.0.2 // indirect
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/docker/distribution v2.8.1+incompatible // indirect
github.com/docker/docker-credential-helpers v0.6.3 // indirect
github.com/docker/go v1.5.1-1.0.20160303222718-d30aec9fd63c // indirect
github.com/docker/go-connections v0.4.0 // indirect
github.com/docker/go-events v0.0.0-20190806004212-e31b211e4f1c // indirect
github.com/docker/go-metrics v0.0.1 // indirect
github.com/docker/go-units v0.5.0 // indirect
github.com/emicklei/go-restful/v3 v3.8.0 // indirect
github.com/evanphx/json-patch v4.12.0+incompatible // indirect
github.com/go-logr/logr v1.2.3 // indirect
github.com/go-openapi/jsonpointer v0.19.5 // indirect
github.com/go-openapi/jsonreference v0.19.5 // indirect
Expand All @@ -69,6 +79,7 @@ require (
github.com/google/go-cmp v0.5.8 // indirect
github.com/google/go-intervals v0.0.2 // indirect
github.com/google/gofuzz v1.2.0 // indirect
github.com/gorilla/mux v1.8.0 // indirect
github.com/hashicorp/errwrap v1.1.0 // indirect
github.com/hashicorp/go-multierror v1.1.1 // indirect
github.com/imdario/mergo v0.3.12 // indirect
Expand All @@ -82,14 +93,16 @@ require (
github.com/mailru/easyjson v0.7.6 // indirect
github.com/mattn/go-shellwords v1.0.12 // indirect
github.com/matttproud/golang_protobuf_extensions v1.0.2-0.20181231171920-c182affec369 // indirect
github.com/miekg/pkcs11 v1.1.1 // indirect
github.com/mistifyio/go-zfs/v3 v3.0.0 // indirect
github.com/moby/locker v1.0.1 // indirect
github.com/moby/sys/mountinfo v0.6.2 // indirect
github.com/moby/sys/signal v0.7.0 // indirect
github.com/moby/term v0.0.0-20210619224110-3f7ff695adc6 // indirect
github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
github.com/modern-go/reflect2 v1.0.2 // indirect
github.com/morikuni/aec v1.0.0 // indirect
github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
github.com/opencontainers/go-digest v1.0.0 // indirect
github.com/opencontainers/runc v1.1.4 // indirect
github.com/opencontainers/runtime-spec v1.0.3-0.20210326190908-1c3f411f0417 // indirect
github.com/opencontainers/selinux v1.10.2 // indirect
Expand All @@ -101,6 +114,7 @@ require (
github.com/spf13/cobra v1.4.0 // indirect
github.com/syndtr/gocapability v0.0.0-20200815063812-42c35b437635 // indirect
github.com/tchap/go-patricia v2.3.0+incompatible // indirect
github.com/theupdateframework/notary v0.7.0 // indirect
github.com/ulikunitz/xz v0.5.10 // indirect
github.com/vbatts/tar-split v0.11.2 // indirect
go.opencensus.io v0.23.0 // indirect
Expand Down
Loading