Discovery info for processedtemplates & templates both have kind: Template #21668

cben · 2018-12-16T16:04:42Z

This might not be a bug, but creates complications for dynamic clients parsing discovery info:

Both oapi/v1 and apis/template.openshift.io/v1 have 2 different paths with same kind:

      "name": "templates",
      "namespaced": true,
      "kind": "Template",
      "verbs": ["create", "delete", "deletecollection", "get", "list", "patch", "update", "watch"],
...
      "name": "processedtemplates",
      "namespaced": true,
      "kind": "Template",
      "verbs": ["create"],

Given kind: Template input, how does oc know which of the endpoints to hit?
Could anything be added to discovery to make this unambiguous?
What is the difference between /templates and /processedtemplates anyway?
Do clients need both or can I just hardcode preference to /templates?
The docs are non-helpful — don't explain the difference — and weird:
- https://docs.openshift.com/container-platform/3.11/rest_api/apis-template.openshift.io/v1.Template.html documents "kind": "Template" for both endpoints.
- https://docs.openshift.com/container-platform/3.11/rest_api/oapi/v1.Template.html documents "kind": "ProcessedTemplate" for /templates. 🐛
  Is kind ProcessedTemplate a real thing?
- https://docs.openshift.com/container-platform/3.11/rest_api/oapi/v1.ProcessedTemplate.html documents "kind": "ProcessedTemplate" for /processedtemplates.
The docs are organized by kind, could it be they're buggy as result of this collision?

Version

oc v3.11.0+8de5c34
kubernetes v1.10.0+d4cacc0
features: Basic-Auth GSSAPI Kerberos SPNEGO

Server https://192.168.99.103:8443
kubernetes v1.11.0+d4cacc0

Steps To Reproduce

curl $API/apis/template.openshift.io/v1/
curl $API/oapi/v1/

Current Result

Duplicate entries with different name but same kind.

Expected Result

Ideally, exactly one name per kind (ignoring subresources like routes/status).
If kind ProcessedTemplate really exists, can that be reported for "name": "processedtemplates"?
If impossible, some hint in discovery info helping decide between the two?

Additional Information

FWIW, there was a similar collision up to openshift 3.6 between DeploymentConfig /generatedeploymentconfigs and DeploymentConfig /deploymentconfigs. generatedeploymentconfigs is gone in 3.7+ discovery info.

The text was updated successfully, but these errors were encountered:

Openshift discovery lists both `templates` and `processedtemplates` for same kind "Template": openshift/origin#21668 `templates` is a regular stored api object. `processedtemplates` endpoint isn't, its POST is a special input (template + params) -> output function. That functionality is already covered in kubeclient by `process_template` method. It doesn't need regular create_, get_, watch_ etc methods. This is already so because in all openshift versions, `templates` comes after `processedtemplates` and replaces it in `@entities["Template"]`.

Openshift discovery lists both `templates` and `processedtemplates` for same kind "Template": openshift/origin#21668 `templates` is a regular stored api object. `processedtemplates` endpoint isn't a stored object, its POST is a special input (template + params) -> output function. That functionality is already covered in kubeclient by `process_template` method. It doesn't need regular create_, get_, watch_ etc methods. This is already so because in all openshift versions, `templates` comes after `processedtemplates` and replaces it in `@entities["template"]`.

openshift-bot · 2019-03-17T15:27:05Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot · 2019-04-16T17:05:56Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

openshift-bot · 2019-05-16T18:20:53Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci-robot · 2019-05-16T18:20:55Z

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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.

cben · 2019-05-19T10:15:07Z

/reopen

Documents are still confusing and at least one is wrong. Edited OP with a bit more details.

To partially answer myself, /processedtemplates endpoint is a pseudo-collection for server-side
oc process. With oc v1.13 I see it performs POST https://192.168.99.103:8443/apis/template.openshift.io/v1/namespaces/myproject/processedtemplates with Request Body: {"kind":"Template","apiVersion":"template.openshift.io/v1",,"metadata":{"name":"route","creationTimestamp":null},...
and gets back Response Body: {"kind":"Template","apiVersion":"template.openshift.io/v1","metadata":{"name":"route","selfLink":"/apis/template.openshift.io/v1/namespaces/myproject/processedtemplates/route",....
"Pseudo-collection" because you can only POST, and the result is ephemeral, server doesn't add it to any storage. Attempting to GET returns MethodNotAllowed (consistent with discovery verbs": ["create"]).

oc get processedtemplates behaves confusingly by performing GET .../templates. 🐛
It works (e.g. try oc get processedtemplates -n openshift).
(This demonstrates that oc is also partially confused by this collision?)
oc explain processedtemplate contradicts this by saying:
the server doesn't have a resource type "processedtemplate"
oc explain template fails, saying 🐛
error: Couldn't find resource for "template.openshift.io/v1, Kind=Template"

AFAICT kind "ProcessedTemplate" is not a thing. oc process send "Template" it and server responds with "Template".

openshift-ci-robot · 2019-05-19T10:15:14Z

@cben: Reopened this issue.

In response to this:

/reopen

Documents are still confusing and at least one is wrong. Edited OP with a bit more details.

To partially answer myself, /processedtemplates endpoint is a pseudo-collection for server-side
oc process. With oc v1.13 I see it performs POST https://192.168.99.103:8443/apis/template.openshift.io/v1/namespaces/myproject/processedtemplates with Request Body: {"kind":"Template","apiVersion":"template.openshift.io/v1",,"metadata":{"name":"route","creationTimestamp":null},...
and gets back Response Body: {"kind":"Template","apiVersion":"template.openshift.io/v1","metadata":{"name":"route","selfLink":"/apis/template.openshift.io/v1/namespaces/myproject/processedtemplates/route",....
"Pseudo-collection" because you can only POST, and the result is ephemeral, server doesn't add it to any storage. Attempting to GET returns MethodNotAllowed (consistent with discovery verbs": ["create"]).

oc get processedtemplates behaves confusingly by performing GET .../templates. 🐛
It works (e.g. try oc get processedtemplates -n openshift).
(This demonstrates that oc is also partially confused by this collision?)

oc explain processedtemplate contradicts this by saying:
the server doesn't have a resource type "processedtemplate"

oc explain template fails, saying 🐛
error: Couldn't find resource for "template.openshift.io/v1, Kind=Template"

AFAICT kind "ProcessedTemplate" is not a thing. oc process send "Template" it and server responds with "Template".

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.

cben · 2019-05-19T14:30:17Z

Such collisions have caused a bunch of ResourceNotUniqueError errors in python lib (which is also a dynamic client using discovery info):
openshift/openshift-restclient-python#284
and ansible k8s aka openshift_raw module that uses that lib:
ansible/ansible#55221
ansible/ansible#55388

cben · 2019-05-19T14:33:47Z

/oapi paths are gone since #21782 so that part can be ignored.
Most of the issue still stands.

openshift-bot · 2019-06-18T19:56:54Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci-robot · 2019-06-18T19:56:55Z

@openshift-bot: Closing this issue.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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.

cben · 2019-06-19T06:19:00Z

/reopen
/remove-lifecycle rotten
/lifecycle frozen

openshift-ci-robot · 2019-06-19T06:19:02Z

@cben: Reopened this issue.

In response to this:

/reopen
/remove-lifecycle rotten
/lifecycle frozen

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.

… by [kind, name, singularName, shortNames] * ansible/ansible#55221 * openshift/origin#21668 * ansible/ansible#58130 * ansible/ansible#49100

CermakM · 2019-11-13T08:36:41Z

Hello! Any update on this? Still hitting this issue.

This was referenced Dec 16, 2018

Underscores disappeared for y -> ies plurals ManageIQ/kubeclient#376

Closed

no high level end user api for primary operations like application deployment openshift/api#36

Closed

cben mentioned this issue Dec 17, 2018

[v4.1.z] Don't try creating methods for /processedtemplates pseudo-entity ManageIQ/kubeclient#378

Merged

openshift-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 17, 2019

openshift-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Apr 16, 2019

openshift-ci-robot closed this as completed May 16, 2019

openshift-ci-robot reopened this May 19, 2019

cben mentioned this issue May 19, 2019

ResourceNotUniqueError on resources.get(api_version='v1', kind='DeploymentConfig') openshift/openshift-restclient-python#284

Closed

This was referenced Jun 17, 2019

[k8s] Surface resource discovery errors properly ansible/ansible#55388

Closed

OpenShift 3.11 support? openshift/openshift-restclient-python#270

Closed

openshift-ci-robot closed this as completed Jun 18, 2019

openshift-ci-robot reopened this Jun 19, 2019

openshift-ci-robot added lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. labels Jun 19, 2019

lucastheisen mentioned this issue Jun 20, 2019

k8s module does not work with openshift Template kind due to ResourceNotUniqueError ansible/ansible#58130

Closed

pacospace mentioned this issue Dec 2, 2019

ResourceNotUniqueError: Multiple matches found for {'api_version': 'template.openshift.io/v1', 'kind': 'Template'}: [<Res... thoth-station/metrics-exporter#231

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Discovery info for processedtemplates & templates both have kind: Template #21668

Discovery info for processedtemplates & templates both have kind: Template #21668

cben commented Dec 16, 2018 •

edited

openshift-bot commented Mar 17, 2019

openshift-bot commented Apr 16, 2019

openshift-bot commented May 16, 2019

openshift-ci-robot commented May 16, 2019

cben commented May 19, 2019

openshift-ci-robot commented May 19, 2019

cben commented May 19, 2019 •

edited

cben commented May 19, 2019

openshift-bot commented Jun 18, 2019

openshift-ci-robot commented Jun 18, 2019

cben commented Jun 19, 2019

openshift-ci-robot commented Jun 19, 2019

CermakM commented Nov 13, 2019

Discovery info for processedtemplates & templates both have kind: Template #21668

Discovery info for processedtemplates & templates both have kind: Template #21668

Comments

cben commented Dec 16, 2018 • edited

Version

Steps To Reproduce

Current Result

Expected Result

Additional Information

openshift-bot commented Mar 17, 2019

openshift-bot commented Apr 16, 2019

openshift-bot commented May 16, 2019

openshift-ci-robot commented May 16, 2019

cben commented May 19, 2019

openshift-ci-robot commented May 19, 2019

cben commented May 19, 2019 • edited

cben commented May 19, 2019

openshift-bot commented Jun 18, 2019

openshift-ci-robot commented Jun 18, 2019

cben commented Jun 19, 2019

openshift-ci-robot commented Jun 19, 2019

CermakM commented Nov 13, 2019

cben commented Dec 16, 2018 •

edited

cben commented May 19, 2019 •

edited