calicoctl delete

This sections describes the calicoctl delete command.

Read the calicoctl command line interface user reference for a full list of calicoctl commands.

calicoctl delete - 图1note

The available actions for a specific resource type may be limited based on the datastore used for Calico (etcdv3 / Kubernetes API). Please refer to the Resources section for details about each resource type.

Displaying the help text for ‘calicoctl delete’ command

Run calicoctl delete --help to display the following help menu for the command.

  1. Usage:
  2.   calicoctl delete ( (<KIND> [<NAME...>]) |
  3.                    --filename=<FILE>) [--recursive] [--skip-empty]
  4.                    [--skip-not-exists] [--config=<CONFIG>] [--namespace=<NS>]
  6. Examples:
  7.   # Delete a policy using the type and name specified in policy.yaml.
  8.   calicoctl delete -f ./policy.yaml
  10.   # Delete a policy based on the type and name in the YAML passed into stdin.
  11.   cat policy.yaml | calicoctl delete -f -
  13.   # Delete policies with names "foo" and "bar"
  14.   calicoctl delete policy foo bar
  16. Options:
  17.   -h --help                 Show this screen.
  18.   -s --skip-not-exists      Skip over and treat as successful, resources that
  19.                             don't exist.
  20.   -f --filename=<FILENAME>  Filename to use to delete the resource.  If set to
  21.                             "-" loads from stdin. If filename is a directory, this command is
  22.                             invoked for each .json .yaml and .yml file within that directory,
  23.                             terminating after the first failure.
  24.   -R --recursive            Process the filename specified in -f or --filename recursively.
  25.      --skip-empty           Do not error if any files or directory specified using -f or --filename contain no
  26.                             data.
  27.   -c --config=<CONFIG>      Path to the file containing connection
  28.                             configuration in YAML or JSON format.
  29.                             [default: /etc/calico/calicoctl.cfg]
  30.   -n --namespace=<NS>       Namespace of the resource.
  31.                             Only applicable to NetworkPolicy and WorkloadEndpoint.
  32.                             Uses the default namespace if not specified.
  33.   --context=<context>       The name of the kubeconfig context to use.
  35. Description:
  36.   The delete command is used to delete a set of resources by filename or stdin,
  37.   or by type and identifiers.  JSON and YAML formats are accepted for file and
  38.   stdin format.
  40.   Valid resource types are:
  42.     * bgpConfiguration
  43.     * bgpPeer
  44.     * felixConfiguration
  45.     * globalNetworkPolicy
  46.     * hostEndpoint
  47.     * ipPool
  48.     * networkPolicy
  49.     * node
  50.     * profile
  51.     * workloadEndpoint
  53.   The resource type is case insensitive and may be pluralized.
  55.   Attempting to delete a resource that does not exists is treated as a
  56.   terminating error unless the --skip-not-exists flag is set.  If this flag is
  57.   set, resources that do not exist are skipped.
  59.   When deleting resources by type, only a single type may be specified at a
  60.   time.  The name is required along with any and other identifiers required to
  61.   uniquely identify a resource of the specified type.
  63.   The output of the command indicates how many resources were successfully
  64.   deleted, and the error reason if an error occurred.  If the --skip-not-exists
  65.   flag is set then skipped resources are included in the success count.
  67.   The resources are deleted in the order they are specified.  In the event of a
  68.   failure deleting a specific resource it is possible to work out which
  69.   resource failed based on the number of resources successfully deleted.

Examples

  1. Delete a set of resources (of mixed type) using the data in resources.yaml.

    1. calicoctl delete -f ./resources.yaml

    Results indicate that 8 resources were successfully deleted.

    1. Successfully deleted 8 resource(s)

  2. Delete a policy resource by name. The policy is called “policy1”.

    1. bin/calicoctl delete policy policy1

    Results indicate success.

    1. Successfully deleted 1 'policy' resource(s)

Options

  1. -s --skip-not-exists      Skip over and treat as successful, resources that
  2.                           don't exist.
  3. -f --filename=<FILENAME>  Filename to use to delete the resource.  If set to
  4.                           "-" loads from stdin.
  5. -n --namespace=<NS>       Namespace of the resource.
  6.                           Only applicable to NetworkPolicy and WorkloadEndpoint.
  7.                           Uses the default namespace if not specified.

General options

  1. -c --config=<CONFIG>      Path to the file containing connection
  2.                           configuration in YAML or JSON format.
  3.                           [default: /etc/calico/calicoctl.cfg]

See also