diff --git a/.generated_docs b/.generated_docs
index f36b59e130dfb..1bcefdf9d556d 100644
--- a/.generated_docs
+++ b/.generated_docs
@@ -28,6 +28,7 @@ docs/man/man1/kubectl-convert.1
docs/man/man1/kubectl-cordon.1
docs/man/man1/kubectl-create-configmap.1
docs/man/man1/kubectl-create-namespace.1
+docs/man/man1/kubectl-create-quota.1
docs/man/man1/kubectl-create-secret-docker-registry.1
docs/man/man1/kubectl-create-secret-generic.1
docs/man/man1/kubectl-create-secret-tls.1
@@ -89,6 +90,7 @@ docs/user-guide/kubectl/kubectl_cordon.md
docs/user-guide/kubectl/kubectl_create.md
docs/user-guide/kubectl/kubectl_create_configmap.md
docs/user-guide/kubectl/kubectl_create_namespace.md
+docs/user-guide/kubectl/kubectl_create_quota.md
docs/user-guide/kubectl/kubectl_create_secret.md
docs/user-guide/kubectl/kubectl_create_secret_docker-registry.md
docs/user-guide/kubectl/kubectl_create_secret_generic.md
diff --git a/docs/man/man1/kubectl-create-quota.1 b/docs/man/man1/kubectl-create-quota.1
new file mode 100644
index 0000000000000..b6fd7a0f9896b
--- /dev/null
+++ b/docs/man/man1/kubectl-create-quota.1
@@ -0,0 +1,3 @@
+This file is autogenerated, but we've stopped checking such files into the
+repository to reduce the need for rebases. Please run hack/generate-docs.sh to
+populate this file.
diff --git a/docs/user-guide/kubectl/kubectl_create_quota.md b/docs/user-guide/kubectl/kubectl_create_quota.md
new file mode 100644
index 0000000000000..185d3bea1e972
--- /dev/null
+++ b/docs/user-guide/kubectl/kubectl_create_quota.md
@@ -0,0 +1,36 @@
+
+
+
+
+
+
+
+
+
+
+PLEASE NOTE: This document applies to the HEAD of the source tree
+
+If you are using a released version of Kubernetes, you should
+refer to the docs that go with that version.
+
+Documentation for other releases can be found at
+[releases.k8s.io](http://releases.k8s.io).
+
+--
+
+
+
+
+
+This file is autogenerated, but we've stopped checking such files into the
+repository to reduce the need for rebases. Please run hack/generate-docs.sh to
+populate this file.
+
+
+[]()
+
diff --git a/hack/verify-flags/known-flags.txt b/hack/verify-flags/known-flags.txt
index 678db563bf627..5e041bd1515ca 100644
--- a/hack/verify-flags/known-flags.txt
+++ b/hack/verify-flags/known-flags.txt
@@ -419,6 +419,7 @@ save-config
scheduler-config
scheduler-name
schema-cache-dir
+scopes
seccomp-profile-root
secure-port
serialize-image-pulls
diff --git a/pkg/kubectl/cmd/create_quota.go b/pkg/kubectl/cmd/create_quota.go
index 26ba236b44e96..2be38d436e54b 100644
--- a/pkg/kubectl/cmd/create_quota.go
+++ b/pkg/kubectl/cmd/create_quota.go
@@ -1,5 +1,5 @@
/*
-Copyright 2015 The Kubernetes Authors All rights reserved.
+Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -28,16 +28,19 @@ import (
const (
quotaLong = `
-Create a resourcequota with the specified name and hard limits`
+Create a resourcequota with the specified name, hard limits and optional scopes`
quotaExample = ` // Create a new resourcequota named my-quota
- $ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10`
+ $ kubectl create quota my-quota --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10
+
+ // Create a new resourcequota named best-effort
+ $ kubectl create quota best-effort --hard=pods=100 --scopes=BestEffort`
)
// NewCmdCreateQuota is a macro command to create a new quota
func NewCmdCreateQuota(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command {
cmd := &cobra.Command{
- Use: "quota NAME [--hard=key1=value1,key2=value2] [--dry-run=bool]",
+ Use: "quota NAME [--hard=key1=value1,key2=value2] [--scopes=Scope1,Scope2] [--dry-run=bool]",
Aliases: []string{"q"},
Short: "Create a quota with the specified name.",
Long: quotaLong,
@@ -50,9 +53,10 @@ func NewCmdCreateQuota(f *cmdutil.Factory, cmdOut io.Writer) *cobra.Command {
cmdutil.AddApplyAnnotationFlags(cmd)
cmdutil.AddValidateFlags(cmd)
+ cmdutil.AddPrinterFlags(cmd)
cmdutil.AddGeneratorFlags(cmd, cmdutil.ResourceQuotaV1GeneratorName)
- cmd.Flags().String("hard", "", "Specify multiple key/value pair to insert in resourcequota (i.e. --hard=cpu=1,memory=1G,pods=2,services=3,replicationcontrollers=2,resourcequotas=1,secrets=5,persistentvolumeclaims=10)")
- cmd.MarkFlagRequired("hard")
+ cmd.Flags().String("hard", "", "A comma-delimited set of resource=quantity pairs that define a hard limit.")
+ cmd.Flags().String("scopes", "", "A comma-delimited set of quota scopes that must all match each object tracked by the quota.")
return cmd
}
@@ -62,18 +66,13 @@ func CreateQuota(f *cmdutil.Factory, cmdOut io.Writer, cmd *cobra.Command, args
if err != nil {
return err
}
- requiredFlags := []string{"hard"}
- for _, requiredFlag := range requiredFlags {
- if value := cmdutil.GetFlagString(cmd, requiredFlag); len(value) == 0 {
- return cmdutil.UsageError(cmd, "flag %s is required", requiredFlag)
- }
- }
var generator kubectl.StructuredGenerator
switch generatorName := cmdutil.GetFlagString(cmd, "generator"); generatorName {
case cmdutil.ResourceQuotaV1GeneratorName:
generator = &kubectl.ResourceQuotaGeneratorV1{
- Name: name,
- Hard: cmdutil.GetFlagString(cmd, "hard"),
+ Name: name,
+ Hard: cmdutil.GetFlagString(cmd, "hard"),
+ Scopes: cmdutil.GetFlagString(cmd, "scopes"),
}
default:
return cmdutil.UsageError(cmd, fmt.Sprintf("Generator: %s not supported.", generatorName))
diff --git a/pkg/kubectl/cmd/create_quota_test.go b/pkg/kubectl/cmd/create_quota_test.go
index cbaf779e57575..270e4fce22408 100644
--- a/pkg/kubectl/cmd/create_quota_test.go
+++ b/pkg/kubectl/cmd/create_quota_test.go
@@ -1,5 +1,5 @@
/*
-Copyright 2014 The Kubernetes Authors All rights reserved.
+Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -28,14 +28,14 @@ import (
func TestCreateQuota(t *testing.T) {
resourceQuotaObject := &api.ResourceQuota{}
resourceQuotaObject.Name = "my-quota"
- f, tf, codec := NewAPIFactory()
+ f, tf, codec, ns := NewAPIFactory()
tf.Printer = &testPrinter{}
tf.Client = &fake.RESTClient{
- Codec: codec,
+ NegotiatedSerializer: ns,
Client: fake.CreateHTTPClient(func(req *http.Request) (*http.Response, error) {
switch p, m := req.URL.Path, req.Method; {
case p == "/namespaces/test/resourcequotas" && m == "POST":
- return &http.Response{StatusCode: 201, Body: objBody(codec, resourceQuotaObject)}, nil
+ return &http.Response{StatusCode: 201, Header: defaultHeader(), Body: objBody(codec, resourceQuotaObject)}, nil
default:
t.Fatalf("unexpected request: %#v\n%#v", req.URL, req)
return nil, nil
@@ -43,13 +43,37 @@ func TestCreateQuota(t *testing.T) {
}),
}
tf.Namespace = "test"
- buf := bytes.NewBuffer([]byte{})
- cmd := NewCmdCreateQuota(f, buf)
- cmd.Flags().Set("hard", "cpu=1")
- cmd.Flags().Set("output", "name")
- cmd.Run(cmd, []string{resourceQuotaObject.Name})
- expectedOutput := "resourcequota/" + resourceQuotaObject.Name + "\n"
- if buf.String() != expectedOutput {
- t.Errorf("expected output: %s, but got: %s", expectedOutput, buf.String())
+
+ tests := map[string]struct {
+ flags map[string]string
+ expectedOutput string
+ }{
+ "single resource": {
+ flags: map[string]string{"hard": "cpu=1", "output": "name"},
+ expectedOutput: "resourcequota/" + resourceQuotaObject.Name + "\n",
+ },
+ "single resource with a scope": {
+ flags: map[string]string{"hard": "cpu=1", "output": "name", "scopes": "BestEffort"},
+ expectedOutput: "resourcequota/" + resourceQuotaObject.Name + "\n",
+ },
+ "multiple resources": {
+ flags: map[string]string{"hard": "cpu=1,pods=42", "output": "name", "scopes": "BestEffort"},
+ expectedOutput: "resourcequota/" + resourceQuotaObject.Name + "\n",
+ },
+ "single resource with multiple scopes": {
+ flags: map[string]string{"hard": "cpu=1", "output": "name", "scopes": "BestEffort,NotTerminating"},
+ expectedOutput: "resourcequota/" + resourceQuotaObject.Name + "\n",
+ },
+ }
+ for name, test := range tests {
+ buf := bytes.NewBuffer([]byte{})
+ cmd := NewCmdCreateQuota(f, buf)
+ cmd.Flags().Set("hard", "cpu=1")
+ cmd.Flags().Set("output", "name")
+ cmd.Run(cmd, []string{resourceQuotaObject.Name})
+
+ if buf.String() != test.expectedOutput {
+ t.Errorf("%s: expected output: %s, but got: %s", name, test.expectedOutput, buf.String())
+ }
}
}
diff --git a/pkg/kubectl/quota.go b/pkg/kubectl/quota.go
index e6409905b5256..1261aba20b556 100644
--- a/pkg/kubectl/quota.go
+++ b/pkg/kubectl/quota.go
@@ -1,5 +1,5 @@
/*
-Copyright 2015 The Kubernetes Authors All rights reserved.
+Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -18,17 +18,22 @@ package kubectl
import (
"fmt"
+ "strings"
"k8s.io/kubernetes/pkg/api"
- "k8s.io/kubernetes/pkg/api/resource"
"k8s.io/kubernetes/pkg/runtime"
- "strings"
)
-// ResourceQuotaGeneratorV1 supports stable generation of a namespace
+// ResourceQuotaGeneratorV1 supports stable generation of a resource quota
type ResourceQuotaGeneratorV1 struct {
+ // The name of a quota object.
Name string
+
+ // The hard resource limit string before parsing.
Hard string
+
+ // The scopes of a quota object before parsing.
+ Scopes string
}
// ParamNames returns the set of supported input parameters when using the parameter injection generator pattern
@@ -36,6 +41,7 @@ func (g ResourceQuotaGeneratorV1) ParamNames() []GeneratorParam {
return []GeneratorParam{
{"name", true},
{"hard", true},
+ {"scopes", false},
}
}
@@ -63,6 +69,7 @@ func (g ResourceQuotaGeneratorV1) Generate(genericParams map[string]interface{})
delegate := &ResourceQuotaGeneratorV1{}
delegate.Name = params["name"]
delegate.Hard = params["hard"]
+ delegate.Scopes = params["scopes"]
return delegate.StructuredGenerate()
}
@@ -72,38 +79,23 @@ func (g *ResourceQuotaGeneratorV1) StructuredGenerate() (runtime.Object, error)
return nil, err
}
- resourceQuotaSpec, err := generateResourceQuotaSpecList(g.Hard)
+ resourceList, err := populateResourceList(g.Hard)
+ if err != nil {
+ return nil, err
+ }
+
+ scopes, err := parseScopes(g.Scopes)
if err != nil {
return nil, err
}
resourceQuota := &api.ResourceQuota{}
resourceQuota.Name = g.Name
- resourceQuota.Spec.Hard = resourceQuotaSpec
+ resourceQuota.Spec.Hard = resourceList
+ resourceQuota.Spec.Scopes = scopes
return resourceQuota, nil
}
-func generateResourceQuotaSpecList(hard string) (resourceList api.ResourceList, err error) {
-
- defer func() {
- if p := recover(); p != nil {
- resourceList = nil
- err = fmt.Errorf("Invalid input %v", p)
- }
- }()
-
- resourceList = make(api.ResourceList)
- for _, keyValue := range strings.Split(hard, ",") {
- items := strings.Split(keyValue, "=")
- if len(items) != 2 {
- return nil, fmt.Errorf("invalid input %v, expected key=value", keyValue)
- }
-
- resourceList[api.ResourceName(items[0])] = resource.MustParse(items[1])
- }
- return
-}
-
// validate validates required fields are set to support structured generation
func (r *ResourceQuotaGeneratorV1) validate() error {
if len(r.Name) == 0 {
@@ -111,3 +103,23 @@ func (r *ResourceQuotaGeneratorV1) validate() error {
}
return nil
}
+
+func parseScopes(spec string) ([]api.ResourceQuotaScope, error) {
+ // empty input gets a nil response to preserve generator test expected behaviors
+ if spec == "" {
+ return nil, nil
+ }
+
+ scopes := strings.Split(spec, ",")
+ result := make([]api.ResourceQuotaScope, 0, len(scopes))
+ for _, scope := range scopes {
+ // intentionally do not verify the scope against the valid scope list. This is done by the apiserver anyway.
+
+ if scope == "" {
+ return nil, fmt.Errorf("invalid resource quota scope \"\"")
+ }
+
+ result = append(result, api.ResourceQuotaScope(scope))
+ }
+ return result, nil
+}
diff --git a/pkg/kubectl/quota_test.go b/pkg/kubectl/quota_test.go
index 07075f3bc44a6..930ded039b7e4 100644
--- a/pkg/kubectl/quota_test.go
+++ b/pkg/kubectl/quota_test.go
@@ -1,5 +1,5 @@
/*
-Copyright 2015 The Kubernetes Authors All rights reserved.
+Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
@@ -25,7 +25,7 @@ import (
func TestQuotaGenerate(t *testing.T) {
hard := "cpu=10,memory=5G,pods=10,services=7"
- resourceQuotaSpecList, err := generateResourceQuotaSpecList(hard)
+ resourceQuotaSpecList, err := populateResourceList(hard)
if err != nil {
t.Errorf("unexpected error: %v", err)
}
@@ -54,28 +54,61 @@ func TestQuotaGenerate(t *testing.T) {
},
expectErr: true,
},
+ "test-valid-scopes": {
+ params: map[string]interface{}{
+ "name": "foo",
+ "hard": hard,
+ "scopes": "BestEffort,NotTerminating",
+ },
+ expected: &api.ResourceQuota{
+ ObjectMeta: api.ObjectMeta{
+ Name: "foo",
+ },
+ Spec: api.ResourceQuotaSpec{
+ Hard: resourceQuotaSpecList,
+ Scopes: []api.ResourceQuotaScope{
+ api.ResourceQuotaScopeBestEffort,
+ api.ResourceQuotaScopeNotTerminating,
+ },
+ },
+ },
+ expectErr: false,
+ },
+ "test-empty-scopes": {
+ params: map[string]interface{}{
+ "name": "foo",
+ "hard": hard,
+ "scopes": "",
+ },
+ expected: &api.ResourceQuota{
+ ObjectMeta: api.ObjectMeta{
+ Name: "foo",
+ },
+ Spec: api.ResourceQuotaSpec{Hard: resourceQuotaSpecList},
+ },
+ expectErr: false,
+ },
+ "test-invalid-scopes": {
+ params: map[string]interface{}{
+ "name": "foo",
+ "hard": hard,
+ "scopes": "abc,",
+ },
+ expectErr: true,
+ },
}
generator := ResourceQuotaGeneratorV1{}
- for _, test := range tests {
+ for name, test := range tests {
obj, err := generator.Generate(test.params)
if !test.expectErr && err != nil {
- t.Errorf("unexpected error: %v", err)
+ t.Errorf("%s: unexpected error: %v", name, err)
}
if test.expectErr && err != nil {
continue
}
if !reflect.DeepEqual(obj.(*api.ResourceQuota), test.expected) {
- t.Errorf("\nexpected:\n%#v\nsaw:\n%#v", test.expected, obj.(*api.ResourceQuota))
+ t.Errorf("%s:\nexpected:\n%#v\nsaw:\n%#v", name, test.expected, obj.(*api.ResourceQuota))
}
}
}
-
-func TestGenerateResourceQuotaSpecList(t *testing.T) {
- hardInvalidValue := "cpu=23foo,memory=5G,pods=10bar,services=7"
-
- resourceList, err := generateResourceQuotaSpecList(hardInvalidValue)
- if err != nil && resourceList != nil {
- t.Errorf("\nexpected:\n%#v\nsaw:\n%#v", nil, resourceList)
- }
-}
diff --git a/test/e2e/kubectl.go b/test/e2e/kubectl.go
index 1b4bac72661b1..89b7d949c37e5 100644
--- a/test/e2e/kubectl.go
+++ b/test/e2e/kubectl.go
@@ -44,6 +44,7 @@ import (
"k8s.io/kubernetes/pkg/api"
"k8s.io/kubernetes/pkg/api/annotations"
apierrs "k8s.io/kubernetes/pkg/api/errors"
+ "k8s.io/kubernetes/pkg/api/resource"
"k8s.io/kubernetes/pkg/api/unversioned"
client "k8s.io/kubernetes/pkg/client/unversioned"
"k8s.io/kubernetes/pkg/controller"
@@ -1198,6 +1199,76 @@ var _ = framework.KubeDescribe("Kubectl client", func() {
})
})
+
+ framework.KubeDescribe("Kubectl create quota", func() {
+ It("should create a quota without scopes", func() {
+ nsFlag := fmt.Sprintf("--namespace=%v", ns)
+ quotaName := "million"
+
+ By("calling kubectl quota")
+ framework.RunKubectlOrDie("create", "quota", quotaName, "--hard=pods=1000000,services=1000000", nsFlag)
+
+ By("verifying that the quota was created")
+ quota, err := c.ResourceQuotas(ns).Get(quotaName)
+ if err != nil {
+ framework.Failf("Failed getting quota %s: %v", quotaName, err)
+ }
+
+ if len(quota.Spec.Scopes) != 0 {
+ framework.Failf("Expected empty scopes, got %v", quota.Spec.Scopes)
+ }
+ if len(quota.Spec.Hard) != 2 {
+ framework.Failf("Expected two resources, got %v", quota.Spec.Hard)
+ }
+ r, found := quota.Spec.Hard[api.ResourcePods]
+ if expected := resource.MustParse("1000000"); !found || (&r).Cmp(expected) != 0 {
+ framework.Failf("Expected pods=1000000, got %v", r)
+ }
+ r, found = quota.Spec.Hard[api.ResourceServices]
+ if expected := resource.MustParse("1000000"); !found || (&r).Cmp(expected) != 0 {
+ framework.Failf("Expected services=1000000, got %v", r)
+ }
+ })
+
+ It("should create a quota with scopes", func() {
+ nsFlag := fmt.Sprintf("--namespace=%v", ns)
+ quotaName := "scopes"
+
+ By("calling kubectl quota")
+ framework.RunKubectlOrDie("create", "quota", quotaName, "--hard=pods=1000000", "--scopes=BestEffort,NotTerminating", nsFlag)
+
+ By("verifying that the quota was created")
+ quota, err := c.ResourceQuotas(ns).Get(quotaName)
+ if err != nil {
+ framework.Failf("Failed getting quota %s: %v", quotaName, err)
+ }
+
+ if len(quota.Spec.Scopes) != 2 {
+ framework.Failf("Expected two scopes, got %v", quota.Spec.Scopes)
+ }
+ scopes := make(map[api.ResourceQuotaScope]struct{})
+ for _, scope := range quota.Spec.Scopes {
+ scopes[scope] = struct{}{}
+ }
+ if _, found := scopes[api.ResourceQuotaScopeBestEffort]; !found {
+ framework.Failf("Expected BestEffort scope, got %v", quota.Spec.Scopes)
+ }
+ if _, found := scopes[api.ResourceQuotaScopeNotTerminating]; !found {
+ framework.Failf("Expected NotTerminating scope, got %v", quota.Spec.Scopes)
+ }
+ })
+
+ It("should reject quota with invalid scopes", func() {
+ nsFlag := fmt.Sprintf("--namespace=%v", ns)
+ quotaName := "scopes"
+
+ By("calling kubectl quota")
+ out, err := framework.RunKubectl("create", "quota", quotaName, "--hard=hard=pods=1000000", "--scopes=Foo", nsFlag)
+ if err == nil {
+ framework.Failf("Expected kubectl to fail, but it succeeded: %s", out)
+ }
+ })
+ })
})
// Checks whether the output split by line contains the required elements.