Merge pull request #15 from fuweid/add-examples

mikebrow · web-flow · commit 8c8e228f3ecb · 2021-09-21T16:54:05.000-05:00
Update the examples in README.md
diff --git a/README.md b/README.md
@@ -101,59 +101,7 @@ A Go based API and client package will be created for both producers of plugins
 
 ### Sample Plugin
 
-**clearcfs**
-
-Clear the cfs quotas for `ls` services.
-
-
-```go
-package main
-
-import (
-	"context"
-	"fmt"
-	"os"
-
-	"github.com/containerd/containerd/pkg/nri/skel"
-	"github.com/containerd/containerd/pkg/nri/types"
-	"github.com/sirupsen/logrus"
-)
-
-var max = []byte("max")
-
-// clearCFS clears any cfs quotas for the containers
-type clearCFS struct {
-}
-
-func (c *clearCFS) Type() string {
-	return "clearcfs"
-}
-
-func (c *clearCFS) Invoke(ctx context.Context, r *types.Request) (*types.Result, error) {
-	result := r.NewResult()
-	if r.State != types.Create {
-		return result, nil
-	}
-	switch r.Spec.Annotations["qos.class"] {
-	case "ls":
-		logrus.Debugf("clearing cfs for %s", r.ID)
-		group, err := cg.Load(r.Spec.CgroupsPath)
-		if err != nil {
-			return nil, err
-		}
-		return result, group.Write(cg.CFSMax)
-	}
-	return result, nil
-}
-
-func main() {
-	ctx := context.Background()
-	if err := skel.Run(ctx, &clearCFS{}); err != nil {
-		fmt.Fprintf(os.Stderr, "%s", err)
-		os.Exit(1)
-	}
-}
-```
+* [clearcfs](examples/clearcfs/main.go)
 
 ## Project details
 
diff --git a/examples/clearcfs/main.go b/examples/clearcfs/main.go
@@ -0,0 +1,70 @@
+/*
+   Copyright The containerd Authors.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       https://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+*/
+
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+
+	"github.com/containerd/cgroups"
+	"github.com/containerd/nri/skel"
+	types "github.com/containerd/nri/types/v1"
+	"github.com/opencontainers/runtime-spec/specs-go"
+	"github.com/sirupsen/logrus"
+)
+
+// clearCFS clears any cfs quotas for the containers
+type clearCFS struct {
+}
+
+func (c *clearCFS) Type() string {
+	return "clearcfs"
+}
+
+func (c *clearCFS) Invoke(ctx context.Context, r *types.Request) (*types.Result, error) {
+	result := r.NewResult(c.Type())
+
+	if r.State != types.Create {
+		return result, nil
+	}
+
+	switch r.Spec.Annotations["qos.class"] {
+	case "ls":
+		logrus.Debugf("clearing cfs for %s", r.ID)
+		control, err := cgroups.Load(cgroups.V1, cgroups.StaticPath(r.Spec.CgroupsPath))
+		if err != nil {
+			return nil, err
+		}
+
+		quota := int64(-1)
+		return result, control.Update(&specs.LinuxResources{
+			CPU: &specs.LinuxCPU{
+				Quota: &quota,
+			},
+		})
+	}
+	return result, nil
+}
+
+func main() {
+	ctx := context.Background()
+	if err := skel.Run(ctx, &clearCFS{}); err != nil {
+		fmt.Fprintf(os.Stderr, "%s", err)
+		os.Exit(1)
+	}
+}
diff --git a/examples/go.mod b/examples/go.mod
@@ -0,0 +1,12 @@
+module github.com/containerd/nri/examples
+
+go 1.16
+
+require (
+	github.com/containerd/cgroups v1.0.1
+	github.com/containerd/nri v0.1.0
+	github.com/opencontainers/runtime-spec v1.0.3-0.20200929063507-e6143ca7d51d
+	github.com/sirupsen/logrus v1.8.1
+)
+
+replace github.com/containerd/nri => ../
diff --git a/examples/go.sum b/examples/go.sum
