Skip to content

Commit

Permalink
Fix calicoctl resource list docs (#1743)
Browse files Browse the repository at this point in the history
  • Loading branch information
caseydavenport authored Oct 29, 2024
1 parent 84df617 commit 26f78c9
Show file tree
Hide file tree
Showing 13 changed files with 218 additions and 149 deletions.
28 changes: 17 additions & 11 deletions calico/reference/calicoctl/apply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
28 changes: 17 additions & 11 deletions calico/reference/calicoctl/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
31 changes: 14 additions & 17 deletions calico/reference/calicoctl/datastore/migrate/export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,25 +29,25 @@ 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
- KubeControllersConfigurations
- NetworkPolicies
- Networksets
- Nodes
- BGPConfigurations
- FelixConfigurations
- IPReservations
- BGPFilters
The following resources are not exported:
- WorkloadEndpoints
- Profiles
```
Expand All @@ -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
Expand Down
27 changes: 17 additions & 10 deletions calico/reference/calicoctl/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
28 changes: 17 additions & 11 deletions calico/reference/calicoctl/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
29 changes: 17 additions & 12 deletions calico/reference/calicoctl/patch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
28 changes: 17 additions & 11 deletions calico/reference/calicoctl/replace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
28 changes: 17 additions & 11 deletions calico_versioned_docs/version-3.29/reference/calicoctl/apply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
28 changes: 17 additions & 11 deletions calico_versioned_docs/version-3.29/reference/calicoctl/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
27 changes: 17 additions & 10 deletions calico_versioned_docs/version-3.29/reference/calicoctl/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading

0 comments on commit 26f78c9

Please sign in to comment.