Add kubectl create -f like feature #655

micw523 · 2018-10-22T05:24:13Z

This PR addresses #504.

Created a module kubernetes/utils with a function create_from_yaml(). Implemented with getattr().

e2e unit tests were added to test the functionalities on app_v1 / extension_v1beta1 (deployment), core_v1 (pod, service). The test yaml files are from kubernetes.io are included under e2e_test/test_yaml.

A minimal working example is added under examples/ folder.

micw523 · 2018-10-22T14:08:38Z

/assign @roycaihw
Could you please take a look?

micw523 · 2018-10-22T19:37:14Z

Fixes #349

k8s-ci-robot · 2018-10-22T20:24:08Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please email the CNCF helpdesk: helpdesk@rt.linuxfoundation.org

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

nakulpathak3 · 2018-10-25T21:28:00Z

This is awesome, thank you so much. Do you think it would be possible to have one for creating job from job_spec.yaml file as well? I don't see it in the code right now

micw523 · 2018-10-25T21:36:41Z

@nakulpathak3 From what I implemented I would expect a call to batch/vxx kind:Job to work. I did not implement an e2e test for it though.

roycaihw

Thanks for adding this feature! I left a few nits, and one substantive comment around creating cluster-scoped resources.

roycaihw · 2018-10-29T22:35:05Z

examples/create_deployment_from_yaml.py

@@ -0,0 +1,31 @@
+# Copyright 2016 The Kubernetes Authors.


s/2016/2018

similar in other places under utils/

roycaihw · 2018-10-29T22:37:10Z

examples/create_deployment_from_yaml.py

+
+import yaml
+
+from kubernetes import client, config, utils


I think we can drop client and yaml imports?

roycaihw · 2018-10-29T22:44:42Z

kubernetes/e2e_test/test_utils.py

+
+    def test_app_yaml(self):
+        k8s_api = utils.create_from_yaml(
+            "kubernetes/e2e_test/test_yaml/app.yaml", 


Maybe call the yaml files apps-deployment.yaml and extensions-deployment.yaml. We can use singular for the Kind, but usually we don't have singular v.s. plural for Group

roycaihw · 2018-10-29T22:46:37Z

kubernetes/e2e_test/test_utils.py

+        self.assertEqual("apps/v1beta1", 
+            k8s_api.get_api_resources().group_version)
+        deployments = k8s_api.list_namespaced_deployment(
+            namespace="default").items


You could use GET instead of LIST to test the creation:

python/kubernetes/client/apis/apps_v1beta1_api.py

Line 3091 in 529c0d3

def read_namespaced_deployment(self, name, namespace, **kwargs):

roycaihw · 2018-10-29T22:50:10Z

kubernetes/utils/create_from_yaml.py

+
+from kubernetes import client
+
+def create_from_yaml(yaml_file, verbose=0, **kwargs):


nit: please use verbose=False and verbose=True

roycaihw · 2018-10-29T22:56:14Z

kubernetes/utils/create_from_yaml.py

+                dep_namespace = dep["metadata"]["namespace"]
+        else:
+                dep_namespace = "default"
+        resp = getattr(k8s_api, "create_namespaced_{0}".format(action_type.lower()))(


We also need to be able to create cluster-scoped resources (e.g. create a namespace)

roycaihw

LGTM in general. I left a few nits. Please squash the commits before submitting.

roycaihw · 2018-10-31T23:23:17Z

kubernetes/utils/create_from_yaml.py

+
+def create_from_yaml(k8s_client, yaml_file, verbose=False, **kwargs):
+    """
+    Perform an action from a yaml file. Pass 1 for verbose to


nit: s/1/True

roycaihw · 2018-10-31T23:32:33Z

kubernetes/utils/create_from_yaml.py

+    with open(path.abspath(yaml_file)) as f:
+        yml_object = yaml.load(f)
+        #TODO: case of yaml file containing multiple objects
+        api_type, _, api_version = yml_object["apiVersion"].partition("/")


Please use group, version and kind instead of api_type, api_version and action_type, following the Kubernetes API convention: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md

roycaihw · 2018-10-31T23:35:22Z

kubernetes/utils/create_from_yaml.py

+        # Decide which namespace we are going to put the object in,
+        # if any
+        if "namespace" in yml_object["metadata"]:
+            dep_namespace = yml_object["metadata"]["namespace"]


nit: s/dep_namespace/namespace

roycaihw · 2018-11-01T00:45:21Z

/lgtm
/approve

k8s-ci-robot · 2018-11-01T00:45:24Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: micw523, roycaihw

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [roycaihw]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

amih90 · 2019-01-10T09:36:40Z

kubernetes/utils/create_from_yaml.py

+    :param str dry_run: When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
+    """
+
+    with open(path.abspath(yaml_file)) as f:


path.abspath(yaml_file)
will crash on str while yaml.load(str) can load the yaml from a string.
very useful if you need to change the yaml dynamically

govindKAG · 2019-02-20T05:54:44Z

Can you create argo workflows with this ? because I get
module 'kubernetes.client' has no attribute 'Argoproj.ioV1alpha1Api'module 'kubernetes.client' has no attribute 'Argoproj.ioV1alpha1Api'

micw523 · 2019-02-20T06:22:42Z

Is it a CRD? If so see #740. This is in my to do list, but these features have to come one at a time.

govindKAG · 2019-02-20T07:15:29Z

Is it a CRD? If so see #740. This is in my to do list, but these features have to come one at a time.

yeah it is a CRD. I am not sure how I missed that issue, thanks.

k8s-ci-robot assigned roycaihw Oct 22, 2018

micw523 force-pushed the master branch from 443ae4e to b27e187 Compare October 23, 2018 03:49

micw523 mentioned this pull request Oct 23, 2018

Travis CI - server uses dated k8s version v1.7 #660

Closed

nakulpathak3 mentioned this pull request Oct 25, 2018

Find API call to create object from yaml config #387

Closed

micw523 mentioned this pull request Oct 25, 2018

kubectl create -f <yaml file> #504

Closed

micw523 force-pushed the master branch 2 times, most recently from 763b0fe to 9e5a5b1 Compare October 27, 2018 01:10

roycaihw reviewed Oct 29, 2018

View reviewed changes

roycaihw reviewed Oct 31, 2018

View reviewed changes

Add kubectl create -f feature

5a92ba6

micw523 force-pushed the master branch from b54683d to 5a92ba6 Compare November 1, 2018 00:34

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 1, 2018

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 1, 2018

k8s-ci-robot merged commit 2dafb4b into kubernetes-client:master Nov 1, 2018

This was referenced Nov 1, 2018

Extend #655 with a List Parser #671

Closed

Extend YAML load functionality to *LIST and multi-resources #673

Merged

Track utils with pycodestyle #677

Merged

This was referenced Nov 9, 2018

REQUEST: New membership for micw523 kubernetes/org#232

Closed

Load k8s resources from a manifest file and operate on those resources. #349

Closed

iamneha mentioned this pull request Dec 13, 2018

Make dependancy adal optional kubernetes-client/python-base#108

Merged

amih90 reviewed Jan 10, 2019

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add kubectl create -f like feature #655

Add kubectl create -f like feature #655

micw523 commented Oct 22, 2018

micw523 commented Oct 22, 2018 •

edited

micw523 commented Oct 22, 2018 •

edited

k8s-ci-robot commented Oct 22, 2018

nakulpathak3 commented Oct 25, 2018

micw523 commented Oct 25, 2018

roycaihw left a comment

roycaihw Oct 29, 2018

roycaihw Oct 29, 2018

roycaihw Oct 29, 2018

roycaihw Oct 29, 2018

roycaihw Oct 29, 2018

roycaihw Oct 29, 2018

roycaihw left a comment

roycaihw Oct 31, 2018

roycaihw Oct 31, 2018

roycaihw Oct 31, 2018

roycaihw commented Nov 1, 2018

k8s-ci-robot commented Nov 1, 2018

amih90 Jan 10, 2019

govindKAG commented Feb 20, 2019

micw523 commented Feb 20, 2019

govindKAG commented Feb 20, 2019


		from kubernetes import client

		def create_from_yaml(yaml_file, verbose=0, **kwargs):

Add kubectl create -f like feature #655

Add kubectl create -f like feature #655

Conversation

micw523 commented Oct 22, 2018

micw523 commented Oct 22, 2018 • edited

micw523 commented Oct 22, 2018 • edited

k8s-ci-robot commented Oct 22, 2018

nakulpathak3 commented Oct 25, 2018

micw523 commented Oct 25, 2018

roycaihw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roycaihw left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

roycaihw commented Nov 1, 2018

k8s-ci-robot commented Nov 1, 2018

Choose a reason for hiding this comment

govindKAG commented Feb 20, 2019

micw523 commented Feb 20, 2019

govindKAG commented Feb 20, 2019

micw523 commented Oct 22, 2018 •

edited

micw523 commented Oct 22, 2018 •

edited