run.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646
  1. /*
  2. Copyright 2014 The Kubernetes Authors.
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. http://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package cmd
  14. import (
  15. "fmt"
  16. "io"
  17. "os"
  18. "time"
  19. "github.com/renstrom/dedent"
  20. "github.com/spf13/cobra"
  21. "github.com/docker/distribution/reference"
  22. "k8s.io/kubernetes/pkg/api"
  23. "k8s.io/kubernetes/pkg/api/meta"
  24. "k8s.io/kubernetes/pkg/api/unversioned"
  25. batchv1 "k8s.io/kubernetes/pkg/apis/batch/v1"
  26. "k8s.io/kubernetes/pkg/apis/extensions/v1beta1"
  27. client "k8s.io/kubernetes/pkg/client/unversioned"
  28. "k8s.io/kubernetes/pkg/kubectl"
  29. cmdutil "k8s.io/kubernetes/pkg/kubectl/cmd/util"
  30. "k8s.io/kubernetes/pkg/kubectl/resource"
  31. "k8s.io/kubernetes/pkg/runtime"
  32. uexec "k8s.io/kubernetes/pkg/util/exec"
  33. "k8s.io/kubernetes/pkg/watch"
  34. )
  35. var (
  36. run_long = dedent.Dedent(`
  37. Create and run a particular image, possibly replicated.
  38. Creates a deployment or job to manage the created container(s).`)
  39. run_example = dedent.Dedent(`
  40. # Start a single instance of nginx.
  41. kubectl run nginx --image=nginx
  42. # Start a single instance of hazelcast and let the container expose port 5701 .
  43. kubectl run hazelcast --image=hazelcast --port=5701
  44. # Start a single instance of hazelcast and set environment variables "DNS_DOMAIN=cluster" and "POD_NAMESPACE=default" in the container.
  45. kubectl run hazelcast --image=hazelcast --env="DNS_DOMAIN=cluster" --env="POD_NAMESPACE=default"
  46. # Start a replicated instance of nginx.
  47. kubectl run nginx --image=nginx --replicas=5
  48. # Dry run. Print the corresponding API objects without creating them.
  49. kubectl run nginx --image=nginx --dry-run
  50. # Start a single instance of nginx, but overload the spec of the deployment with a partial set of values parsed from JSON.
  51. kubectl run nginx --image=nginx --overrides='{ "apiVersion": "v1", "spec": { ... } }'
  52. # Start a pod of busybox and keep it in the foreground, don't restart it if it exits.
  53. kubectl run -i -t busybox --image=busybox --restart=Never
  54. # Start the nginx container using the default command, but use custom arguments (arg1 .. argN) for that command.
  55. kubectl run nginx --image=nginx -- <arg1> <arg2> ... <argN>
  56. # Start the nginx container using a different command and custom arguments.
  57. kubectl run nginx --image=nginx --command -- <cmd> <arg1> ... <argN>
  58. # Start the perl container to compute π to 2000 places and print it out.
  59. kubectl run pi --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'
  60. # Start the scheduled job to compute π to 2000 places and print it out every 5 minutes.
  61. kubectl run pi --schedule="0/5 * * * ?" --image=perl --restart=OnFailure -- perl -Mbignum=bpi -wle 'print bpi(2000)'`)
  62. )
  63. func NewCmdRun(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer) *cobra.Command {
  64. cmd := &cobra.Command{
  65. Use: "run NAME --image=image [--env=\"key=value\"] [--port=port] [--replicas=replicas] [--dry-run=bool] [--overrides=inline-json] [--command] -- [COMMAND] [args...]",
  66. // run-container is deprecated
  67. Aliases: []string{"run-container"},
  68. Short: "Run a particular image on the cluster",
  69. Long: run_long,
  70. Example: run_example,
  71. Run: func(cmd *cobra.Command, args []string) {
  72. argsLenAtDash := cmd.ArgsLenAtDash()
  73. err := Run(f, cmdIn, cmdOut, cmdErr, cmd, args, argsLenAtDash)
  74. cmdutil.CheckErr(err)
  75. },
  76. }
  77. cmdutil.AddPrinterFlags(cmd)
  78. addRunFlags(cmd)
  79. cmdutil.AddApplyAnnotationFlags(cmd)
  80. cmdutil.AddRecordFlag(cmd)
  81. cmdutil.AddInclude3rdPartyFlags(cmd)
  82. return cmd
  83. }
  84. func addRunFlags(cmd *cobra.Command) {
  85. cmdutil.AddDryRunFlag(cmd)
  86. cmd.Flags().String("generator", "", "The name of the API generator to use. Default is 'deployment/v1beta1' if --restart=Always, 'job/v1' for OnFailure and 'run-pod/v1' for Never. This will happen only for cluster version at least 1.3, for 1.2 we will fallback to 'deployment/v1beta1' for --restart=Always, 'job/v1' for others, for olders we will fallback to 'run/v1' for --restart=Always, 'run-pod/v1' for others.")
  87. cmd.Flags().String("image", "", "The image for the container to run.")
  88. cmd.MarkFlagRequired("image")
  89. cmd.Flags().String("image-pull-policy", "", "The image pull policy for the container. If left empty, this value will not be specified by the client and defaulted by the server")
  90. cmd.Flags().IntP("replicas", "r", 1, "Number of replicas to create for this container. Default is 1.")
  91. cmd.Flags().Bool("rm", false, "If true, delete resources created in this command for attached containers.")
  92. cmd.Flags().String("overrides", "", "An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.")
  93. cmd.Flags().StringSlice("env", []string{}, "Environment variables to set in the container")
  94. cmd.Flags().Int("port", -1, "The port that this container exposes. If --expose is true, this is also the port used by the service that is created.")
  95. cmd.Flags().Int("hostport", -1, "The host port mapping for the container port. To demonstrate a single-machine container.")
  96. cmd.Flags().StringP("labels", "l", "", "Labels to apply to the pod(s).")
  97. cmd.Flags().BoolP("stdin", "i", false, "Keep stdin open on the container(s) in the pod, even if nothing is attached.")
  98. cmd.Flags().BoolP("tty", "t", false, "Allocated a TTY for each container in the pod.")
  99. cmd.Flags().Bool("attach", false, "If true, wait for the Pod to start running, and then attach to the Pod as if 'kubectl attach ...' were called. Default false, unless '-i/--stdin' is set, in which case the default is true. With '--restart=Never' the exit code of the container process is returned.")
  100. cmd.Flags().Bool("leave-stdin-open", false, "If the pod is started in interactive mode or with stdin, leave stdin open after the first attach completes. By default, stdin will be closed after the first attach completes.")
  101. cmd.Flags().String("restart", "Always", "The restart policy for this Pod. Legal values [Always, OnFailure, Never]. If set to 'Always' a deployment is created for this pod, if set to 'OnFailure', a job is created for this pod, if set to 'Never', a regular pod is created. For the latter two --replicas must be 1. Default 'Always'")
  102. cmd.Flags().Bool("command", false, "If true and extra arguments are present, use them as the 'command' field in the container, rather than the 'args' field which is the default.")
  103. cmd.Flags().String("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.")
  104. cmd.Flags().String("limits", "", "The resource requirement limits for this container. For example, 'cpu=200m,memory=512Mi'. Note that server side components may assign limits depending on the server configuration, such as limit ranges.")
  105. cmd.Flags().Bool("expose", false, "If true, a public, external service is created for the container(s) which are run")
  106. cmd.Flags().String("service-generator", "service/v2", "The name of the generator to use for creating a service. Only used if --expose is true")
  107. cmd.Flags().String("service-overrides", "", "An inline JSON override for the generated service object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field. Only used if --expose is true.")
  108. cmd.Flags().Bool("quiet", false, "If true, suppress prompt messages.")
  109. cmd.Flags().String("schedule", "", "A schedule in the Cron format the job should be run with.")
  110. }
  111. func Run(f *cmdutil.Factory, cmdIn io.Reader, cmdOut, cmdErr io.Writer, cmd *cobra.Command, args []string, argsLenAtDash int) error {
  112. if len(os.Args) > 1 && os.Args[1] == "run-container" {
  113. printDeprecationWarning("run", "run-container")
  114. }
  115. // Let kubectl run follow rules for `--`, see #13004 issue
  116. if len(args) == 0 || argsLenAtDash == 0 {
  117. return cmdutil.UsageError(cmd, "NAME is required for run")
  118. }
  119. // validate image name
  120. imageName := cmdutil.GetFlagString(cmd, "image")
  121. validImageRef := reference.ReferenceRegexp.MatchString(imageName)
  122. if !validImageRef {
  123. return fmt.Errorf("Invalid image name %q: %v", imageName, reference.ErrReferenceInvalidFormat)
  124. }
  125. interactive := cmdutil.GetFlagBool(cmd, "stdin")
  126. tty := cmdutil.GetFlagBool(cmd, "tty")
  127. if tty && !interactive {
  128. return cmdutil.UsageError(cmd, "-i/--stdin is required for containers with -t/--tty=true")
  129. }
  130. replicas := cmdutil.GetFlagInt(cmd, "replicas")
  131. if interactive && replicas != 1 {
  132. return cmdutil.UsageError(cmd, fmt.Sprintf("-i/--stdin requires that replicas is 1, found %d", replicas))
  133. }
  134. namespace, _, err := f.DefaultNamespace()
  135. if err != nil {
  136. return err
  137. }
  138. restartPolicy, err := getRestartPolicy(cmd, interactive)
  139. if err != nil {
  140. return err
  141. }
  142. if restartPolicy != api.RestartPolicyAlways && replicas != 1 {
  143. return cmdutil.UsageError(cmd, fmt.Sprintf("--restart=%s requires that --replicas=1, found %d", restartPolicy, replicas))
  144. }
  145. if err := verifyImagePullPolicy(cmd); err != nil {
  146. return err
  147. }
  148. generatorName := cmdutil.GetFlagString(cmd, "generator")
  149. schedule := cmdutil.GetFlagString(cmd, "schedule")
  150. if len(schedule) != 0 && len(generatorName) == 0 {
  151. generatorName = "scheduledjob/v2alpha1"
  152. }
  153. if len(generatorName) == 0 {
  154. client, err := f.Client()
  155. if err != nil {
  156. return err
  157. }
  158. resourcesList, err := client.Discovery().ServerResources()
  159. // ServerResources ignores errors for old servers do not expose discovery
  160. if err != nil {
  161. return fmt.Errorf("failed to discover supported resources: %v", err)
  162. }
  163. switch restartPolicy {
  164. case api.RestartPolicyAlways:
  165. if contains(resourcesList, v1beta1.SchemeGroupVersion.WithResource("deployments")) {
  166. generatorName = "deployment/v1beta1"
  167. } else {
  168. generatorName = "run/v1"
  169. }
  170. case api.RestartPolicyOnFailure:
  171. if contains(resourcesList, batchv1.SchemeGroupVersion.WithResource("jobs")) {
  172. generatorName = "job/v1"
  173. } else if contains(resourcesList, v1beta1.SchemeGroupVersion.WithResource("jobs")) {
  174. generatorName = "job/v1beta1"
  175. } else {
  176. generatorName = "run-pod/v1"
  177. }
  178. case api.RestartPolicyNever:
  179. generatorName = "run-pod/v1"
  180. }
  181. }
  182. generators := f.Generators("run")
  183. generator, found := generators[generatorName]
  184. if !found {
  185. return cmdutil.UsageError(cmd, fmt.Sprintf("generator %q not found.", generatorName))
  186. }
  187. names := generator.ParamNames()
  188. params := kubectl.MakeParams(cmd, names)
  189. params["name"] = args[0]
  190. if len(args) > 1 {
  191. params["args"] = args[1:]
  192. }
  193. params["env"] = cmdutil.GetFlagStringSlice(cmd, "env")
  194. obj, _, mapper, mapping, err := createGeneratedObject(f, cmd, generator, names, params, cmdutil.GetFlagString(cmd, "overrides"), namespace)
  195. if err != nil {
  196. return err
  197. }
  198. if cmdutil.GetFlagBool(cmd, "expose") {
  199. serviceGenerator := cmdutil.GetFlagString(cmd, "service-generator")
  200. if len(serviceGenerator) == 0 {
  201. return cmdutil.UsageError(cmd, fmt.Sprintf("No service generator specified"))
  202. }
  203. if err := generateService(f, cmd, args, serviceGenerator, params, namespace, cmdOut); err != nil {
  204. return err
  205. }
  206. }
  207. attachFlag := cmd.Flags().Lookup("attach")
  208. attach := cmdutil.GetFlagBool(cmd, "attach")
  209. if !attachFlag.Changed && interactive {
  210. attach = true
  211. }
  212. remove := cmdutil.GetFlagBool(cmd, "rm")
  213. if !attach && remove {
  214. return cmdutil.UsageError(cmd, "--rm should only be used for attached containers")
  215. }
  216. if attach {
  217. quiet := cmdutil.GetFlagBool(cmd, "quiet")
  218. opts := &AttachOptions{
  219. StreamOptions: StreamOptions{
  220. In: cmdIn,
  221. Out: cmdOut,
  222. Err: cmdErr,
  223. Stdin: interactive,
  224. TTY: tty,
  225. Quiet: quiet,
  226. },
  227. CommandName: cmd.Parent().CommandPath() + " attach",
  228. Attach: &DefaultRemoteAttach{},
  229. }
  230. config, err := f.ClientConfig()
  231. if err != nil {
  232. return err
  233. }
  234. opts.Config = config
  235. client, err := f.Client()
  236. if err != nil {
  237. return err
  238. }
  239. opts.Client = client
  240. attachablePod, err := f.AttachablePodForObject(obj)
  241. if err != nil {
  242. return err
  243. }
  244. err = handleAttachPod(f, client, attachablePod.Namespace, attachablePod.Name, opts, quiet)
  245. if err != nil {
  246. return err
  247. }
  248. var pod *api.Pod
  249. leaveStdinOpen := cmdutil.GetFlagBool(cmd, "leave-stdin-open")
  250. waitForExitCode := !leaveStdinOpen && restartPolicy == api.RestartPolicyNever
  251. if waitForExitCode {
  252. pod, err = waitForPodTerminated(client, attachablePod.Namespace, attachablePod.Name, opts.Out, quiet)
  253. if err != nil {
  254. return err
  255. }
  256. }
  257. if remove {
  258. namespace, err = mapping.MetadataAccessor.Namespace(obj)
  259. if err != nil {
  260. return err
  261. }
  262. var name string
  263. name, err = mapping.MetadataAccessor.Name(obj)
  264. if err != nil {
  265. return err
  266. }
  267. _, typer := f.Object(cmdutil.GetIncludeThirdPartyAPIs(cmd))
  268. r := resource.NewBuilder(mapper, typer, resource.ClientMapperFunc(f.ClientForMapping), f.Decoder(true)).
  269. ContinueOnError().
  270. NamespaceParam(namespace).DefaultNamespace().
  271. ResourceNames(mapping.Resource, name).
  272. Flatten().
  273. Do()
  274. err = ReapResult(r, f, cmdOut, true, true, 0, -1, false, mapper, quiet)
  275. if err != nil {
  276. return err
  277. }
  278. }
  279. // after removal is done, return successfully if we are not interested in the exit code
  280. if !waitForExitCode {
  281. return nil
  282. }
  283. switch pod.Status.Phase {
  284. case api.PodSucceeded:
  285. return nil
  286. case api.PodFailed:
  287. unknownRcErr := fmt.Errorf("pod %s/%s failed with unknown exit code", pod.Namespace, pod.Name)
  288. if len(pod.Status.ContainerStatuses) == 0 || pod.Status.ContainerStatuses[0].State.Terminated == nil {
  289. return unknownRcErr
  290. }
  291. // assume here that we have at most one status because kubectl-run only creates one container per pod
  292. rc := pod.Status.ContainerStatuses[0].State.Terminated.ExitCode
  293. if rc == 0 {
  294. return unknownRcErr
  295. }
  296. return uexec.CodeExitError{
  297. Err: fmt.Errorf("pod %s/%s terminated", pod.Namespace, pod.Name),
  298. Code: int(rc),
  299. }
  300. default:
  301. return fmt.Errorf("pod %s/%s left in phase %s", pod.Namespace, pod.Name, pod.Status.Phase)
  302. }
  303. }
  304. outputFormat := cmdutil.GetFlagString(cmd, "output")
  305. if outputFormat != "" || cmdutil.GetDryRunFlag(cmd) {
  306. return f.PrintObject(cmd, mapper, obj, cmdOut)
  307. }
  308. cmdutil.PrintSuccess(mapper, false, cmdOut, mapping.Resource, args[0], "created")
  309. return nil
  310. }
  311. // TODO turn this into reusable method checking available resources
  312. func contains(resourcesList map[string]*unversioned.APIResourceList, resource unversioned.GroupVersionResource) bool {
  313. if resourcesList == nil {
  314. return false
  315. }
  316. resourcesGroup, ok := resourcesList[resource.GroupVersion().String()]
  317. if !ok {
  318. return false
  319. }
  320. for _, item := range resourcesGroup.APIResources {
  321. if resource.Resource == item.Name {
  322. return true
  323. }
  324. }
  325. return false
  326. }
  327. // waitForPod watches the given pod until the exitCondition is true. Each two seconds
  328. // the tick function is called e.g. for progress output.
  329. func waitForPod(c *client.Client, ns, name string, exitCondition func(*api.Pod) bool, tick func(*api.Pod)) (*api.Pod, error) {
  330. pod, err := c.Pods(ns).Get(name)
  331. if err != nil {
  332. return nil, err
  333. }
  334. if exitCondition(pod) {
  335. return pod, nil
  336. }
  337. tick(pod)
  338. w, err := c.Pods(ns).Watch(api.SingleObject(api.ObjectMeta{Name: pod.Name, ResourceVersion: pod.ResourceVersion}))
  339. if err != nil {
  340. return nil, err
  341. }
  342. t := time.NewTicker(2 * time.Second)
  343. defer t.Stop()
  344. go func() {
  345. for range t.C {
  346. tick(pod)
  347. }
  348. }()
  349. err = nil
  350. result := pod
  351. kubectl.WatchLoop(w, func(ev watch.Event) error {
  352. switch ev.Type {
  353. case watch.Added, watch.Modified:
  354. pod = ev.Object.(*api.Pod)
  355. if exitCondition(pod) {
  356. result = pod
  357. w.Stop()
  358. }
  359. case watch.Deleted:
  360. w.Stop()
  361. case watch.Error:
  362. result = nil
  363. err = fmt.Errorf("failed to watch pod %s/%s", ns, name)
  364. w.Stop()
  365. }
  366. return nil
  367. })
  368. return result, err
  369. }
  370. func waitForPodRunning(c *client.Client, ns, name string, out io.Writer, quiet bool) (*api.Pod, error) {
  371. exitCondition := func(pod *api.Pod) bool {
  372. switch pod.Status.Phase {
  373. case api.PodRunning:
  374. for _, status := range pod.Status.ContainerStatuses {
  375. if !status.Ready {
  376. return false
  377. }
  378. }
  379. return true
  380. case api.PodSucceeded, api.PodFailed:
  381. return true
  382. default:
  383. return false
  384. }
  385. }
  386. return waitForPod(c, ns, name, exitCondition, func(pod *api.Pod) {
  387. if !quiet {
  388. fmt.Fprintf(out, "Waiting for pod %s/%s to be running, status is %s, pod ready: false\n", pod.Namespace, pod.Name, pod.Status.Phase)
  389. }
  390. })
  391. }
  392. func waitForPodTerminated(c *client.Client, ns, name string, out io.Writer, quiet bool) (*api.Pod, error) {
  393. exitCondition := func(pod *api.Pod) bool {
  394. return pod.Status.Phase == api.PodSucceeded || pod.Status.Phase == api.PodFailed
  395. }
  396. return waitForPod(c, ns, name, exitCondition, func(pod *api.Pod) {
  397. if !quiet {
  398. fmt.Fprintf(out, "Waiting for pod %s/%s to terminate, status is %s\n", pod.Namespace, pod.Name, pod.Status.Phase)
  399. }
  400. })
  401. }
  402. func handleAttachPod(f *cmdutil.Factory, c *client.Client, ns, name string, opts *AttachOptions, quiet bool) error {
  403. pod, err := waitForPodRunning(c, ns, name, opts.Out, quiet)
  404. if err != nil {
  405. return err
  406. }
  407. ctrName, err := opts.GetContainerName(pod)
  408. if err != nil {
  409. return err
  410. }
  411. if pod.Status.Phase == api.PodSucceeded || pod.Status.Phase == api.PodFailed {
  412. req, err := f.LogsForObject(pod, &api.PodLogOptions{Container: ctrName})
  413. if err != nil {
  414. return err
  415. }
  416. readCloser, err := req.Stream()
  417. if err != nil {
  418. return err
  419. }
  420. defer readCloser.Close()
  421. _, err = io.Copy(opts.Out, readCloser)
  422. return err
  423. }
  424. opts.Client = c
  425. opts.PodName = name
  426. opts.Namespace = ns
  427. if err := opts.Run(); err != nil {
  428. fmt.Fprintf(opts.Err, "Error attaching, falling back to logs: %v\n", err)
  429. req, err := f.LogsForObject(pod, &api.PodLogOptions{Container: ctrName})
  430. if err != nil {
  431. return err
  432. }
  433. readCloser, err := req.Stream()
  434. if err != nil {
  435. return err
  436. }
  437. defer readCloser.Close()
  438. _, err = io.Copy(opts.Out, readCloser)
  439. return err
  440. }
  441. return nil
  442. }
  443. func getRestartPolicy(cmd *cobra.Command, interactive bool) (api.RestartPolicy, error) {
  444. restart := cmdutil.GetFlagString(cmd, "restart")
  445. if len(restart) == 0 {
  446. if interactive {
  447. return api.RestartPolicyOnFailure, nil
  448. } else {
  449. return api.RestartPolicyAlways, nil
  450. }
  451. }
  452. switch api.RestartPolicy(restart) {
  453. case api.RestartPolicyAlways:
  454. return api.RestartPolicyAlways, nil
  455. case api.RestartPolicyOnFailure:
  456. return api.RestartPolicyOnFailure, nil
  457. case api.RestartPolicyNever:
  458. return api.RestartPolicyNever, nil
  459. default:
  460. return "", cmdutil.UsageError(cmd, fmt.Sprintf("invalid restart policy: %s", restart))
  461. }
  462. }
  463. func verifyImagePullPolicy(cmd *cobra.Command) error {
  464. pullPolicy := cmdutil.GetFlagString(cmd, "image-pull-policy")
  465. switch api.PullPolicy(pullPolicy) {
  466. case api.PullAlways, api.PullIfNotPresent, api.PullNever:
  467. return nil
  468. case "":
  469. return nil
  470. default:
  471. return cmdutil.UsageError(cmd, fmt.Sprintf("invalid image pull policy: %s", pullPolicy))
  472. }
  473. }
  474. func generateService(f *cmdutil.Factory, cmd *cobra.Command, args []string, serviceGenerator string, paramsIn map[string]interface{}, namespace string, out io.Writer) error {
  475. generators := f.Generators("expose")
  476. generator, found := generators[serviceGenerator]
  477. if !found {
  478. return fmt.Errorf("missing service generator: %s", serviceGenerator)
  479. }
  480. names := generator.ParamNames()
  481. port := cmdutil.GetFlagInt(cmd, "port")
  482. if port < 1 {
  483. return fmt.Errorf("--port must be a positive integer when exposing a service")
  484. }
  485. params := map[string]interface{}{}
  486. for key, value := range paramsIn {
  487. _, isString := value.(string)
  488. if isString {
  489. params[key] = value
  490. }
  491. }
  492. name, found := params["name"]
  493. if !found || len(name.(string)) == 0 {
  494. return fmt.Errorf("name is a required parameter")
  495. }
  496. selector, found := params["labels"]
  497. if !found || len(selector.(string)) == 0 {
  498. selector = fmt.Sprintf("run=%s", name.(string))
  499. }
  500. params["selector"] = selector
  501. if defaultName, found := params["default-name"]; !found || len(defaultName.(string)) == 0 {
  502. params["default-name"] = name
  503. }
  504. obj, _, mapper, mapping, err := createGeneratedObject(f, cmd, generator, names, params, cmdutil.GetFlagString(cmd, "service-overrides"), namespace)
  505. if err != nil {
  506. return err
  507. }
  508. if cmdutil.GetFlagString(cmd, "output") != "" || cmdutil.GetDryRunFlag(cmd) {
  509. return f.PrintObject(cmd, mapper, obj, out)
  510. }
  511. cmdutil.PrintSuccess(mapper, false, out, mapping.Resource, args[0], "created")
  512. return nil
  513. }
  514. func createGeneratedObject(f *cmdutil.Factory, cmd *cobra.Command, generator kubectl.Generator, names []kubectl.GeneratorParam, params map[string]interface{}, overrides, namespace string) (runtime.Object, string, meta.RESTMapper, *meta.RESTMapping, error) {
  515. err := kubectl.ValidateParams(names, params)
  516. if err != nil {
  517. return nil, "", nil, nil, err
  518. }
  519. // TODO: Validate flag usage against selected generator. More tricky since --expose was added.
  520. obj, err := generator.Generate(params)
  521. if err != nil {
  522. return nil, "", nil, nil, err
  523. }
  524. mapper, typer := f.Object(cmdutil.GetIncludeThirdPartyAPIs(cmd))
  525. groupVersionKinds, _, err := typer.ObjectKinds(obj)
  526. if err != nil {
  527. return nil, "", nil, nil, err
  528. }
  529. groupVersionKind := groupVersionKinds[0]
  530. if len(overrides) > 0 {
  531. codec := runtime.NewCodec(f.JSONEncoder(), f.Decoder(true))
  532. obj, err = cmdutil.Merge(codec, obj, overrides, groupVersionKind.Kind)
  533. if err != nil {
  534. return nil, "", nil, nil, err
  535. }
  536. }
  537. mapping, err := mapper.RESTMapping(groupVersionKind.GroupKind(), groupVersionKind.Version)
  538. if err != nil {
  539. return nil, "", nil, nil, err
  540. }
  541. client, err := f.ClientForMapping(mapping)
  542. if err != nil {
  543. return nil, "", nil, nil, err
  544. }
  545. annotations, err := mapping.MetadataAccessor.Annotations(obj)
  546. if err != nil {
  547. return nil, "", nil, nil, err
  548. }
  549. if cmdutil.GetRecordFlag(cmd) || len(annotations[kubectl.ChangeCauseAnnotation]) > 0 {
  550. if err := cmdutil.RecordChangeCause(obj, f.Command()); err != nil {
  551. return nil, "", nil, nil, err
  552. }
  553. }
  554. if !cmdutil.GetDryRunFlag(cmd) {
  555. resourceMapper := &resource.Mapper{
  556. ObjectTyper: typer,
  557. RESTMapper: mapper,
  558. ClientMapper: resource.ClientMapperFunc(f.ClientForMapping),
  559. Decoder: f.Decoder(true),
  560. }
  561. info, err := resourceMapper.InfoForObject(obj, nil)
  562. if err != nil {
  563. return nil, "", nil, nil, err
  564. }
  565. if err := kubectl.CreateOrUpdateAnnotation(cmdutil.GetFlagBool(cmd, cmdutil.ApplyAnnotationsFlag), info, f.JSONEncoder()); err != nil {
  566. return nil, "", nil, nil, err
  567. }
  568. obj, err = resource.NewHelper(client, mapping).Create(namespace, false, info.Object)
  569. if err != nil {
  570. return nil, "", nil, nil, err
  571. }
  572. }
  573. return obj, groupVersionKind.Kind, mapper, mapping, err
  574. }