calicoctl patch

This sections describes the calicoctl patch command.

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

Displaying the help text for ‘calicoctl patch’ command

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

  1. Usage:
  2.   calicoctl patch <KIND> <NAME> --patch=<PATCH> [--type=<TYPE>] [--config=<CONFIG>] [--namespace=<NS>]
  4. Examples:
  5.   # Partially update a node using a strategic merge patch.
  6.   calicoctl patch node node-0 --patch '{"spec":{"bgp": {"routeReflectorClusterID": "CLUSTER_ID"}}}'
  8.   # Partially update a node using a json merge patch.
  9.   calicoctl patch node node-0 --patch '{"spec":{"bgp": {"routeReflectorClusterID": "CLUSTER_ID"}}}' --type json
  11. Options:
  12.   -h --help                  Show this screen.
  13.   -p --patch=<PATCH>         Spec to use to patch the resource.
  14.   -t --type=<TYPE>           Format of patch type:
  15.                                 strategic   Strategic merge patch (default)
  16.                                 json        JSON Patch, RFC 6902 (not yet implemented)
  17.                                 merge       JSON Merge Patch, RFC 7386 (not yet implemented)
  18.   -c --config=<CONFIG>       Path to the file containing connection
  19.                              configuration in YAML or JSON format.
  20.                              [default: ` + constants.DefaultConfigPath + `]
  21.   -n --namespace=<NS>        Namespace of the resource.
  22.                              Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint.
  23.                              Uses the default namespace if not specified.
  24.   --context=<context>        The name of the kubeconfig context to use.
  26. Description:
  27.   The patch command is used to patch a specific resource by type and identifiers in place.
  28.   Currently, only JSON format is accepted.
  30.   Valid resource types are:
  32.     * bgpConfiguration
  33.     * bgpPeer
  34.     * felixConfiguration
  35.     * globalNetworkPolicy
  36.     * globalNetworkSet
  37.     * hostEndpoint
  38.     * ipPool
  39.     * networkPolicy
  40.     * networkSet
  41.     * node
  42.     * profile
  43.     * workloadEndpoint
  45.   The resource type is case insensitive and may be pluralized.
  46.   Attempting to patch a resource that does not exists is treated as a
  47.   terminating error unless the --skip-not-exists flag is set.  If this flag is
  48.   set, resources that do not exist are skipped.
  50.   When patching resources by type, only a single type may be specified at a
  51.   time.  The name is required along with any and other identifiers required to
  52.   uniquely identify a resource of the specified type.

Examples

  1. Patch an IP Pool to enable outgoing NAT:

    1. calicoctl patch ippool ippool1 -p '{"spec":{"natOutgoing": true}}'

    Results indicate that a resource was successfully patched:

    1. Successfully patched 1 'ipPool' resource

Options

  1. -p --patch=<PATCH>        Spec to use to patch the resource.
  2. -t --type=<TYPE>          Format of patch type:
  3.                              strategic   Strategic merge patch (default)
  4.                              json        JSON Patch, RFC 6902 (not yet implemented)
  5.                              merge       JSON Merge Patch, RFC 7386 (not yet implemented)
  6. -n --namespace=<NS>       Namespace of the resource.
  7.                           Only applicable to NetworkPolicy and WorkloadEndpoint.
  8.                           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