Always set apiVersion and kind for resources within a resource list #298
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
openshift-ci-robot
added
the
size/S
fabianvf
reviewed
May 23, 2019
When the Kubernetes REST API returns a list of objects, it returns a resource list object with an apiVersion and kind set to "KindList" where "Kind" is the Kind of object queried, rather than an simple array of objects. The `items` property contains the array of resources returned. Each resource in this list does not contain the GVK information, only the resource list has an apiVersion or kind property set. This ensures when a resource list is returned, each resource within the list has it's apiVersion and kind set, to make it similar to other Kubernetes clients, and easier to work with the returned resources.
chancez
force-pushed
the
fix_missing_item_kind
branch
from
37d9ed5 to
17dd847
Compare
fabianvf
approved these changes
May 23, 2019
Member
|
/cherrypick release-0.9 |
|
@fabianvf: once the present PR merges, I will cherry-pick it on top of release-0.9 in a new PR and assign it to you. In response to this:
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. |
Member
|
/cherrypick release-0.8 |
|
@fabianvf: once the present PR merges, I will cherry-pick it on top of release-0.8 in a new PR and assign it to you. In response to this:
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. |
Just do one big serialization at the end of a ResourceList operation
fabianvf
approved these changes
May 24, 2019
|
@fabianvf: new pull request created: #301 In response to this:
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. |
|
@fabianvf: #298 failed to apply on top of branch "release-0.8": In response to this:
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. |
fabianvf
pushed a commit
to fabianvf/openshift-restclient-python
that referenced
this pull request
May 28, 2019
…penshift#298) * Always set apiVersion and kind for resources within a resource list When the Kubernetes REST API returns a list of objects, it returns a resource list object with an apiVersion and kind set to "KindList" where "Kind" is the Kind of object queried, rather than an simple array of objects. The `items` property contains the array of resources returned. Each resource in this list does not contain the GVK information, only the resource list has an apiVersion or kind property set. This ensures when a resource list is returned, each resource within the list has it's apiVersion and kind set, to make it similar to other Kubernetes clients, and easier to work with the returned resources. * Just do one big serialization at the end of a ResourceList operation (cherry picked from commit 68cc0e3)
fabianvf
added a commit
that referenced
this pull request
May 28, 2019
…298) (#302) * Always set apiVersion and kind for resources within a resource list When the Kubernetes REST API returns a list of objects, it returns a resource list object with an apiVersion and kind set to "KindList" where "Kind" is the Kind of object queried, rather than an simple array of objects. The `items` property contains the array of resources returned. Each resource in this list does not contain the GVK information, only the resource list has an apiVersion or kind property set. This ensures when a resource list is returned, each resource within the list has it's apiVersion and kind set, to make it similar to other Kubernetes clients, and easier to work with the returned resources. * Just do one big serialization at the end of a ResourceList operation (cherry picked from commit 68cc0e3)
chancez
pushed a commit
to chancez/operator-metering
that referenced
this pull request
Jun 6, 2019
Includes a fix from openshift/openshift-restclient-python#298 which ensures resources returned in a list have GVK information populated.
willthames
pushed a commit
to willthames/openshift-restclient-python
that referenced
this pull request
Nov 22, 2019
…penshift#298) * Always set apiVersion and kind for resources within a resource list When the Kubernetes REST API returns a list of objects, it returns a resource list object with an apiVersion and kind set to "KindList" where "Kind" is the Kind of object queried, rather than an simple array of objects. The `items` property contains the array of resources returned. Each resource in this list does not contain the GVK information, only the resource list has an apiVersion or kind property set. This ensures when a resource list is returned, each resource within the list has it's apiVersion and kind set, to make it similar to other Kubernetes clients, and easier to work with the returned resources. * Just do one big serialization at the end of a ResourceList operation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When the Kubernetes REST API returns a list of objects, it returns a
resource list object with an apiVersion and kind set to "KindList" where
"Kind" is the Kind of object queried, rather than an simple array of
objects.
The
itemsproperty contains the array of resources returned. Eachresource in this list does not contain the GVK information, only the
resource list has an apiVersion or kind property set.
This ensures when a resource list is returned, each resource within the
list has it's apiVersion and kind set, to make it similar to other
Kubernetes clients, and easier to work with the returned resources.
My primary reason for contributing this is because in the k8s_facts module in
Ansible pulls the
itemsout of a resource list(https://github.com/ansible/ansible/blob/devel/lib/ansible/module_utils/k8s/common.py#L211-L212), but each item in a resource
list doesn't have the apiVersion/kind information, only the list object itself
does, so you can't inspect the
kind of the objects returned, which is problematic.