From 26f78c91bd43d41f7ff393daee327e79c879c79f Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Tue, 29 Oct 2024 14:47:18 -0700 Subject: [PATCH] Fix calicoctl resource list docs (#1743) --- calico/reference/calicoctl/apply.mdx | 28 ++++++++++------- calico/reference/calicoctl/create.mdx | 28 ++++++++++------- .../calicoctl/datastore/migrate/export.mdx | 31 +++++++++---------- calico/reference/calicoctl/delete.mdx | 27 ++++++++++------ calico/reference/calicoctl/get.mdx | 28 ++++++++++------- calico/reference/calicoctl/patch.mdx | 29 ++++++++++------- calico/reference/calicoctl/replace.mdx | 28 ++++++++++------- .../reference/calicoctl/apply.mdx | 28 ++++++++++------- .../reference/calicoctl/create.mdx | 28 ++++++++++------- .../reference/calicoctl/delete.mdx | 27 ++++++++++------ .../version-3.29/reference/calicoctl/get.mdx | 28 ++++++++++------- .../reference/calicoctl/patch.mdx | 29 ++++++++++------- .../reference/calicoctl/replace.mdx | 28 ++++++++++------- 13 files changed, 218 insertions(+), 149 deletions(-) diff --git a/calico/reference/calicoctl/apply.mdx b/calico/reference/calicoctl/apply.mdx index ed64e56aa3..998f61c65c 100644 --- a/calico/reference/calicoctl/apply.mdx +++ b/calico/reference/calicoctl/apply.mdx @@ -59,17 +59,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint When applying a resource: - if the resource does not already exist (as determined by it's primary diff --git a/calico/reference/calicoctl/create.mdx b/calico/reference/calicoctl/create.mdx index 846bbc3806..27673ed173 100644 --- a/calico/reference/calicoctl/create.mdx +++ b/calico/reference/calicoctl/create.mdx @@ -60,17 +60,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint Attempting to create a resource that already exists is treated as a terminating error unless the --skip-exists flag is set. If this flag is set, diff --git a/calico/reference/calicoctl/datastore/migrate/export.mdx b/calico/reference/calicoctl/datastore/migrate/export.mdx index 8970f095cb..1692d739a7 100644 --- a/calico/reference/calicoctl/datastore/migrate/export.mdx +++ b/calico/reference/calicoctl/datastore/migrate/export.mdx @@ -29,16 +29,10 @@ Description: in yaml and json format. Save the results of this command to a file for later use with the import command. - The resources exported include the following: - - IPAMBlocks - - BlockAffinities - - IPAMHandles - - IPAMConfigurations + The following resources are exported: + - IPPools - - BGPConfigurations - BGPPeers - - ClusterInformations - - FelixConfigurations - GlobalNetworkPolicies - GlobalNetworkSets - HostEndpoints @@ -46,8 +40,14 @@ Description: - NetworkPolicies - Networksets - Nodes + - BGPConfigurations + - FelixConfigurations + - IPReservations + - BGPFilters + The following resources are not exported: + - WorkloadEndpoints - Profiles ``` @@ -56,24 +56,21 @@ Description: The `export` subcommand exports the following Calico resources: -- IPAMBlocks -- BlockAffinities -- IPAMHandles -- IPAMConfigurations - IPPools -- BGPConfigurations - BGPPeers -- ClusterInformations -- FelixConfigurations - GlobalNetworkPolicies - GlobalNetworkSets - HostEndpoints +- KubeControllersConfigurations - NetworkPolicies - Networksets - Nodes +- BGPConfigurations +- FelixConfigurations +- IPReservations +- BGPFilters -The `export` subcommand does not export the following resources -since they should be generated: +The `export` subcommand does not export the following resources since they should be generated: - WorkloadEndpoints - Profiles diff --git a/calico/reference/calicoctl/delete.mdx b/calico/reference/calicoctl/delete.mdx index 829a324591..81458477f3 100644 --- a/calico/reference/calicoctl/delete.mdx +++ b/calico/reference/calicoctl/delete.mdx @@ -66,16 +66,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint The resource type is case-insensitive and may be pluralized. diff --git a/calico/reference/calicoctl/get.mdx b/calico/reference/calicoctl/get.mdx index 48147f79a7..78b3782293 100644 --- a/calico/reference/calicoctl/get.mdx +++ b/calico/reference/calicoctl/get.mdx @@ -69,17 +69,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint The resource type is case-insensitive and may be pluralized. diff --git a/calico/reference/calicoctl/patch.mdx b/calico/reference/calicoctl/patch.mdx index e7bf8dbf1c..ca35018872 100644 --- a/calico/reference/calicoctl/patch.mdx +++ b/calico/reference/calicoctl/patch.mdx @@ -46,18 +46,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * globalNetworkSet - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint The resource type is case-insensitive and may be pluralized. Attempting to patch a resource that does not exists is treated as a diff --git a/calico/reference/calicoctl/replace.mdx b/calico/reference/calicoctl/replace.mdx index 22481929d6..5ec0b89fe4 100644 --- a/calico/reference/calicoctl/replace.mdx +++ b/calico/reference/calicoctl/replace.mdx @@ -58,17 +58,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint Attempting to replace a resource that does not exist is treated as a terminating error. diff --git a/calico_versioned_docs/version-3.29/reference/calicoctl/apply.mdx b/calico_versioned_docs/version-3.29/reference/calicoctl/apply.mdx index ed64e56aa3..998f61c65c 100644 --- a/calico_versioned_docs/version-3.29/reference/calicoctl/apply.mdx +++ b/calico_versioned_docs/version-3.29/reference/calicoctl/apply.mdx @@ -59,17 +59,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint When applying a resource: - if the resource does not already exist (as determined by it's primary diff --git a/calico_versioned_docs/version-3.29/reference/calicoctl/create.mdx b/calico_versioned_docs/version-3.29/reference/calicoctl/create.mdx index 846bbc3806..27673ed173 100644 --- a/calico_versioned_docs/version-3.29/reference/calicoctl/create.mdx +++ b/calico_versioned_docs/version-3.29/reference/calicoctl/create.mdx @@ -60,17 +60,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint Attempting to create a resource that already exists is treated as a terminating error unless the --skip-exists flag is set. If this flag is set, diff --git a/calico_versioned_docs/version-3.29/reference/calicoctl/delete.mdx b/calico_versioned_docs/version-3.29/reference/calicoctl/delete.mdx index 829a324591..81458477f3 100644 --- a/calico_versioned_docs/version-3.29/reference/calicoctl/delete.mdx +++ b/calico_versioned_docs/version-3.29/reference/calicoctl/delete.mdx @@ -66,16 +66,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint The resource type is case-insensitive and may be pluralized. diff --git a/calico_versioned_docs/version-3.29/reference/calicoctl/get.mdx b/calico_versioned_docs/version-3.29/reference/calicoctl/get.mdx index 48147f79a7..78b3782293 100644 --- a/calico_versioned_docs/version-3.29/reference/calicoctl/get.mdx +++ b/calico_versioned_docs/version-3.29/reference/calicoctl/get.mdx @@ -69,17 +69,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint The resource type is case-insensitive and may be pluralized. diff --git a/calico_versioned_docs/version-3.29/reference/calicoctl/patch.mdx b/calico_versioned_docs/version-3.29/reference/calicoctl/patch.mdx index e7bf8dbf1c..ca35018872 100644 --- a/calico_versioned_docs/version-3.29/reference/calicoctl/patch.mdx +++ b/calico_versioned_docs/version-3.29/reference/calicoctl/patch.mdx @@ -46,18 +46,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * globalNetworkSet - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint The resource type is case-insensitive and may be pluralized. Attempting to patch a resource that does not exists is treated as a diff --git a/calico_versioned_docs/version-3.29/reference/calicoctl/replace.mdx b/calico_versioned_docs/version-3.29/reference/calicoctl/replace.mdx index 22481929d6..5ec0b89fe4 100644 --- a/calico_versioned_docs/version-3.29/reference/calicoctl/replace.mdx +++ b/calico_versioned_docs/version-3.29/reference/calicoctl/replace.mdx @@ -58,17 +58,23 @@ Description: Valid resource types are: - * bgpConfiguration - * bgpPeer - * felixConfiguration - * globalNetworkPolicy - * hostEndpoint - * ipPool - * networkPolicy - * networkSet - * node - * profile - * workloadEndpoint + - bgpconfiguration + - bgpfilter + - bgppeer + - clusterinformation + - felixconfiguration + - globalnetworkpolicy + - globalnetworkset + - hostendpoint + - ippool + - ipreservation + - kubecontrollersconfiguration + - networkpolicy + - networkset + - node + - profile + - tier + - workloadendpoint Attempting to replace a resource that does not exist is treated as a terminating error.