diff --git a/.generated_docs b/.generated_docs index 059320fec6..6d76553002 100644 --- a/.generated_docs +++ b/.generated_docs @@ -72,6 +72,7 @@ docs/man/man1/kubectl-rollout.1 docs/man/man1/kubectl-run.1 docs/man/man1/kubectl-scale.1 docs/man/man1/kubectl-set-image.1 +docs/man/man1/kubectl-set-resources.1 docs/man/man1/kubectl-set.1 docs/man/man1/kubectl-stop.1 docs/man/man1/kubectl-taint.1 @@ -146,6 +147,7 @@ docs/user-guide/kubectl/kubectl_run.md docs/user-guide/kubectl/kubectl_scale.md docs/user-guide/kubectl/kubectl_set.md docs/user-guide/kubectl/kubectl_set_image.md +docs/user-guide/kubectl/kubectl_set_resources.md docs/user-guide/kubectl/kubectl_taint.md docs/user-guide/kubectl/kubectl_top.md docs/user-guide/kubectl/kubectl_top_node.md diff --git a/docs/man/man1/kubectl-set-resources.1 b/docs/man/man1/kubectl-set-resources.1 new file mode 100644 index 0000000000..b6fd7a0f98 --- /dev/null +++ b/docs/man/man1/kubectl-set-resources.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_set_resources.md b/docs/user-guide/kubectl/kubectl_set_resources.md new file mode 100644 index 0000000000..1b6cbb2afb --- /dev/null +++ b/docs/user-guide/kubectl/kubectl_set_resources.md @@ -0,0 +1,36 @@ + + + + +WARNING +WARNING +WARNING +WARNING +WARNING + +

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. + + +[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_set_resources.md?pixel)]() + diff --git a/hack/make-rules/test-cmd.sh b/hack/make-rules/test-cmd.sh index 6ab1e26edf..053d38086c 100755 --- a/hack/make-rules/test-cmd.sh +++ b/hack/make-rules/test-cmd.sh @@ -2115,6 +2115,37 @@ __EOF__ # Clean up kubectl delete rc frontend "${kube_flags[@]}" + ## Set resource limits/request of a deployment + # Pre-condition: no deployment exists + kube::test::get_object_assert deployment "{{range.items}}{{$id_field}}:{{end}}" '' + # Create a deployment + kubectl create -f hack/testdata/deployment-multicontainer.yaml "${kube_flags[@]}" + kube::test::get_object_assert deployment "{{range.items}}{{$id_field}}:{{end}}" 'nginx-deployment:' + kube::test::get_object_assert deployment "{{range.items}}{{$deployment_image_field}}:{{end}}" "${IMAGE_DEPLOYMENT_R1}:" + kube::test::get_object_assert deployment "{{range.items}}{{$deployment_second_image_field}}:{{end}}" "${IMAGE_PERL}:" + # Set the deployment's cpu limits + kubectl set resources deployment nginx-deployment --limits=cpu=100m "${kube_flags[@]}" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 0).resources.limits.cpu}}:{{end}}" "100m:" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 1).resources.limits.cpu}}:{{end}}" "100m:" + # Set a non-existing container should fail + ! kubectl set resources deployment nginx-deployment -c=redis --limits=cpu=100m + # Set the limit of a specific container in deployment + kubectl set resources deployment nginx-deployment -c=nginx --limits=cpu=200m "${kube_flags[@]}" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 0).resources.limits.cpu}}:{{end}}" "200m:" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 1).resources.limits.cpu}}:{{end}}" "100m:" + # Set limits/requests of a deployment specified by a file + kubectl set resources -f hack/testdata/deployment-multicontainer.yaml -c=perl --limits=cpu=300m --requests=cpu=300m "${kube_flags[@]}" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 0).resources.limits.cpu}}:{{end}}" "200m:" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 1).resources.limits.cpu}}:{{end}}" "300m:" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 1).resources.requests.cpu}}:{{end}}" "300m:" + # Set limits on a local file without talking to the server + kubectl set resources deployment -f hack/testdata/deployment-multicontainer.yaml -c=perl --limits=cpu=300m --requests=cpu=300m --dry-run -o yaml "${kube_flags[@]}" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 0).resources.limits.cpu}}:{{end}}" "200m:" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 1).resources.limits.cpu}}:{{end}}" "300m:" + kube::test::get_object_assert deployment "{{range.items}}{{(index .spec.template.spec.containers 1).resources.requests.cpu}}:{{end}}" "300m:" + # Clean up + kubectl delete deployment nginx-deployment "${kube_flags[@]}" + ###################### # Deployments # diff --git a/pkg/kubectl/cmd/set/set.go b/pkg/kubectl/cmd/set/set.go index 23243119b5..c15f5264f6 100644 --- a/pkg/kubectl/cmd/set/set.go +++ b/pkg/kubectl/cmd/set/set.go @@ -33,7 +33,6 @@ var ( ) func NewCmdSet(f cmdutil.Factory, out, err io.Writer) *cobra.Command { - cmd := &cobra.Command{ Use: "set SUBCOMMAND", Short: "Set specific features on objects", @@ -46,6 +45,7 @@ func NewCmdSet(f cmdutil.Factory, out, err io.Writer) *cobra.Command { // add subcommands cmd.AddCommand(NewCmdImage(f, out, err)) + cmd.AddCommand(NewCmdResources(f, out, err)) return cmd } diff --git a/pkg/kubectl/cmd/set/set_resources.go b/pkg/kubectl/cmd/set/set_resources.go new file mode 100644 index 0000000000..dcb97e6d38 --- /dev/null +++ b/pkg/kubectl/cmd/set/set_resources.go @@ -0,0 +1,232 @@ +/* +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. +You may obtain a copy of the License at + + http://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 set + +import ( + "fmt" + "io" + + "github.com/spf13/cobra" + "k8s.io/kubernetes/pkg/api" + "k8s.io/kubernetes/pkg/api/meta" + + "k8s.io/kubernetes/pkg/kubectl" + cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util" + "k8s.io/kubernetes/pkg/kubectl/resource" + "k8s.io/kubernetes/pkg/runtime" + utilerrors "k8s.io/kubernetes/pkg/util/errors" +) + +// ResourcesOptions is the start of the data required to perform the operation. As new fields are added, add them here instead of +// referencing the cmd.Flags +type ResourcesOptions struct { + resource.FilenameOptions + + Mapper meta.RESTMapper + Typer runtime.ObjectTyper + Infos []*resource.Info + Encoder runtime.Encoder + Out io.Writer + Err io.Writer + Selector string + ContainerSelector string + ShortOutput bool + All bool + Record bool + ChangeCause string + Cmd *cobra.Command + + Limits string + Requests string + ResourceRequirements api.ResourceRequirements + + PrintObject func(cmd *cobra.Command, mapper meta.RESTMapper, obj runtime.Object, out io.Writer) error + UpdatePodSpecForObject func(obj runtime.Object, fn func(*api.PodSpec) error) (bool, error) + Resources []string +} + +const ( + resources_long = `Specify compute resource requirements (cpu, memory) for any resource that defines a pod template. If a pod is successfully scheduled, it is guaranteed the amount of resource requested, but may burst up to its specified limits. + +for each compute resource, if a limit is specified and a request is omitted, the request will default to the limit. + +Possible resources include (case insensitive):` + + resources_example = ` +# Set a deployments nginx container cpu limits to "200m and memory to "512Mi" + +kubectl set resources deployment nginx -c=nginx --limits=cpu=200m,memory=512Mi + +# Set the resource request and limits for all containers in nginx + +kubectl set resources deployment nginx --limits=cpu=200m,memory=512Mi --requests=cpu=100m,memory=256Mi + +# Remove the resource requests for resources on containers in nginx + +kubectl set resources deployment nginx --limits=cpu=0,memory=0 --requests=cpu=0,memory=0 + +# Print the result (in yaml format) of updating nginx container limits from a local, without hitting the server + +kubectl set resources -f path/to/file.yaml --limits=cpu=200m,memory=512Mi --dry-run -o yaml +` +) + +func NewCmdResources(f cmdutil.Factory, out io.Writer, errOut io.Writer) *cobra.Command { + options := &ResourcesOptions{ + Out: out, + Err: errOut, + } + var pod_specs string + RESTMappings := cmdutil.ResourcesWithPodSpecs() + for _, Map := range RESTMappings { + pod_specs = pod_specs + ", " + Map.Resource + + } + + cmd := &cobra.Command{ + Use: "resources (-f FILENAME | TYPE NAME) ([--limits=LIMITS & --requests=REQUESTS]", + Short: "update resource requests/limits on objects with pod templates", + Long: resources_long + "\n" + pod_specs[2:], + Example: resources_example, + Run: func(cmd *cobra.Command, args []string) { + cmdutil.CheckErr(options.Complete(f, cmd, args)) + cmdutil.CheckErr(options.Validate()) + cmdutil.CheckErr(options.Run()) + }, + } + + cmdutil.AddPrinterFlags(cmd) + //usage := "Filename, directory, or URL to a file identifying the resource to get from the server" + //kubectl.AddJsonFilenameFlag(cmd, &options.Filenames, usage) + usage := "identifying the resource to get from a server." + cmdutil.AddFilenameOptionFlags(cmd, &options.FilenameOptions, usage) + cmd.Flags().BoolVar(&options.All, "all", false, "select all resources in the namespace of the specified resource types") + cmd.Flags().StringVarP(&options.Selector, "selector", "l", "", "Selector (label query) to filter on") + cmd.Flags().StringVarP(&options.ContainerSelector, "containers", "c", "*", "The names of containers in the selected pod templates to change, all containers are selected by default - may use wildcards") + cmdutil.AddDryRunFlag(cmd) + cmdutil.AddRecordFlag(cmd) + cmd.Flags().StringVar(&options.Limits, "limits", options.Limits, "The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.") + cmd.Flags().StringVar(&options.Requests, "requests", options.Requests, "The resource requirement requests for this container. For example, 'cpu=100m,memory=256Mi'. Note that server side components may assign requests depending on the server configuration, such as limit ranges.") + return cmd +} + +func (o *ResourcesOptions) Complete(f cmdutil.Factory, cmd *cobra.Command, args []string) error { + o.Mapper, o.Typer = f.Object() + o.UpdatePodSpecForObject = f.UpdatePodSpecForObject + o.Encoder = f.JSONEncoder() + o.ShortOutput = cmdutil.GetFlagString(cmd, "output") == "name" + o.Record = cmdutil.GetRecordFlag(cmd) + o.ChangeCause = f.Command() + o.PrintObject = f.PrintObject + o.Cmd = cmd + + cmdNamespace, enforceNamespace, err := f.DefaultNamespace() + if err != nil { + return err + } + + builder := resource.NewBuilder(o.Mapper, o.Typer, resource.ClientMapperFunc(f.ClientForMapping), f.Decoder(true)). + ContinueOnError(). + NamespaceParam(cmdNamespace).DefaultNamespace(). + //FilenameParam(enforceNamespace, o.Filenames...). + FilenameParam(enforceNamespace, &o.FilenameOptions). + Flatten() + if !cmdutil.GetDryRunFlag(cmd) { + builder = builder. + SelectorParam(o.Selector). + ResourceTypeOrNameArgs(o.All, args...). + Latest() + } + + o.Infos, err = builder.Do().Infos() + if err != nil { + return err + } + return nil +} + +func (o *ResourcesOptions) Validate() error { + var err error + if len(o.Limits) == 0 && len(o.Requests) == 0 { + return fmt.Errorf("you must specify an update to requests or limits or (in the form of --requests/--limits)") + } + + o.ResourceRequirements, err = kubectl.HandleResourceRequirements(map[string]string{"limits": o.Limits, "requests": o.Requests}) + if err != nil { + return err + } + + return nil +} + +func (o *ResourcesOptions) Run() error { + allErrs := []error{} + patches := CalculatePatches(o.Infos, o.Encoder, func(info *resource.Info) (bool, error) { + transformed := false + _, err := o.UpdatePodSpecForObject(info.Object, func(spec *api.PodSpec) error { + containers, _ := selectContainers(spec.Containers, o.ContainerSelector) + if len(containers) != 0 { + for i := range containers { + containers[i].Resources = o.ResourceRequirements + transformed = true + } + } else { + allErrs = append(allErrs, fmt.Errorf("error: unable to find container named %s", o.ContainerSelector)) + } + return nil + }) + return transformed, err + }) + + for _, patch := range patches { + info := patch.Info + if patch.Err != nil { + allErrs = append(allErrs, fmt.Errorf("error: %s/%s %v\n", info.Mapping.Resource, info.Name, patch.Err)) + continue + } + + //no changes + if string(patch.Patch) == "{}" || len(patch.Patch) == 0 { + allErrs = append(allErrs, fmt.Errorf("info: %s %q was not changed\n", info.Mapping.Resource, info.Name)) + continue + } + + if cmdutil.GetDryRunFlag(o.Cmd) { + fmt.Fprintln(o.Err, "info: running in local mode...") + return o.PrintObject(o.Cmd, o.Mapper, info.Object, o.Out) + } + + obj, err := resource.NewHelper(info.Client, info.Mapping).Patch(info.Namespace, info.Name, api.StrategicMergePatchType, patch.Patch) + if err != nil { + allErrs = append(allErrs, fmt.Errorf("failed to patch limit update to pod template %v\n", err)) + continue + } + info.Refresh(obj, true) + + //record this change (for rollout history) + if o.Record || cmdutil.ContainsChangeCause(info) { + if err := cmdutil.RecordChangeCause(obj, o.ChangeCause); err == nil { + if obj, err = resource.NewHelper(info.Client, info.Mapping).Replace(info.Namespace, info.Name, false, obj); err != nil { + allErrs = append(allErrs, fmt.Errorf("changes to %s/%s can't be recorded: %v\n", info.Mapping.Resource, info.Name, err)) + } + } + } + info.Refresh(obj, true) + cmdutil.PrintSuccess(o.Mapper, o.ShortOutput, o.Out, info.Mapping.Resource, info.Name, false, "resource requirements updated") + } + return utilerrors.NewAggregate(allErrs) +} diff --git a/pkg/kubectl/cmd/util/factory.go b/pkg/kubectl/cmd/util/factory.go index 78ae76cda2..985ec1419e 100644 --- a/pkg/kubectl/cmd/util/factory.go +++ b/pkg/kubectl/cmd/util/factory.go @@ -1396,3 +1396,20 @@ func registerThirdPartyResources(discoveryClient discovery.DiscoveryInterface) e return nil } + +func ResourcesWithPodSpecs() []*meta.RESTMapping { + restMaps := []*meta.RESTMapping{} + resourcesWithTemplates := []string{"ReplicationController", "Deployment", "DaemonSet", "Job", "ReplicaSet"} + mapper, _ := NewFactory(nil).Object() + + for _, resource := range resourcesWithTemplates { + restmap, err := mapper.RESTMapping(unversioned.GroupKind{Kind: resource}) + if err == nil { + restMaps = append(restMaps, restmap) + } else { + mapping, _ := mapper.RESTMapping(extensions.Kind(resource)) + restMaps = append(restMaps, mapping) + } + } + return restMaps +}