Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Calico Enterprise calicoctl docs with accurate resource lists #1745

Merged
merged 1 commit into from
Oct 30, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 28 additions & 12 deletions calico-enterprise/reference/clis/calicoctl/apply.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,18 +58,34 @@ Description:

Valid resource types are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* hostEndpoint
* ipPool
* tier
* networkPolicy
* networkSet
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- workloadendpoint

When applying a resource:
- if the resource does not already exist (as determined by it's primary
Expand Down
39 changes: 28 additions & 11 deletions calico-enterprise/reference/clis/calicoctl/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,17 +50,34 @@ Description:

Valid resource types are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* hostEndpoint
* ipPool
* tier
* networkSet
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- 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
39 changes: 28 additions & 11 deletions calico-enterprise/reference/clis/calicoctl/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,17 +66,34 @@ Description:

Valid resource types are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* hostEndpoint
* ipPool
* tier
* networkPolicy
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- workloadendpoint

The resource type is case-insensitive and may be pluralized.

Expand Down
39 changes: 28 additions & 11 deletions calico-enterprise/reference/clis/calicoctl/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,17 +69,34 @@ Description:

Valid resource types are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* hostEndpoint
* ipPool
* tier
* networkSet
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- workloadendpoint

The resource type is case-insensitive and may be pluralized.

Expand Down
40 changes: 28 additions & 12 deletions calico-enterprise/reference/clis/calicoctl/label.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,18 +62,34 @@ Description:
The label command is used to add or update a label on a resource. Resource types
that can be labeled are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* globalNetworkSet
* hostEndpoint
* ipPool
* networkPolicy
* networkSet
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- workloadendpoint

The resource type is case-insensitive and may be pluralized.

Expand Down
40 changes: 28 additions & 12 deletions calico-enterprise/reference/clis/calicoctl/patch.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,34 @@ Description:

Valid resource types are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* globalNetworkSet
* hostEndpoint
* ipPool
* networkPolicy
* networkSet
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- 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
39 changes: 28 additions & 11 deletions calico-enterprise/reference/clis/calicoctl/replace.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,34 @@ Description:

Valid resource types are:

* bgpConfiguration
* bgpPeer
* felixConfiguration
* globalNetworkPolicy
* hostEndpoint
* ipPool
* tier
* networkSet
* node
* profile
* workloadEndpoint
- bfdconfiguration
- bgpconfiguration
- bgpfilter
- bgppeer
- clusterinformation
- egressgatewaypolicy
- externalnetwork
- felixconfiguration
- globalnetworkpolicy
- globalnetworkset
- globalthreatfeed
- hostendpoint
- ippool
- ipreservation
- kubecontrollersconfiguration
- licensekey
- networkpolicy
- networkset
- node
- packetcapture
- profile
- remoteclusterconfiguration
- stagedglobalnetworkpolicy
- stagedkubernetesnetworkpolicy
- stagednetworkpolicy
- tier
- uisettingsgroup
- workloadendpoint

Attempting to replace a resource that does not exist is treated as a
terminating error.
Expand Down
Loading