From 459d241c659408867d6a5d3733f1fb243e65f7f0 Mon Sep 17 00:00:00 2001 From: Steve Hawkins Date: Fri, 24 Jun 2022 15:32:18 -0400 Subject: [PATCH] chore #3906: deprecating CustomResourceList --- doc/MIGRATION-v6.md | 5 +-- .../kubernetes/client/CustomResourceList.java | 4 +++ .../kubernetes/examples/CRDExample.java | 35 +++++++++---------- .../examples/CustomResourceV1Example.java | 4 +-- .../kubernetes/examples/crds/DummyList.java | 4 +-- 5 files changed, 28 insertions(+), 24 deletions(-) diff --git a/doc/MIGRATION-v6.md b/doc/MIGRATION-v6.md index 10a5e28416..a6305a8c6a 100644 --- a/doc/MIGRATION-v6.md +++ b/doc/MIGRATION-v6.md @@ -244,10 +244,11 @@ We've removed setter methods `setIntVal`, `setKind`, `setStrVal` from the class. - DSL methods available off of a resource context involving a resource - `client.configMaps().withName("name").create(configMap)` - should instead use a no-argument method - `client.configMaps().resource(configMap).create()` or `client.resource(configMap).create()`. -- DSL methods available off of a collection context involving a resource - `client.configMaps().create(configMap)` - should instead use a no-argument method - `client.configMaps().resource(configMap).create()` or `client.resource(configMap).create()`. - +- DSL methods available off of a collection context involving a resource - `client.configMaps().create(configMap)` - should instead use a no-argument method - `client.configMaps().resource(configMap).create()` or `client.resource(configMap).create()`. The only exception to the above is `patch(PatchContext, item)` - it is valid to be called after withName. +- CustomResourceList was deprecated - use DefaultKubernetesResourceList instead. + ## Object Sorting `KubernetesList` and `Template` will no longer automatically sort their objects by default. You may use the `HasMetadataComparator` yourself to sort the items as needed. diff --git a/kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/CustomResourceList.java b/kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/CustomResourceList.java index fcdf81813b..b1124bc640 100644 --- a/kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/CustomResourceList.java +++ b/kubernetes-client-api/src/main/java/io/fabric8/kubernetes/client/CustomResourceList.java @@ -18,5 +18,9 @@ import io.fabric8.kubernetes.api.model.DefaultKubernetesResourceList; import io.fabric8.kubernetes.api.model.HasMetadata; +/** + * @deprecated use DefaultKubernetesResourceList instead + */ +@Deprecated public class CustomResourceList extends DefaultKubernetesResourceList { } diff --git a/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CRDExample.java b/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CRDExample.java index aeb5232bba..05495fcf16 100644 --- a/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CRDExample.java +++ b/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CRDExample.java @@ -21,7 +21,6 @@ import io.fabric8.kubernetes.api.model.apiextensions.v1.CustomResourceDefinitionList; import io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder; import io.fabric8.kubernetes.client.CustomResource; -import io.fabric8.kubernetes.client.CustomResourceList; import io.fabric8.kubernetes.client.KubernetesClient; import io.fabric8.kubernetes.client.KubernetesClientBuilder; import io.fabric8.kubernetes.client.KubernetesClientException; @@ -111,23 +110,23 @@ public static void main(String[] args) { System.out.println("Found CRD: " + dummyCRD.getMetadata().getSelfLink()); } else { dummyCRD = CustomResourceDefinitionContext.v1CRDFromCustomResourceType(Dummy.class) - .editSpec() - .editVersion(0) - .withNewSchema() - .withNewOpenAPIV3Schema() - .withTitle("dummy") - .withType("object") - .addToRequired("spec") - .addToProperties("spec", new JSONSchemaPropsBuilder() + .editSpec() + .editVersion(0) + .withNewSchema() + .withNewOpenAPIV3Schema() + .withTitle("dummy") .withType("object") - .addToProperties("foo", new JSONSchemaPropsBuilder().withType("string").build()) - .addToProperties("bar", new JSONSchemaPropsBuilder().withType("string").build()) - .build()) - .endOpenAPIV3Schema() - .endSchema() - .endVersion() - .endSpec() - .build(); + .addToRequired("spec") + .addToProperties("spec", new JSONSchemaPropsBuilder() + .withType("object") + .addToProperties("foo", new JSONSchemaPropsBuilder().withType("string").build()) + .addToProperties("bar", new JSONSchemaPropsBuilder().withType("string").build()) + .build()) + .endOpenAPIV3Schema() + .endSchema() + .endVersion() + .endSpec() + .build(); client.apiextensions().v1().customResourceDefinitions().create(dummyCRD); System.out.println("Created CRD " + dummyCRD.getMetadata().getName()); @@ -141,7 +140,7 @@ public static void main(String[] args) { if (resourceNamespaced) { dummyClient = ((MixedOperation>) dummyClient).inNamespace(namespace); } - CustomResourceList dummyList = dummyClient.list(); + DummyList dummyList = dummyClient.list(); List items = dummyList.getItems(); System.out.println(" found " + items.size() + " dummies"); for (Dummy item : items) { diff --git a/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CustomResourceV1Example.java b/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CustomResourceV1Example.java index 8cb3001b33..f8c379d12f 100644 --- a/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CustomResourceV1Example.java +++ b/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/CustomResourceV1Example.java @@ -15,12 +15,12 @@ */ package io.fabric8.kubernetes.examples; +import io.fabric8.kubernetes.api.model.DefaultKubernetesResourceList; import io.fabric8.kubernetes.api.model.Namespaced; import io.fabric8.kubernetes.api.model.ObjectMetaBuilder; import io.fabric8.kubernetes.api.model.apiextensions.v1.CustomResourceDefinition; import io.fabric8.kubernetes.api.model.apiextensions.v1.JSONSchemaPropsBuilder; import io.fabric8.kubernetes.client.CustomResource; -import io.fabric8.kubernetes.client.CustomResourceList; import io.fabric8.kubernetes.client.KubernetesClient; import io.fabric8.kubernetes.client.KubernetesClientBuilder; import io.fabric8.kubernetes.client.dsl.NonNamespaceOperation; @@ -82,7 +82,7 @@ public Show(String metaName, ShowSpec spec) { } } - public static final class ShowList extends CustomResourceList { + public static final class ShowList extends DefaultKubernetesResourceList { } @SuppressWarnings("unused") diff --git a/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/crds/DummyList.java b/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/crds/DummyList.java index b1077f413b..391a2a5608 100644 --- a/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/crds/DummyList.java +++ b/kubernetes-examples/src/main/java/io/fabric8/kubernetes/examples/crds/DummyList.java @@ -15,7 +15,7 @@ */ package io.fabric8.kubernetes.examples.crds; -import io.fabric8.kubernetes.client.CustomResourceList; +import io.fabric8.kubernetes.api.model.DefaultKubernetesResourceList; -public class DummyList extends CustomResourceList { +public class DummyList extends DefaultKubernetesResourceList { }