From 1f89388b7d05232819c03b0b01448d419e05209f Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Thu, 23 Jul 2026 08:29:25 -0700 Subject: [PATCH 1/6] Add calicoctl datastore migrate-policy-names reference docs Documents the new command for the Next and v3.32 docs. OSS only for now, since the command has not merged to Calico Enterprise yet. --- .../datastore/migrate-policy-names.mdx | 74 ++++++++++++++++++ .../calicoctl/datastore/overview.mdx | 8 +- .../datastore/migrate-policy-names.mdx | 75 +++++++++++++++++++ .../calicoctl/datastore/overview.mdx | 8 +- .../version-3.32-sidebars.json | 3 +- sidebars-calico.js | 1 + 6 files changed, 162 insertions(+), 7 deletions(-) create mode 100644 calico/reference/calicoctl/datastore/migrate-policy-names.mdx create mode 100644 calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx diff --git a/calico/reference/calicoctl/datastore/migrate-policy-names.mdx b/calico/reference/calicoctl/datastore/migrate-policy-names.mdx new file mode 100644 index 0000000000..ea5569b6f9 --- /dev/null +++ b/calico/reference/calicoctl/datastore/migrate-policy-names.mdx @@ -0,0 +1,74 @@ +--- +description: Reference for the calicoctl datastore migrate-policy-names command in Calico Open Source, used to fix pre-v3.32 policy names on an upgraded etcdv3 datastore. +--- + +# calicoctl datastore migrate-policy-names + +This section describes the `calicoctl datastore migrate-policy-names` command. + +Read the [calicoctl Overview](../overview.mdx) +for a full list of calicoctl commands. + +:::note + +You only need this command on an etcdv3 datastore (for example, OpenStack) that +was created before v3.32 and upgraded in place. A Kubernetes datastore is +migrated automatically by kube-controllers, so no manual step is required there. + +::: + +## Display the help text for 'calicoctl datastore migrate-policy-names' command + +Run `calicoctl datastore migrate-policy-names --help` to display the following help menu for the +command. + +``` +Usage: + calicoctl datastore migrate-policy-names [--config=] [--allow-version-mismatch] + +Options: + -h --help Show this screen. + -c --config= Path to the file containing connection + configuration in YAML or JSON format. + [default: /etc/calico/calicoctl.cfg] + --allow-version-mismatch Allow client and cluster versions mismatch. + +Description: + Rewrite policy names in the datastore to drop the legacy "default." tier + prefix, aligning the stored name with the v3 resource name introduced in + v3.32. + + This is only needed for an etcdv3 datastore (for example OpenStack) that was + created before v3.32 and upgraded in place. A Kubernetes datastore is + migrated automatically by kube-controllers. The command is safe to re-run. +``` + +### Examples + +Rewrite any pre-v3.32 policy names in the datastore so they match their v3 names. + +```bash +calicoctl datastore migrate-policy-names +``` + +On completion, the command reports how many policies it rewrote. + +``` +Policy name migration complete, migrated 5 policies. +``` + +The command is idempotent. Running it again once every policy has already been +migrated reports `migrated 0 policies` and makes no changes. + +### General options + +``` +-c --config= Path to the file containing connection + configuration in YAML or JSON format. + [default: /etc/calico/calicoctl.cfg] +``` + +## See also + +- [Install calicoctl](../../../operations/calicoctl/install.mdx) +- [Upgrade Calico on OpenStack](../../../operations/upgrading/openstack-upgrade.mdx) for the full upgrade procedure that runs this command diff --git a/calico/reference/calicoctl/datastore/overview.mdx b/calico/reference/calicoctl/datastore/overview.mdx index 7490ae094f..8f24b6bda8 100644 --- a/calico/reference/calicoctl/datastore/overview.mdx +++ b/calico/reference/calicoctl/datastore/overview.mdx @@ -9,16 +9,17 @@ This section describes the `calicoctl datastore` commands. Read the [calicoctl Overview](../overview.mdx) for a full list of calicoctl commands. -## Display the help text for 'calicoctl datastore migrate' commands +## Display the help text for 'calicoctl datastore' commands -Run `calicoctl datastore migrate --help` to display the following help menu for the +Run `calicoctl datastore --help` to display the following help menu for the commands. ``` Usage: calicoctl datastore [...] - migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. + migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. + migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix. Options: -h --help Show this screen. @@ -35,3 +36,4 @@ Details on the `calicoctl datastore` commands are described in the documents lin organized by sub command. - [calicoctl datastore migrate](migrate/overview.mdx) +- [calicoctl datastore migrate-policy-names](migrate-policy-names.mdx) diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx new file mode 100644 index 0000000000..9eea2a112f --- /dev/null +++ b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx @@ -0,0 +1,75 @@ +--- +description: Reference for the calicoctl datastore migrate-policy-names command in Calico Open Source, used to fix pre-v3.32 policy names on an upgraded etcdv3 datastore. +--- + +# calicoctl datastore migrate-policy-names + +This section describes the `calicoctl datastore migrate-policy-names` command. + +Read the [calicoctl Overview](../overview.mdx) +for a full list of calicoctl commands. + +:::note + +This command is available in Calico v3.32.2 and later. You only need it on an +etcdv3 datastore (for example, OpenStack) that was created before v3.32 and +upgraded in place. A Kubernetes datastore is migrated automatically by +kube-controllers, so no manual step is required there. + +::: + +## Display the help text for 'calicoctl datastore migrate-policy-names' command + +Run `calicoctl datastore migrate-policy-names --help` to display the following help menu for the +command. + +``` +Usage: + calicoctl datastore migrate-policy-names [--config=] [--allow-version-mismatch] + +Options: + -h --help Show this screen. + -c --config= Path to the file containing connection + configuration in YAML or JSON format. + [default: /etc/calico/calicoctl.cfg] + --allow-version-mismatch Allow client and cluster versions mismatch. + +Description: + Rewrite policy names in the datastore to drop the legacy "default." tier + prefix, aligning the stored name with the v3 resource name introduced in + v3.32. + + This is only needed for an etcdv3 datastore (for example OpenStack) that was + created before v3.32 and upgraded in place. A Kubernetes datastore is + migrated automatically by kube-controllers. The command is safe to re-run. +``` + +### Examples + +Rewrite any pre-v3.32 policy names in the datastore so they match their v3 names. + +```bash +calicoctl datastore migrate-policy-names +``` + +On completion, the command reports how many policies it rewrote. + +``` +Policy name migration complete, migrated 5 policies. +``` + +The command is idempotent. Running it again once every policy has already been +migrated reports `migrated 0 policies` and makes no changes. + +### General options + +``` +-c --config= Path to the file containing connection + configuration in YAML or JSON format. + [default: /etc/calico/calicoctl.cfg] +``` + +## See also + +- [Install calicoctl](../../../operations/calicoctl/install.mdx) +- [Upgrade Calico on OpenStack](../../../operations/upgrading/openstack-upgrade.mdx) for the full upgrade procedure that runs this command diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx index 7490ae094f..8f24b6bda8 100644 --- a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx +++ b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx @@ -9,16 +9,17 @@ This section describes the `calicoctl datastore` commands. Read the [calicoctl Overview](../overview.mdx) for a full list of calicoctl commands. -## Display the help text for 'calicoctl datastore migrate' commands +## Display the help text for 'calicoctl datastore' commands -Run `calicoctl datastore migrate --help` to display the following help menu for the +Run `calicoctl datastore --help` to display the following help menu for the commands. ``` Usage: calicoctl datastore [...] - migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. + migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. + migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix. Options: -h --help Show this screen. @@ -35,3 +36,4 @@ Details on the `calicoctl datastore` commands are described in the documents lin organized by sub command. - [calicoctl datastore migrate](migrate/overview.mdx) +- [calicoctl datastore migrate-policy-names](migrate-policy-names.mdx) diff --git a/calico_versioned_sidebars/version-3.32-sidebars.json b/calico_versioned_sidebars/version-3.32-sidebars.json index 2f36ba2473..e3a1e03533 100644 --- a/calico_versioned_sidebars/version-3.32-sidebars.json +++ b/calico_versioned_sidebars/version-3.32-sidebars.json @@ -685,7 +685,8 @@ "reference/calicoctl/datastore/migrate/lock", "reference/calicoctl/datastore/migrate/unlock" ] - } + }, + "reference/calicoctl/datastore/migrate-policy-names" ] }, "reference/calicoctl/version" diff --git a/sidebars-calico.js b/sidebars-calico.js index 79c2dabcf7..a8d9b1abb6 100644 --- a/sidebars-calico.js +++ b/sidebars-calico.js @@ -692,6 +692,7 @@ module.exports = { 'reference/calicoctl/datastore/migrate/unlock', ], }, + 'reference/calicoctl/datastore/migrate-policy-names', ], }, 'reference/calicoctl/version', From f4e257ce2aec337952c6617c0cb4b1cd9ef2f68b Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Thu, 23 Jul 2026 08:49:22 -0700 Subject: [PATCH 2/6] Name the default tier in migrate-policy-names help text Matches the CLI wording clarification (calicoctl now says it drops the legacy "default." tier prefix). --- calico/reference/calicoctl/datastore/overview.mdx | 2 +- .../version-3.32/reference/calicoctl/datastore/overview.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/calico/reference/calicoctl/datastore/overview.mdx b/calico/reference/calicoctl/datastore/overview.mdx index 8f24b6bda8..e7532d44e3 100644 --- a/calico/reference/calicoctl/datastore/overview.mdx +++ b/calico/reference/calicoctl/datastore/overview.mdx @@ -19,7 +19,7 @@ Usage: calicoctl datastore [...] migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. - migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix. + migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy "default." tier prefix. Options: -h --help Show this screen. diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx index 8f24b6bda8..e7532d44e3 100644 --- a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx +++ b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx @@ -19,7 +19,7 @@ Usage: calicoctl datastore [...] migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. - migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix. + migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy "default." tier prefix. Options: -h --help Show this screen. From f44936fe0d7a32b81dfbdbb5b059073c6062373b Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Thu, 23 Jul 2026 09:16:10 -0700 Subject: [PATCH 3/6] Update calicoctl reference docs for the cobra migration calicoctl moved from docopt to cobra, so the reference pages were showing stale docopt-style --help output. Swap in the real cobra output, and drop the convert command docs since that command no longer exists. --- .../operations/calicoctl/configure/etcd.mdx | 1 - calico/operations/calicoctl/configure/kdd.mdx | 1 - .../calicoctl/configure/overview.mdx | 1 - calico/operations/install-apiserver.mdx | 1 - calico/operations/native-v3-crds.mdx | 1 - calico/reference/calicoctl/apply.mdx | 94 ++----- calico/reference/calicoctl/cluster/diags.mdx | 50 ++-- .../reference/calicoctl/cluster/overview.mdx | 19 +- calico/reference/calicoctl/convert.mdx | 96 -------- calico/reference/calicoctl/create.mdx | 94 ++----- .../datastore/migrate-policy-names.mdx | 33 +-- .../calicoctl/datastore/migrate/export.mdx | 50 +--- .../calicoctl/datastore/migrate/import.mdx | 33 ++- .../calicoctl/datastore/migrate/lock.mdx | 30 ++- .../calicoctl/datastore/migrate/overview.mdx | 25 +- .../calicoctl/datastore/migrate/unlock.mdx | 25 +- .../calicoctl/datastore/overview.mdx | 21 +- calico/reference/calicoctl/delete.mdx | 106 ++------ calico/reference/calicoctl/get.mdx | 137 ++--------- calico/reference/calicoctl/ipam/check.mdx | 30 +-- calico/reference/calicoctl/ipam/configure.mdx | 40 ++- calico/reference/calicoctl/ipam/overview.mdx | 30 ++- calico/reference/calicoctl/ipam/release.mdx | 37 ++- calico/reference/calicoctl/ipam/show.mdx | 43 ++-- calico/reference/calicoctl/ipam/split.mdx | 38 ++- calico/reference/calicoctl/label.mdx | 90 ++----- .../reference/calicoctl/node/checksystem.mdx | 27 +- calico/reference/calicoctl/node/diags.mdx | 29 +-- calico/reference/calicoctl/node/overview.mdx | 26 +- calico/reference/calicoctl/node/run.mdx | 231 +++--------------- calico/reference/calicoctl/node/status.mdx | 15 +- calico/reference/calicoctl/overview.mdx | 65 +++-- calico/reference/calicoctl/patch.mdx | 86 ++----- calico/reference/calicoctl/replace.mdx | 85 ++----- calico/reference/calicoctl/validate.mdx | 82 ++----- calico/reference/calicoctl/version.mdx | 26 +- calico/reference/index.mdx | 1 - .../operations/calicoctl/configure/etcd.mdx | 1 - .../operations/calicoctl/configure/kdd.mdx | 1 - .../calicoctl/configure/overview.mdx | 1 - .../operations/install-apiserver.mdx | 1 - .../operations/native-v3-crds.mdx | 1 - .../reference/calicoctl/convert.mdx | 96 -------- .../version-3.32/reference/index.mdx | 1 - .../version-3.32-sidebars.json | 1 - sidebars-calico.js | 1 - 46 files changed, 521 insertions(+), 1382 deletions(-) delete mode 100644 calico/reference/calicoctl/convert.mdx delete mode 100644 calico_versioned_docs/version-3.32/reference/calicoctl/convert.mdx diff --git a/calico/operations/calicoctl/configure/etcd.mdx b/calico/operations/calicoctl/configure/etcd.mdx index 7913953a7d..2013255f19 100644 --- a/calico/operations/calicoctl/configure/etcd.mdx +++ b/calico/operations/calicoctl/configure/etcd.mdx @@ -25,7 +25,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../../../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../../../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../../../reference/calicoctl/convert.mdx) - [calicoctl version](../../../reference/calicoctl/version.mdx) calicoctl is also required for non-Kubernetes platforms such as OpenStack. diff --git a/calico/operations/calicoctl/configure/kdd.mdx b/calico/operations/calicoctl/configure/kdd.mdx index 86d9e5ec2c..96b8ecf768 100644 --- a/calico/operations/calicoctl/configure/kdd.mdx +++ b/calico/operations/calicoctl/configure/kdd.mdx @@ -25,7 +25,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../../../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../../../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../../../reference/calicoctl/convert.mdx) - [calicoctl version](../../../reference/calicoctl/version.mdx) ### Default configuration diff --git a/calico/operations/calicoctl/configure/overview.mdx b/calico/operations/calicoctl/configure/overview.mdx index fc9d0e47f3..a9742f6729 100644 --- a/calico/operations/calicoctl/configure/overview.mdx +++ b/calico/operations/calicoctl/configure/overview.mdx @@ -25,7 +25,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../../../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../../../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../../../reference/calicoctl/convert.mdx) - [calicoctl version](../../../reference/calicoctl/version.mdx) calicoctl is also required for non-Kubernetes platforms such as OpenStack. diff --git a/calico/operations/install-apiserver.mdx b/calico/operations/install-apiserver.mdx index 605748f88a..841daf85b4 100644 --- a/calico/operations/install-apiserver.mdx +++ b/calico/operations/install-apiserver.mdx @@ -49,7 +49,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../reference/calicoctl/convert.mdx) - [calicoctl version](../reference/calicoctl/version.mdx) ## How to diff --git a/calico/operations/native-v3-crds.mdx b/calico/operations/native-v3-crds.mdx index 2e0e69c57c..79c417af5a 100644 --- a/calico/operations/native-v3-crds.mdx +++ b/calico/operations/native-v3-crds.mdx @@ -187,7 +187,6 @@ When using native `projectcalico.org/v3` CRDs, tier RBAC is enforced via the adm - [calicoctl node](../reference/calicoctl/node/index.mdx) subcommands - [calicoctl ipam](../reference/calicoctl/ipam/index.mdx) subcommands -- [calicoctl convert](../reference/calicoctl/convert.mdx) - [calicoctl version](../reference/calicoctl/version.mdx) ## Known limitations diff --git a/calico/reference/calicoctl/apply.mdx b/calico/reference/calicoctl/apply.mdx index dd12a51b21..03af919ae9 100644 --- a/calico/reference/calicoctl/apply.mdx +++ b/calico/reference/calicoctl/apply.mdx @@ -25,74 +25,23 @@ Run `calicoctl apply --help` to display the following help menu for the command. ``` +Apply a resource by file, directory or stdin + Usage: - calicoctl apply --filename= [--recursive] [--skip-empty] [--config=] [--namespace=] - -Examples: - # Apply a policy using the data in policy.yaml. - calicoctl apply -f ./policy.yaml - - # Apply a policy based on the JSON passed into stdin. - cat policy.json | calicoctl apply -f - - -Options: - -h --help Show this screen. - -f --filename= Filename to use to apply the resource. If set to - "-" loads from stdin. If filename is a directory, this command is - invoked for each .json .yaml and .yml file within that directory, - terminating after the first failure. - -R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint. - Uses the default namespace if not specified. - --context= The name of the kubeconfig context to use. - -Description: - The apply command is used to create or replace a set of resources by filename - or stdin. JSON and YAML formats are accepted. - - Valid resource types are: - - - 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 - identifiers) then it is created - - if the resource already exists then the specification for that resource is - replaced in it's entirety by the new resource specification. - - The output of the command indicates how many resources were successfully - applied, and the error reason if an error occurred. - - The resources are applied in the order they are specified. In the event of a - failure applying a specific resource it is possible to work out which - resource failed based on the number of resources successfully applied - - When applying a resource to perform an update, the complete resource spec - must be provided, it is not sufficient to supply only the fields that are - being updated. + calicoctl apply [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -h, --help help for apply + -n, --namespace string Namespace of the resource. + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -124,19 +73,14 @@ Description: ### Options ``` --f --filename= Filename to use to apply the resource. If set to - "-" loads from stdin. --n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -n, --namespace string Namespace of the resource. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/cluster/diags.mdx b/calico/reference/calicoctl/cluster/diags.mdx index 628d226da5..9b1f495101 100644 --- a/calico/reference/calicoctl/cluster/diags.mdx +++ b/calico/reference/calicoctl/cluster/diags.mdx @@ -18,37 +18,24 @@ Run `calicoctl cluster diags --help` to display the following help menu for the command. ``` -Usage: - calicoctl cluster diags [options] - -Options: - -h --help Show this screen. - --since= Only collect logs newer than provided relative - duration, in seconds (s), minutes (m) or hours (h). - --max-logs= Only collect up to this number of logs, for each - kind of Calico component. [default: 5] - --focus-nodes= Comma-separated list of nodes from which we should - try first to collect logs. - -c --config= Path to connection configuration file. - [default: /etc/calico/calicoctl.cfg] +Collect snapshot of diagnostic info and logs related to Calico at the cluster-level -Description: - The cluster diags command collects a snapshot of diagnostic info and logs related - to Calico for the given cluster. It generates a .tar.gz file containing all the - diags. - - By default, to keep the .tar.gz file to a reasonable size, this command - only collects up to 5 sets of logs for each kind of Calico pod (for example, - for calico-node, or Typha, or the intrusion detection controller). To collect - more (or fewer) sets of logs, use the --max-logs option. +Usage: + calicoctl cluster diags [flags] - To tell calicoctl to try to collect logs first from particular nodes of interest, - set the --focus-nodes option to the relevant node names, comma-separated. For a - Calico component with pods on multiple nodes, calicoctl will first collect logs - from the pods (if any) on the focus nodes, then from other nodes in the cluster. +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + --focus-nodes string Comma-separated list of nodes from which to try first to collect logs. + -h, --help help for diags + --max-logs int Only collect up to this number of logs, for each kind of Calico component. (default 5) + --max-parallelism int Maximum number of parallel threads to use for collecting logs. (default 10) + --since string Only collect logs newer than provided relative duration (e.g. 30m, 2h). + --skip-temp-dir-cleanup Don't clean up the temporary directory. - To collect logs only for the last few hours, minutes, or seconds, set the --since - option to indicate the desired period. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -365,9 +352,6 @@ Diagnostic bundle available at ./calico-diagnostics.tar.gz ### Options ``` - --since= Only collect logs newer than provided relative duration, - in seconds (s), minutes (m) or hours (h) - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + --since string Only collect logs newer than provided relative duration (e.g. 30m, 2h). + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` diff --git a/calico/reference/calicoctl/cluster/overview.mdx b/calico/reference/calicoctl/cluster/overview.mdx index cd120f1c26..e33bc5fdef 100644 --- a/calico/reference/calicoctl/cluster/overview.mdx +++ b/calico/reference/calicoctl/cluster/overview.mdx @@ -15,18 +15,23 @@ Run `calicoctl cluster --help` to display the following help menu for the commands. ``` +Access cluster information + Usage: - calicoctl cluster [...] + calicoctl cluster [command] - diags Collect snapshot of diagnostic info and logs related to Calico at the cluster-level. +Available Commands: + diags Collect snapshot of diagnostic info and logs related to Calico at the cluster-level -Options: - -h --help Show this screen. +Flags: + -h, --help help for cluster -Description: - Commands for accessing Cluster related information. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") - See 'calicoctl cluster --help' to read about a specific subcommand. +Use "calicoctl cluster [command] --help" for more information about a command. ``` ## Cluster specific commands diff --git a/calico/reference/calicoctl/convert.mdx b/calico/reference/calicoctl/convert.mdx deleted file mode 100644 index 7d3ee482f1..0000000000 --- a/calico/reference/calicoctl/convert.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -description: Reference for the calicoctl convert command in Calico Open Source, used to convert v1 resource manifests into v3 format. ---- - -# calicoctl convert - -This sections describes the `calicoctl convert` command. - -Read the [calicoctl command line interface user reference](overview.mdx) -for a full list of calicoctl commands. - -:::note - -The available actions for a specific resource type may be -limited based on the datastore used for $[prodname] (etcdv3 / Kubernetes API). -Please refer to the -[Resources section](../resources/overview.mdx) -for details about each resource type. - -::: - -## Displaying the help text for 'calicoctl convert' command - -Run `calicoctl convert --help` to display the following help menu for the -command. - -``` -Usage: - calicoctl convert --filename= - [--output=] [--ignore-validation] - -Examples: - # Convert the contents of policy.yaml to a Calico v3 policy. - calicoctl convert -f ./policy.yaml -o yaml - - # Convert a policy based on the JSON passed into stdin. - cat policy.json | calicoctl convert -f - - -Options: - -h --help Show this screen. - -f --filename= Filename to use to create the resource. If set to - "-" loads from stdin. - -o --output= Output format. One of: yaml or json. - [Default: yaml] - --ignore-validation Skip validation on the converted manifest. - -Description: - Convert config files from Calico v1 or Kubernetes to Calico v3 API versions. Both YAML and JSON formats are accepted. - - The default output will be printed to stdout in YAML format. -``` - -:::note - -Currently the only Kubernetes API resource supported for conversion is NetworkPolicy. - -::: - -### Examples - -1. Convert a set of resources (of mixed type) from Calico v1 or Kubernetes to Calico v3 APIs using the data in resources.yaml. - - ```bash - calicoctl convert -f multi-resource-v1.yaml -o yaml > multi-resource-v3.yaml - ``` - - :::tip - - By default convert command outputs the converted resources to stdout, but it can be redirected to a file. - - ::: - -1. Convert a policy based on the JSON passed into stdin. - - ```bash - cat policy.json | calicoctl convert -f - - ``` - - Result will be printed to stdout. - -### Options - -``` --f --filename= Filename to use to convert the resource. If set to - "-" loads from stdin. --o --output= Output format. One of: yaml or json. - [Default: yaml] ---ignore-validation Skip validation on the converted manifest. -``` - -## See also - -- [Installing calicoctl](../../operations/calicoctl/install.mdx) -- [Resources](../resources/overview.mdx) for details on all valid resources, including file format - and schema -- [calicoctl get](get.mdx) for details on `calicoctl get` command to get the resources. diff --git a/calico/reference/calicoctl/create.mdx b/calico/reference/calicoctl/create.mdx index fe1effdc55..553f31ea63 100644 --- a/calico/reference/calicoctl/create.mdx +++ b/calico/reference/calicoctl/create.mdx @@ -25,70 +25,24 @@ Run `calicoctl create --help` to display the following help menu for the command. ``` +Create a resource by file, directory or stdin + Usage: - calicoctl create --filename= [--recursive] [--skip-empty] [--skip-exists] [--config=] [--namespace=] - -Examples: - # Create a policy using the data in policy.yaml. - calicoctl create -f ./policy.yaml - - # Create a policy based on the JSON passed into stdin. - cat policy.json | calicoctl create -f - - -Options: - -h --help Show this screen. - -f --filename= Filename to use to create the resource. If set to - "-" loads from stdin. If filename is a directory, this command is - invoked for each .json .yaml and .yml file within that directory, - terminating after the first failure. - -R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. - --skip-exists Skip over and treat as successful any attempts to - create an entry that already exists. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint. - Uses the default namespace if not specified. - --context= The name of the kubeconfig context to use. - -Description: - The create command is used to create a set of resources by filename or stdin. - JSON and YAML formats are accepted. - - Valid resource types are: - - - 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, - resources that already exist are skipped. - - The output of the command indicates how many resources were successfully - created, and the error reason if an error occurred. If the --skip-exists - flag is set then skipped resources are included in the success count. - - The resources are created in the order they are specified. In the event of a - failure creating a specific resource it is possible to work out which - resource failed based on the number of resources successfully created. + calicoctl create [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -h, --help help for create + -n, --namespace string Namespace of the resource. + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. + --skip-exists Skip over resources that already exist. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -121,21 +75,15 @@ Description: ### Options ``` --f --filename= Filename to use to create the resource. If set to - "-" loads from stdin. - --skip-exists Skip over and treat as successful any attempts to - create an entry that already exists. --n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + --skip-exists Skip over resources that already exist. + -n, --namespace string Namespace of the resource. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/datastore/migrate-policy-names.mdx b/calico/reference/calicoctl/datastore/migrate-policy-names.mdx index ea5569b6f9..ec6c4bb33b 100644 --- a/calico/reference/calicoctl/datastore/migrate-policy-names.mdx +++ b/calico/reference/calicoctl/datastore/migrate-policy-names.mdx @@ -23,24 +23,19 @@ Run `calicoctl datastore migrate-policy-names --help` to display the following h command. ``` +Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix + Usage: - calicoctl datastore migrate-policy-names [--config=] [--allow-version-mismatch] - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - --allow-version-mismatch Allow client and cluster versions mismatch. - -Description: - Rewrite policy names in the datastore to drop the legacy "default." tier - prefix, aligning the stored name with the v3 resource name introduced in - v3.32. - - This is only needed for an etcdv3 datastore (for example OpenStack) that was - created before v3.32 and upgraded in place. A Kubernetes datastore is - migrated automatically by kube-controllers. The command is safe to re-run. + calicoctl datastore migrate-policy-names [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for migrate-policy-names + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -63,9 +58,7 @@ migrated reports `migrated 0 policies` and makes no changes. ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] +-c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/datastore/migrate/export.mdx b/calico/reference/calicoctl/datastore/migrate/export.mdx index dbedf227b1..940e3ed9f2 100644 --- a/calico/reference/calicoctl/datastore/migrate/export.mdx +++ b/calico/reference/calicoctl/datastore/migrate/export.mdx @@ -15,41 +15,19 @@ Run `calicoctl datastore migrate export --help` to display the following help me command. ``` +Export the contents of the etcdv3 datastore to yaml + Usage: - calicoctl datastore migrate export [--config=] - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -Description: - Export the contents of the etcdv3 datastore. Resources will be exported - in yaml and json format. Save the results of this command to a file for - later use with the import command. - - The following resources are exported: - - - IPPools - - BGPPeers - - GlobalNetworkPolicies - - GlobalNetworkSets - - HostEndpoints - - KubeControllersConfigurations - - NetworkPolicies - - Networksets - - Nodes - - BGPConfigurations - - FelixConfigurations - - IPReservations - - BGPFilters - - - The following resources are not exported: - - - WorkloadEndpoints - - Profiles + calicoctl datastore migrate export [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for export + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Exported resources @@ -86,9 +64,7 @@ calicoctl datastore migrate export > etcd-migration ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] +-c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/datastore/migrate/import.mdx b/calico/reference/calicoctl/datastore/migrate/import.mdx index 3d64c707b3..4719a961b7 100644 --- a/calico/reference/calicoctl/datastore/migrate/import.mdx +++ b/calico/reference/calicoctl/datastore/migrate/import.mdx @@ -15,20 +15,20 @@ Run `calicoctl datastore migrate import --help` to display the following help me command. ``` +Store and convert yaml of resources into the Kubernetes datastore + Usage: - calicoctl datastore migrate import --filename= [--config=] - -Options: - -h --help Show this screen. - -f --filename= Filename to use to import resources. If set to - "-" loads from stdin. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -Description: - Import the contents of the etcdv3 datastore from the file created by the - export command. + calicoctl datastore migrate import [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -f, --filename string Filename to use to import resources. + -h, --help help for import + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -42,16 +42,13 @@ calicoctl datastore migrate import -f etcd-migration ### Options ``` --f --filename= Filename to use to import resources. If set to - "-" loads from stdin. +-f, --filename string Filename to use to import resources. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] +-c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/datastore/migrate/lock.mdx b/calico/reference/calicoctl/datastore/migrate/lock.mdx index 7f1df41504..d3e817c1d9 100644 --- a/calico/reference/calicoctl/datastore/migrate/lock.mdx +++ b/calico/reference/calicoctl/datastore/migrate/lock.mdx @@ -9,25 +9,25 @@ This sections describes the `calicoctl datastore migrate lock` command. Read the [calicoctl Overview](../../overview.mdx) for a full list of calicoctl commands. -## Display the help text for 'calicoctl datastore migrate unlock' command +## Display the help text for 'calicoctl datastore migrate lock' command Run `calicoctl datastore migrate lock --help` to display the following help menu for the command. ``` +Lock the datastore to prevent changes during migration + Usage: - calicoctl datastore migrate lock [--config=] - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -Description: - Lock the datastore to prepare it for migration. This prevents any new - Calico resources from affecting the cluster but does not prevent updating - or creating new Calico resources. + calicoctl datastore migrate lock [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for lock + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -42,9 +42,7 @@ calicoctl datastore migrate lock ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] +-c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/datastore/migrate/overview.mdx b/calico/reference/calicoctl/datastore/migrate/overview.mdx index 47d08eb9d5..c7606b51d5 100644 --- a/calico/reference/calicoctl/datastore/migrate/overview.mdx +++ b/calico/reference/calicoctl/datastore/migrate/overview.mdx @@ -15,21 +15,26 @@ Run `calicoctl datastore migrate --help` to display the following help menu for commands. ``` +Migrate the contents of an etcdv3 datastore to a Kubernetes datastore + Usage: - calicoctl datastore migrate [...] + calicoctl datastore migrate [command] - export Export the contents of the etcdv3 datastore to yaml. - import Store and convert yaml of resources into the Kubernetes datastore. - lock Lock the datastore to prevent changes from occurring during datastore migration. - unlock Unlock the datastore to allow changes once the migration is completed. +Available Commands: + export Export the contents of the etcdv3 datastore to yaml + import Store and convert yaml of resources into the Kubernetes datastore + lock Lock the datastore to prevent changes during migration + unlock Unlock the datastore to allow changes after migration -Options: - -h --help Show this screen. +Flags: + -h, --help help for migrate -Description: - Migration specific commands for calicoctl. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") - See 'calicoctl datastore migrate --help' to read about a specific subcommand. +Use "calicoctl datastore migrate [command] --help" for more information about a command. ``` ## Migrate specific commands diff --git a/calico/reference/calicoctl/datastore/migrate/unlock.mdx b/calico/reference/calicoctl/datastore/migrate/unlock.mdx index 870bf9f42f..5ffd190aaf 100644 --- a/calico/reference/calicoctl/datastore/migrate/unlock.mdx +++ b/calico/reference/calicoctl/datastore/migrate/unlock.mdx @@ -4,7 +4,7 @@ description: Reference for the calicoctl datastore migrate unlock command in Cal # calicoctl datastore migrate unlock -This sections describes the `calicoctl datastore migrate lock` command. +This sections describes the `calicoctl datastore migrate unlock` command. Read the [calicoctl Overview](../../overview.mdx) for a full list of calicoctl commands. @@ -15,18 +15,19 @@ Run `calicoctl datastore migrate unlock --help` to display the following help me command. ``` +Unlock the datastore to allow changes after migration + Usage: - calicoctl datastore migrate unlock [--config=] + calicoctl datastore migrate unlock [flags] -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for unlock -Description: - Unlock the datastore to complete migration. This once again allows - Calico resources to take effect in the cluster. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -41,9 +42,7 @@ calicoctl datastore migrate unlock ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] +-c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/datastore/overview.mdx b/calico/reference/calicoctl/datastore/overview.mdx index e7532d44e3..de1fb3880c 100644 --- a/calico/reference/calicoctl/datastore/overview.mdx +++ b/calico/reference/calicoctl/datastore/overview.mdx @@ -15,19 +15,24 @@ Run `calicoctl datastore --help` to display the following help menu for the commands. ``` +Calico datastore management + Usage: - calicoctl datastore [...] + calicoctl datastore [command] - migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. - migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy "default." tier prefix. +Available Commands: + migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore + migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix -Options: - -h --help Show this screen. +Flags: + -h, --help help for datastore -Description: - Datastore specific commands for calicoctl. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") - See 'calicoctl datastore --help' to read about a specific subcommand. +Use "calicoctl datastore [command] --help" for more information about a command. ``` ## Datastore specific commands diff --git a/calico/reference/calicoctl/delete.mdx b/calico/reference/calicoctl/delete.mdx index 321e4cb243..27aaa2c5cc 100644 --- a/calico/reference/calicoctl/delete.mdx +++ b/calico/reference/calicoctl/delete.mdx @@ -25,82 +25,24 @@ Run `calicoctl delete --help` to display the following help menu for the command. ``` +Delete a resource by file, directory, stdin, or type and name + Usage: - calicoctl delete ( ( []) | - --filename=) [--recursive] [--skip-empty] - [--skip-not-exists] [--config=] [--namespace=] - -Examples: - # Delete a policy using the type and name specified in policy.yaml. - calicoctl delete -f ./policy.yaml - - # Delete a policy based on the type and name in the YAML passed into stdin. - cat policy.yaml | calicoctl delete -f - - - # Delete policies with names "foo" and "bar" - calicoctl delete policy foo bar - -Options: - -h --help Show this screen. - -s --skip-not-exists Skip over and treat as successful, resources that - don't exist. - -f --filename= Filename to use to delete the resource. If set to - "-" loads from stdin. If filename is a directory, this command is - invoked for each .json .yaml and .yml file within that directory, - terminating after the first failure. - -R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. - --context= The name of the kubeconfig context to use. - -Description: - The delete command is used to delete a set of resources by filename or stdin, - or by type and identifiers. JSON and YAML formats are accepted for file and - stdin format. - - Valid resource types are: - - - 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 delete a resource that does not exists is treated as a - terminating error unless the --skip-not-exists flag is set. If this flag is - set, resources that do not exist are skipped. - - When deleting resources by type, only a single type may be specified at a - time. The name is required along with any and other identifiers required to - uniquely identify a resource of the specified type. - - The output of the command indicates how many resources were successfully - deleted, and the error reason if an error occurred. If the --skip-not-exists - flag is set then skipped resources are included in the success count. - - The resources are deleted in the order they are specified. In the event of a - failure deleting a specific resource it is possible to work out which - resource failed based on the number of resources successfully deleted. + calicoctl delete [KIND [NAME...]] [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -h, --help help for delete + -n, --namespace string Namespace of the resource. + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. + -s, --skip-not-exists Skip over resources that do not exist. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -132,21 +74,15 @@ Description: ### Options ``` --s --skip-not-exists Skip over and treat as successful, resources that - don't exist. --f --filename= Filename to use to delete the resource. If set to - "-" loads from stdin. --n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. + -s, --skip-not-exists Skip over resources that do not exist. + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -n, --namespace string Namespace of the resource. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/get.mdx b/calico/reference/calicoctl/get.mdx index e0678a597e..1e05d8113a 100644 --- a/calico/reference/calicoctl/get.mdx +++ b/calico/reference/calicoctl/get.mdx @@ -25,128 +25,43 @@ Run `calicoctl get --help` to display the following help menu for the command. ``` +Get a resource by file, directory, stdin, or type and name + Usage: - calicoctl get ( ( []) | - --filename=) [--recursive] [--skip-empty] - [--output=] [--config=] [--namespace=] [--all-namespaces] - -Examples: - # List all policy in default output format. - calicoctl get policy - - # List specific policies in YAML format - calicoctl get -o yaml policy my-policy-1 my-policy-2 - -Options: - -h --help Show this screen. - -f --filename= Filename to use to get the resource. If set to - "-" loads from stdin. If filename is a directory, this command is - invoked for each .json .yaml and .yml file within that directory, - terminating after the first failure. - -R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. - -o --output= Output format. One of: yaml, json, ps, wide, - custom-columns=..., go-template=..., - go-template-file=... [Default: ps] - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. - -A --all-namespaces If present, list the requested object(s) across - all namespaces. - --export If present, returns the requested object(s) stripped of - cluster-specific information. This flag will be ignored - if is not specified. - --context= The name of the kubeconfig context to use. - -Description: - The get command is used to display a set of resources by filename or stdin, - or by type and identifiers. JSON and YAML formats are accepted for file and - stdin format. - - Valid resource types are: - - - 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 get resources that do not exist will simply return no results. - - When getting resources by type, only a single type may be specified at a - time. The name and other identifiers (hostname, scope) are optional, and are - wildcarded when omitted. Thus if you specify no identifiers at all (other - than type), then all configured resources of the requested type will be - returned. - - By default the results are output in a ps-style table output. There are - alternative ways to display the data using the --output option: - - ps Display the results in ps-style output. - wide As per the ps option, but includes more headings. - custom-columns As per the ps option, but only display the columns - that are requested in the comma-separated list. - golang-template Display the results using the specified golang - template. This can be used to filter results, for - example to return a specific value. - golang-template-file Display the results using the golang template that is - contained in the specified file. - yaml Display the results in YAML output format. - json Display the results in JSON output format. - - Note that the data output using YAML or JSON format is always valid to use as - input to all of the resource management commands (create, apply, replace, - delete, get). - - Please refer to the docs at https://projectcalico.docs.tigera.io for more details on - the output formats, including example outputs, resource structure (required - for the golang template definitions) and the valid column names (required for - the custom-columns option). + calicoctl get [KIND [NAME...]] [flags] + +Flags: + -A, --all-namespaces List the requested object(s) across all namespaces. + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + --export Strip cluster-specific information from the output. + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -h, --help help for get + -n, --namespace string Namespace of the resource. + -o, --output string Output format: yaml, json, ps, wide, custom-columns=..., go-template=..., go-template-file=... (default "ps") + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Options ``` --h --help Show this screen. --f --filename= Filename to use to get the resource. If set to - "-" loads from stdin. --o --output= Output format. One of: yaml, json, ps, wide, - custom-columns=..., go-template=..., - go-template-file=... [Default: ps] --n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint. - Uses the default namespace if not specified. --A --all-namespaces If present, list the requested object(s) across - all namespaces. ---export If present, returns the requested object(s) stripped of - cluster-specific information. This flag will be ignored - if the resource name is not specified. + -h, --help help for get + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -o, --output string Output format: yaml, json, ps, wide, custom-columns=..., go-template=..., go-template-file=... (default "ps") + -n, --namespace string Namespace of the resource. + -A, --all-namespaces List the requested object(s) across all namespaces. + --export Strip cluster-specific information from the output. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ### Output options diff --git a/calico/reference/calicoctl/ipam/check.mdx b/calico/reference/calicoctl/ipam/check.mdx index c33ca85cd2..6ed9837a25 100644 --- a/calico/reference/calicoctl/ipam/check.mdx +++ b/calico/reference/calicoctl/ipam/check.mdx @@ -13,21 +13,23 @@ Read the [calicoctl overview](../overview.mdx) for a full list of calicoctl comm Run `calicoctl ipam check --help` to display the following help menu for the command. ``` +Check the integrity of the IPAM datastructures + Usage: - calicoctl ipam check [--config=] [--show-all-ips] [--show-problem-ips] [-o ] - -Options: - -h --help Show this screen. - -o --output= Path to output report file. - --show-all-ips Print all IPs that are checked. - --show-problem-ips Print all IPs that are leaked or not allocated properly. - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - --kubeconfig= Path to kubeconfig file - -Description: - The ipam check command checks the integrity of the IPAM datastructures against Kubernetes. + calicoctl ipam check [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for check + --kubeconfig string Path to Kubeconfig file. + -o, --output string Path to output report file. + --show-all-ips Print all IPs that are checked. + --show-problem-ips Print all IPs that are leaked or not allocated properly. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples diff --git a/calico/reference/calicoctl/ipam/configure.mdx b/calico/reference/calicoctl/ipam/configure.mdx index 4a86e3922e..7308cc458f 100644 --- a/calico/reference/calicoctl/ipam/configure.mdx +++ b/calico/reference/calicoctl/ipam/configure.mdx @@ -14,27 +14,23 @@ Run `calicoctl ipam configure --help` to display the following help menu for the command. ``` +Configure IPAM + Usage: - calicoctl ipam configure --strictaffinity= - [--max-blocks-per-host=] - [--kubevirt-ip-persistence=] - [--config=] - -Options: - -h --help Show this screen. - --strictaffinity= Set StrictAffinity to true/false. When StrictAffinity - is true, borrowing IP addresses is not allowed. - --max-blocks-per-host= Set the maximum number of blocks that can be affine - to a host. - --kubevirt-ip-persistence= - Control whether KubeVirt VMs retain persistent IP - addresses across lifecycle events. - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -Description: - Modify configuration for Calico IP address management. + calicoctl ipam configure [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for configure + --ip-cooldown-seconds int Set the minimum time between release and re-allocation of an IP address. (default -1) + --kubevirt-ip-persistence string Control whether KubeVirt VMs retain persistent IP addresses (Enabled|Disabled). + --max-blocks-per-host string Set the maximum number of blocks that can be affine to a host. + --strictaffinity string Set StrictAffinity to true/false. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -50,9 +46,7 @@ calicoctl ipam configure --kubevirt-ip-persistence=Enabled ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/ipam/overview.mdx b/calico/reference/calicoctl/ipam/overview.mdx index 8cf2fd0f45..76c291914b 100644 --- a/calico/reference/calicoctl/ipam/overview.mdx +++ b/calico/reference/calicoctl/ipam/overview.mdx @@ -14,21 +14,27 @@ Run `calicoctl ipam --help` to display the following help menu for the commands. ``` +IP address management + Usage: - calicoctl ipam [...] + calicoctl ipam [command] - release Release a Calico assigned IP address. - show Show details of a Calico assigned IP address, - or of overall IP usage. - configure Configure IPAM +Available Commands: + check Check the integrity of the IPAM datastructures + configure Configure IPAM + release Release a Calico assigned IP address + show Show details of a Calico assigned IP address or overall IP usage + split Split an IP pool into the specified number of smaller IP pools -Options: - -h --help Show this screen. +Flags: + -h, --help help for ipam -Description: - IP Address Management specific commands for calicoctl. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") - See 'calicoctl ipam --help' to read about a specific subcommand. +Use "calicoctl ipam [command] --help" for more information about a command. ``` ## IPAM specific commands @@ -36,6 +42,8 @@ Description: Details on the `calicoctl ipam` commands are described in the documents linked below organized by sub command. +- [calicoctl ipam check](check.mdx) +- [calicoctl ipam configure](configure.mdx) - [calicoctl ipam release](release.mdx) - [calicoctl ipam show](show.mdx) -- [calicoctl ipam configure](configure.mdx) +- [calicoctl ipam split](split.mdx) diff --git a/calico/reference/calicoctl/ipam/release.mdx b/calico/reference/calicoctl/ipam/release.mdx index fd1afa23c8..51f92ced20 100644 --- a/calico/reference/calicoctl/ipam/release.mdx +++ b/calico/reference/calicoctl/ipam/release.mdx @@ -14,25 +14,22 @@ Run `calicoctl ipam release --help` to display the following help menu for the command. ``` +Release a Calico assigned IP address + Usage: - calicoctl ipam release [--ip=] [--from-report=] [--config=] - -Options: - -h --help Show this screen. - --ip= IP address to release. - --from-report= Release all leaked addresses from the report. - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -Description: - The ipam release command releases an IP address from the Calico IP Address - Manager that was been previously assigned to an endpoint. When an IP address - is released, it becomes available for assignment to any endpoint. - - Note that this does not remove the IP from any existing endpoints that may be - using it, so only use this command to clean up addresses from endpoints that - were not cleanly removed from Calico. + calicoctl ipam release [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + --force Force release of leaked addresses. + --from-report stringArray Release all leaked addresses from the report. + -h, --help help for release + --ip string IP address to release. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -48,9 +45,7 @@ calicoctl ipam release --from-report=./report.json ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/ipam/show.mdx b/calico/reference/calicoctl/ipam/show.mdx index 200d1b4ecc..fc779a9d46 100644 --- a/calico/reference/calicoctl/ipam/show.mdx +++ b/calico/reference/calicoctl/ipam/show.mdx @@ -14,22 +14,23 @@ Run `calicoctl ipam show --help` to display the following help menu for the command. ``` +Show details of a Calico assigned IP address or overall IP usage + Usage: - calicoctl ipam show [--ip= | --show-blocks] [--config=] - -Options: - -h --help Show this screen. - --ip= Report whether this specific IP address is in use. - --show-blocks Show detailed information for IP blocks as well as pools. - --show-borrowed Show detailed information for "borrowed" IP addresses. - --show-configuration Show current Calico IPAM configuration. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -Description: - The ipam show command prints information about a given IP address, or about - overall IP usage. + calicoctl ipam show [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for show + --ip string Report whether this specific IP address is in use. + --show-blocks Show detailed information for IP blocks as well as pools. + --show-borrowed Show detailed information for borrowed IP addresses. + --show-configuration Show current Calico IPAM configuration. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -153,18 +154,16 @@ Description: ### Options ``` ---ip= Specific IP address to show. ---show-blocks Show detailed information for IP blocks as well as pools. ---show-borrowed Show detailed information for "borrowed" IP addresses. ---show-configuration Show current Calico IPAM configuration + --ip string Report whether this specific IP address is in use. + --show-blocks Show detailed information for IP blocks as well as pools. + --show-borrowed Show detailed information for borrowed IP addresses. + --show-configuration Show current Calico IPAM configuration. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/ipam/split.mdx b/calico/reference/calicoctl/ipam/split.mdx index 084ed6bb51..1017d53a50 100644 --- a/calico/reference/calicoctl/ipam/split.mdx +++ b/calico/reference/calicoctl/ipam/split.mdx @@ -14,27 +14,21 @@ for a full list of calicoctl commands. Run `calicoctl ipam split --help` to display the following help menu for the command. ``` +Split an IP pool into the specified number of smaller IP pools + Usage: - ipam split [--cidr=] [--name=] [--config=] [--allow-version-mismatch] - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - --cidr= CIDR of the IP pool to split. - --name= Name of the IP pool to split. - --allow-version-mismatch Allow client and cluster versions mismatch. - -Description: - The ipam split command splits an IP pool specified by the specified CIDR or name - into the specified number of smaller IP pools. Each child IP pool will be of equal - size. IP pools can only be split into a number of smaller pools that is a power - of 2. - -Examples: - # Split the IP pool specified by 172.0.0.0/8 into 2 smaller pools - ipam split --cidr=172.0.0.0/8 2 + calicoctl ipam split NUMBER [flags] + +Flags: + --cidr string CIDR of the IP pool to split. + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for split + --name string Name of the IP pool to split. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Prerequisites @@ -72,9 +66,7 @@ calicoctl datastore migrate unlock ### General options ``` - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/label.mdx b/calico/reference/calicoctl/label.mdx index aed0192de1..72fdab32b5 100644 --- a/calico/reference/calicoctl/label.mdx +++ b/calico/reference/calicoctl/label.mdx @@ -25,65 +25,22 @@ Run `calicoctl label --help` to display the following help menu for the command. ``` +Add or update labels of resources + Usage: - calicoctl label ( - ( = [--overwrite] | - --remove ) - [--config=] [--namespace=]) - -Examples: - # Label a workload endpoint - calicoctl label workloadendpoints nginx --namespace=default app=web - - # Label a node and overwrite the original value of key 'cluster' - calicoctl label nodes node1 cluster=frontend --overwrite - - # Remove label with key 'cluster' of the node - calicoctl label nodes node1 cluster --remove - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint. - Uses the default namespace if not specified. - --overwrite If true, overwrite the value when the key is already - present in labels. Otherwise reports error when the - labeled resource already have the key in its labels. - Can not be used with --remove. - --remove If true, remove the specified key in labels of the - resource. Reports error when specified key does not - exist. Can not be used with --overwrite. - --context= The name of the kubeconfig context to use. - -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 - - The resource type is case-insensitive and may be pluralized. - - Attempting to label resources that do not exist will get an error. - - Attempting to remove a label that does not exist in the resource will get an error. - - When labeling a resource on an existing key: - - gets an error if option --overwrite is not provided. - - value of the key updates to specified value if option --overwrite is provided. + calicoctl label KIND NAME [key=value | key] [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for label + -n, --namespace string Namespace of the resource. + --overwrite Overwrite the value when the key is already present in labels. + --remove Remove the specified key from labels. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -127,24 +84,15 @@ Description: ### Options ``` - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. - --overwrite If true, overwrite the value when the key is already - present in labels. Otherwise reports error when the - labeled resource already have the key in its labels. - Can not be used with --remove. - --remove If true, remove the specified key in labels of the - resource. Reports error when specified key does not - exist. Can not be used with --overwrite. + -n, --namespace string Namespace of the resource. + --overwrite Overwrite the value when the key is already present in labels. + --remove Remove the specified key from labels. ``` ### General options ``` - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/node/checksystem.mdx b/calico/reference/calicoctl/node/checksystem.mdx index 00704e3cfa..c3d3a2472d 100644 --- a/calico/reference/calicoctl/node/checksystem.mdx +++ b/calico/reference/calicoctl/node/checksystem.mdx @@ -15,22 +15,19 @@ Run `calicoctl node checksystem --help` to display the following help menu for t command. ``` +Verify the compute host is able to run a Calico node instance + Usage: - calicoctl node checksystem [--kernel-config=] - -Options: - -h --help Show this screen. - -f --kernel-config= Override the Kernel config file location. - Expected format is plain text. - default search locations: - "/usr/src/linux/.config", - "/boot/config-kernelVersion, - "/usr/src/linux-kernelVersion/.config", - "/usr/src/linux-headers-kernelVersion/.config", - "/lib/modules/kernelVersion/build/.config" - -Description: - Check the compatibility of this compute host to run a Calico node instance. + calicoctl node checksystem [flags] + +Flags: + -h, --help help for checksystem + -f, --kernel-config string Override the Kernel config file location. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Procedure diff --git a/calico/reference/calicoctl/node/diags.mdx b/calico/reference/calicoctl/node/diags.mdx index e70a599d88..1a20fc37c9 100644 --- a/calico/reference/calicoctl/node/diags.mdx +++ b/calico/reference/calicoctl/node/diags.mdx @@ -15,25 +15,19 @@ Run `calicoctl node diags --help` to display the following help menu for the command. ``` -Usage: - calicoctl node diags [--log-dir=] - -Options: - -h --help Show this screen. - --log-dir= The directory containing Calico logs - [default: /var/log/calico] +Gather a diagnostics bundle for a Calico node -Description: - This command is used to gather diagnostic information from a Calico node. - This is usually used when trying to diagnose an issue that may be related to - your Calico network. +Usage: + calicoctl node diags [flags] - The output of the command explains how to automatically upload the - diagnostics to http://transfer.sh for easy sharing of the data. Note that the - uploaded files will be deleted after 14 days. +Flags: + -h, --help help for diags + --log-dir string The directory containing Calico logs. (default "/var/log/calico") - This command must be run on the specific Calico node that you are gathering - diagnostics for. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -71,6 +65,5 @@ such as transfer.sh using curl or similar. For example: ### Options ``` - --log-dir= The directory containing Calico logs. - [default: /var/log/calico] + --log-dir string The directory containing Calico logs. (default "/var/log/calico") ``` diff --git a/calico/reference/calicoctl/node/overview.mdx b/calico/reference/calicoctl/node/overview.mdx index 2f3595baf6..0bf8674b6d 100644 --- a/calico/reference/calicoctl/node/overview.mdx +++ b/calico/reference/calicoctl/node/overview.mdx @@ -18,22 +18,26 @@ Run `calicoctl node --help` to display the following help menu for the commands. ``` +Calico node management + Usage: - calicoctl node [...] + calicoctl node [command] - run Run the Calico node container image - status View the current status of a Calico node. - diags Gather a diagnostics bundle for a Calico node. - checksystem Verify the compute host is able to run a Calico node instance. +Available Commands: + checksystem Verify the compute host is able to run a Calico node instance + diags Gather a diagnostics bundle for a Calico node + run Run the Calico node container image + status View the current status of a Calico node -Options: - -h --help Show this screen. +Flags: + -h, --help help for node -Description: - Node specific commands for calicoctl. These commands must be run directly on - the compute host running the Calico node instance. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") - See 'calicoctl node --help' to read about a specific subcommand. +Use "calicoctl node [command] --help" for more information about a command. ``` ## Node specific commands diff --git a/calico/reference/calicoctl/node/run.mdx b/calico/reference/calicoctl/node/run.mdx index 7006c7f39c..9f64048f96 100644 --- a/calico/reference/calicoctl/node/run.mdx +++ b/calico/reference/calicoctl/node/run.mdx @@ -15,116 +15,32 @@ Run `calicoctl node run --help` to display the following help menu for the command. ``` +Run the Calico node container image + Usage: - calicoctl node run [--ip=] [--ip6=] [--as=] - [--name=] - [--ip-autodetection-method=] - [--ip6-autodetection-method=] - [--log-dir=] - [--node-image=] - [--backend=(bird|none)] - [--config=] - [--felix-config=] - [--no-default-ippools] - [--dryrun] - [--init-system] - [--disable-docker-networking] - [--docker-networking-ifprefix=] - [--use-docker-networking-container-labels] - -Options: - -h --help Show this screen. - --name= The name of the Calico node. If this is not - supplied it defaults to the host name. - --as= Set the AS number for this node. If omitted, it - will use the value configured on the node resource. - If there is no configured value and --as option is - omitted, the node will inherit the global AS number - (see 'calicoctl config' for details). - --ip= Set the local IPv4 routing address for this node. - If omitted, it will use the value configured on the - node resource. If there is no configured value - and the --ip option is omitted, the node will - attempt to autodetect an IP address to use. Use a - value of 'autodetect' to always force autodetection - of the IP each time the node starts. - --ip6= Set the local IPv6 routing address for this node. - If omitted, it will use the value configured on the - node resource. If there is no configured value - and the --ip6 option is omitted, the node will not - route IPv6. Use a value of 'autodetect' to force - autodetection of the IP each time the node starts. - --ip-autodetection-method= - Specify the autodetection method for detecting the - local IPv4 routing address for this node. The valid - options are: - > first-found - Use the first valid IP address on the first - enumerated interface (common known exceptions are - filtered out, e.g. the docker bridge). It is not - recommended to use this if you have multiple - external interfaces on your host. - > can-reach= - Use the interface determined by your host routing - tables that will be used to reach the supplied - destination IP or domain name. - > interface= - Use the first valid IP address found on interfaces - named as per the first matching supplied interface - name regex. Regexes are separated by commas - (e.g. eth.*,enp0s.*). - > skip-interface= - Use the first valid IP address on the first - enumerated interface (same logic as first-found - above) that does NOT match with any of the - specified interface name regexes. Regexes are - separated by commas (e.g. eth.*,enp0s.*). - [default: first-found] - --ip6-autodetection-method= - Specify the autodetection method for detecting the - local IPv6 routing address for this node. See - ip-autodetection-method flag for valid options. - [default: first-found] - --log-dir= The directory containing Calico logs. - [default: /var/log/calico] - --node-image= - Docker image to use for Calico's per-node container. - [default: $[registry]$[imageNames.calico/node]:latest] - --backend=(bird|none) - Specify which networking backend to use. When set - to "none", Calico node runs in policy only mode. - [default: bird] - --dryrun Output the appropriate command, without starting the - container. - --init-system Run the appropriate command to use with an init - system. - --no-default-ippools Do not create default pools upon startup. - Default IP pools will be created if this is not set - and there are no pre-existing Calico IP pools. - --disable-docker-networking - Disable Docker networking. - --docker-networking-ifprefix= - Interface prefix to use for the network interface - within the Docker containers that have been networked - by the Calico driver. - [default: cali] - --use-docker-networking-container-labels - Extract the Calico-namespaced Docker container labels - (org.projectcalico.label.*) and apply them to the - container endpoints for use with Calico policy. - This option is only valid when using Calico Docker - networking, and when enabled traffic must be - explicitly allowed by configuring Calico policies. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - --felix-config= - Path to the file containing Felix - configuration in YAML or JSON format. - -Description: - This command is used to start a $[nodecontainer] container instance which provides - Calico networking and network policy on your compute host. + calicoctl node run [flags] + +Flags: + --as string Set the AS number for this node. + --backend string Specify which networking backend to use (bird|none). (default "bird") + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + --dryrun Output the appropriate command, without starting the container. + --felix-config string Path to the file containing Felix configuration. + -h, --help help for run + --init-system Run the appropriate command to use with an init system. + --ip string Set the local IPv4 routing address for this node. + --ip-autodetection-method string Specify the autodetection method for detecting the local IPv4 routing address. (default "first-found") + --ip6 string Set the local IPv6 routing address for this node. + --ip6-autodetection-method string Specify the autodetection method for detecting the local IPv6 routing address. (default "first-found") + --log-dir string The directory containing Calico logs. (default "/var/log/calico") + --name string The name of the Calico node. + --no-default-ippools Do not create default pools upon startup. + --node-image string Docker image to use for Calico's per-node container. (default "quay.io/calico/node:latest") + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Kubernetes as the datastore @@ -276,95 +192,24 @@ terminating `,` character does not need to be specified for those cases. ### Options ``` - --name= The name of the Calico node. If this is not - supplied it defaults to the host name. - --as= Set the AS number for this node. If omitted, it - will use the value configured on the node resource. - If there is no configured value and --as option is - omitted, the node will inherit the global AS number - (see 'calicoctl config' for details). - --ip= Set the local IPv4 routing address for this node. - If omitted, it will use the value configured on the - node resource. If there is no configured value - and the --ip option is omitted, the node will - attempt to autodetect an IP address to use. Use a - value of 'autodetect' to always force autodetection - of the IP each time the node starts. - --ip6= Set the local IPv6 routing address for this node. - If omitted, it will use the value configured on the - node resource. If there is no configured value - and the --ip6 option is omitted, the node will not - route IPv6. Use a value of 'autodetect' to force - autodetection of the IP each time the node starts. - --ip-autodetection-method= - Specify the autodetection method for detecting the - local IPv4 routing address for this node. The valid - options are: - > first-found - Use the first valid IP address on the first - enumerated interface (common known exceptions are - filtered out, e.g. the docker bridge). It is not - recommended to use this if you have multiple - external interfaces on your host. - > can-reach= - Use the interface determined by your host routing - tables that will be used to reach the supplied - destination IP or domain name. - > interface= - Use the first valid IP address found on interfaces - named as per the first matching supplied interface - name regex. Regexes are separated by commas - (e.g. eth.*,enp0s.*). - > skip-interface= - Use the first valid IP address on the first - enumerated interface (same logic as first-found - above) that does NOT match with any of the - specified interface name regexes. Regexes are - separated by commas (e.g. eth.*,enp0s.*). - [default: first-found] - --ip6-autodetection-method= - Specify the autodetection method for detecting the - local IPv6 routing address for this node. See - ip-autodetection-method flag for valid options. - [default: first-found] - --log-dir= The directory containing Calico logs. - [default: /var/log/calico] - --node-image= - Docker image to use for Calico's per-node container. - [default: $[registry]$[imageNames.calico/node]:latest] - --backend=(bird|none) - Specify which networking backend to use. When set - to "none", Calico node runs in policy only mode. - [default: bird] - --dryrun Output the appropriate command, without starting the - container. - --init-system Run the appropriate command to use with an init - system. - --no-default-ippools Do not create default pools upon startup. - Default IP pools will be created if this is not set - and there are no pre-existing Calico IP pools. - --disable-docker-networking - Disable Docker networking. - --docker-networking-ifprefix= - Interface prefix to use for the network interface - within the Docker containers that have been networked - by the Calico driver. - [default: cali] - --use-docker-networking-container-labels - Extract the Calico-namespaced Docker container labels - (org.projectcalico.label.*) and apply them to the - container endpoints for use with Calico policy. - This option is only valid when using Calico Docker - networking, and when enabled traffic must be - explicitly allowed by configuring Calico policies. + --name string The name of the Calico node. + --as string Set the AS number for this node. + --ip string Set the local IPv4 routing address for this node. + --ip6 string Set the local IPv6 routing address for this node. + --ip-autodetection-method string Specify the autodetection method for detecting the local IPv4 routing address. (default "first-found") + --ip6-autodetection-method string Specify the autodetection method for detecting the local IPv6 routing address. (default "first-found") + --log-dir string The directory containing Calico logs. (default "/var/log/calico") + --node-image string Docker image to use for Calico's per-node container. (default "quay.io/calico/node:latest") + --backend string Specify which networking backend to use (bird|none). (default "bird") + --dryrun Output the appropriate command, without starting the container. + --init-system Run the appropriate command to use with an init system. + --no-default-ippools Do not create default pools upon startup. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/node/status.mdx b/calico/reference/calicoctl/node/status.mdx index ca9fc94a3f..75dfccf06c 100644 --- a/calico/reference/calicoctl/node/status.mdx +++ b/calico/reference/calicoctl/node/status.mdx @@ -15,15 +15,18 @@ Run `calicoctl node status --help` to display the following help menu for the command. ``` +View the current status of a Calico node + Usage: - calicoctl node status + calicoctl node status [flags] -Options: - -h --help Show this screen. +Flags: + -h, --help help for status -Description: - Check the status of the Calico node instance. This includes the status and - uptime of the node instance, and BGP peering states. +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples diff --git a/calico/reference/calicoctl/overview.mdx b/calico/reference/calicoctl/overview.mdx index 4c7131d609..105d1ed1fb 100644 --- a/calico/reference/calicoctl/overview.mdx +++ b/calico/reference/calicoctl/overview.mdx @@ -30,39 +30,37 @@ Run `calicoctl --help` to display the following help menu for the top level calicoctl commands. ``` +The calicoctl command line tool is used to manage Calico network and security +policy, to view and manage endpoint configuration, and to manage a Calico +node instance. + Usage: - calicoctl [options] [...] - - create Create a resource by file, directory or stdin. - replace Replace a resource by file, directory or stdin. - apply Apply a resource by file, directory or stdin. This creates a resource - if it does not exist, and replaces a resource if it does exists. - patch Patch a pre-existing resource in place. - delete Delete a resource identified by file, directory, stdin or resource type and - name. - get Get a resource identified by file, directory, stdin or resource type and - name. - label Add or update labels of resources. - convert Convert config files between different API versions. - validate Validate resource files for correctness. - ipam IP address management. - cluster Access cluster information. - node Calico node management. - version Display the version of calicoctl. - -Options: - -h --help Show this screen. - -l --log-level= Set the log level (one of panic, fatal, error, - warn, info, debug) [default: panic] - --context= The name of the kubeconfig context to use. - --allow-version-mismatch Allow client and cluster versions mismatch. - -Description: - The calicoctl command line tool is used to manage Calico network and security - policy, to view and manage endpoint configuration, and to manage a Calico - node instance. - - See 'calicoctl --help' to read about a specific subcommand. + calicoctl [command] + +Available Commands: + apply Apply a resource by file, directory or stdin + cluster Access cluster information + completion Generate the autocompletion script for the specified shell + create Create a resource by file, directory or stdin + datastore Calico datastore management + delete Delete a resource by file, directory, stdin, or type and name + get Get a resource by file, directory, stdin, or type and name + help Help about any command + ipam IP address management + label Add or update labels of resources + node Calico node management + patch Patch a pre-existing resource in place + replace Replace a resource by file, directory or stdin + validate Validate a resource by file, directory or stdin without applying it + version Display the version of this binary + +Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -h, --help help for calicoctl + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") + +Use "calicoctl [command] --help" for more information about a command. ``` :::note @@ -90,9 +88,10 @@ organized by top level command. - [calicoctl get](get.mdx) - [calicoctl label](label.mdx) - [calicoctl validate](validate.mdx) -- [calicoctl convert](convert.mdx) - [calicoctl ipam](ipam/overview.mdx) - [calicoctl node](node/index.mdx) +- [calicoctl datastore](datastore/index.mdx) +- [calicoctl cluster](cluster/index.mdx) - [calicoctl version](version.mdx) ## Modifying low-level component configurations diff --git a/calico/reference/calicoctl/patch.mdx b/calico/reference/calicoctl/patch.mdx index 6f3d1a5659..2477241649 100644 --- a/calico/reference/calicoctl/patch.mdx +++ b/calico/reference/calicoctl/patch.mdx @@ -15,63 +15,22 @@ Run `calicoctl patch --help` to display the following help menu for the command. ``` +Patch a pre-existing resource in place + Usage: - calicoctl patch --patch= [--type=] [--config=] [--namespace=] - -Examples: - # Partially update a node using a strategic merge patch. - calicoctl patch node node-0 --patch '{"spec":{"bgp": {"routeReflectorClusterID": "CLUSTER_ID"}}}' - - # Partially update a node using a json merge patch. - calicoctl patch node node-0 --patch '{"spec":{"bgp": {"routeReflectorClusterID": "CLUSTER_ID"}}}' --type json - -Options: - -h --help Show this screen. - -p --patch= Spec to use to patch the resource. - -t --type= Format of patch type: - strategic Strategic merge patch (default) - json JSON Patch, RFC 6902 (not yet implemented) - merge JSON Merge Patch, RFC 7386 (not yet implemented) - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: ` + constants.DefaultConfigPath + `] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint. - Uses the default namespace if not specified. - --context= The name of the kubeconfig context to use. - -Description: - The patch command is used to patch a specific resource by type and identifiers in place. - Currently, only JSON format is accepted. - - Valid resource types are: - - - 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 - terminating error unless the --skip-not-exists flag is set. If this flag is - set, resources that do not exist are skipped. - - When patching resources by type, only a single type may be specified at a - time. The name is required along with any and other identifiers required to - uniquely identify a resource of the specified type. + calicoctl patch KIND NAME [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -h, --help help for patch + -n, --namespace string Namespace of the resource. + -p, --patch string Spec to use to patch the resource. + -t, --type string Format of patch type: strategic, json, or merge. (default "strategic") + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -91,22 +50,15 @@ Description: ### Options ``` --p --patch= Spec to use to patch the resource. --t --type= Format of patch type: - strategic Strategic merge patch (default) - json JSON Patch, RFC 6902 (not yet implemented) - merge JSON Merge Patch, RFC 7386 (not yet implemented) --n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy and WorkloadEndpoint. - Uses the default namespace if not specified. + -p, --patch string Spec to use to patch the resource. + -t, --type string Format of patch type: strategic, json, or merge. (default "strategic") + -n, --namespace string Namespace of the resource. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/replace.mdx b/calico/reference/calicoctl/replace.mdx index 9adedbc227..3089459e05 100644 --- a/calico/reference/calicoctl/replace.mdx +++ b/calico/reference/calicoctl/replace.mdx @@ -25,69 +25,23 @@ Run `calicoctl replace --help` to display the following help menu for the command. ``` +Replace a resource by file, directory or stdin + Usage: - calicoctl replace --filename= [--recursive] [--skip-empty] [--config=] [--namespace=] - -Examples: - # Replace a policy using the data in policy.yaml. - calicoctl replace -f ./policy.yaml - - # Replace a policy based on the JSON passed into stdin. - cat policy.json | calicoctl replace -f - - -Options: - -h --help Show this screen. - -f --filename= Filename to use to replace the resource. If set - to "-" loads from stdin. If filename is a directory, this command is - invoked for each .json .yaml and .yml file within that directory, - terminating after the first failure. - -R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - -n --namespace= Namespace of the resource. - Only applicable to NetworkPolicy, NetworkSet, and WorkloadEndpoint. - Uses the default namespace if not specified. - --context= The name of the kubeconfig context to use. - -Description: - The replace command is used to replace a set of resources by filename or - stdin. JSON and YAML formats are accepted. - - Valid resource types are: - - - 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. - - The output of the command indicates how many resources were successfully - replaced, and the error reason if an error occurred. - - The resources are replaced in the order they are specified. In the event of - a failure replacing a specific resource it is possible to work out which - resource failed based on the number of resources successfully replaced. - - When replacing a resource, the complete resource spec must be provided, it is - not sufficient to supply only the fields that are being updated. + calicoctl replace [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -h, --help help for replace + -n, --namespace string Namespace of the resource. + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -119,16 +73,13 @@ Description: ### Options ``` --f --filename= Filename to use to replace the resource. If set - to "-" loads from stdin. + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. ``` ### General options ``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") ``` ## See also diff --git a/calico/reference/calicoctl/validate.mdx b/calico/reference/calicoctl/validate.mdx index 94f6c3ee0c..75d0253652 100644 --- a/calico/reference/calicoctl/validate.mdx +++ b/calico/reference/calicoctl/validate.mdx @@ -20,65 +20,23 @@ It validates resource structure, syntax, and Calico-specific validation rules wi Run `calicoctl validate --help` to display the following help menu for the command. ``` +Validate a resource by file, directory or stdin without applying it + Usage: - calicoctl validate --filename= [--recursive] [--skip-empty] - -Examples: - # Validate a single resource file. - calicoctl validate -f ./policy.yaml - - # Validate resources from stdin. - cat policy.yaml | calicoctl validate -f - - - # Validate all files in a directory recursively. - calicoctl validate -f ./resources/ --recursive - -Options: - -h --help Show this screen. - -f --filename= Filename to use to validate the resource. If set to - "-" loads from stdin. If filename is a directory, this command is - invoked for each .json .yaml and .yml file within that directory, - terminating after the first failure. - -R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. - -Description: - The validate command validates Calico resource files for structural correctness - and Calico-specific validation rules without requiring access to a datastore. - JSON and YAML formats are accepted. - - Valid resource types are: - - - bgpconfiguration - - bgpfilter - - bgppeer - - clusterinformation - - felixconfiguration - - globalnetworkpolicy - - globalnetworkset - - hostendpoint - - ippool - - ipreservation - - kubecontrollersconfiguration - - networkpolicy - - networkset - - node - - profile - - tier - - workloadendpoint - - The validate command performs comprehensive validation including: - - YAML/JSON syntax and structure validation - - Required field validation - - Calico-specific validation rules (e.g., valid selectors, IP addresses, protocols) - - Cross-field validation and constraints - - The command returns a non-zero exit code if validation fails, making it - suitable for use in CI/CD pipelines and automation scripts. - - The resources are validated in the order they are specified. Validation - stops at the first error encountered. + calicoctl validate [flags] + +Flags: + -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -h, --help help for validate + -n, --namespace string Namespace of the resource. + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Examples @@ -146,11 +104,9 @@ Description: ### Options ``` --f --filename= Filename to use to validate the resource. If set to - "-" loads from stdin. --R --recursive Process the filename specified in -f or --filename recursively. - --skip-empty Do not error if any files or directory specified using -f or --filename contain no - data. + -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. + -R, --recursive Process the filename specified in -f recursively. + --skip-empty Do not error if files contain no data. ``` ## See also diff --git a/calico/reference/calicoctl/version.mdx b/calico/reference/calicoctl/version.mdx index 526337c818..6205a4b08b 100644 --- a/calico/reference/calicoctl/version.mdx +++ b/calico/reference/calicoctl/version.mdx @@ -17,19 +17,21 @@ Run `calicoctl version --help` to display the following help menu for the commands. ``` +Display the version of this binary + Usage: - calicoctl version [--config=] [--poll=] - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection configuration in - YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - --poll= Poll for changes to the cluster information at a frequency specified using POLL duration - (e.g. 1s, 10m, 2h etc.). A value of 0 (the default) disables polling. - -Description: - Display the version of calicoctl. + calicoctl version [flags] + +Flags: + --client Display the client version only. + -c, --config string Path to the file containing connection configuration. + -h, --help help for version + --poll string Poll for changes to the cluster information at a frequency specified using POLL duration. + +Global Flags: + --allow-version-mismatch Allow client and cluster versions mismatch + --context string The name of the kubeconfig context to use + -l, --log-level string Set the log level (panic, fatal, error, warn, info, debug) (default "panic") ``` ### Example diff --git a/calico/reference/index.mdx b/calico/reference/index.mdx index 41e2c9d78d..3d8bdd9c66 100644 --- a/calico/reference/index.mdx +++ b/calico/reference/index.mdx @@ -27,7 +27,6 @@ APIs, CLI, architecture and design, and FAQ. - diff --git a/calico_versioned_docs/version-3.32/operations/calicoctl/configure/etcd.mdx b/calico_versioned_docs/version-3.32/operations/calicoctl/configure/etcd.mdx index 7913953a7d..2013255f19 100644 --- a/calico_versioned_docs/version-3.32/operations/calicoctl/configure/etcd.mdx +++ b/calico_versioned_docs/version-3.32/operations/calicoctl/configure/etcd.mdx @@ -25,7 +25,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../../../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../../../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../../../reference/calicoctl/convert.mdx) - [calicoctl version](../../../reference/calicoctl/version.mdx) calicoctl is also required for non-Kubernetes platforms such as OpenStack. diff --git a/calico_versioned_docs/version-3.32/operations/calicoctl/configure/kdd.mdx b/calico_versioned_docs/version-3.32/operations/calicoctl/configure/kdd.mdx index 86d9e5ec2c..96b8ecf768 100644 --- a/calico_versioned_docs/version-3.32/operations/calicoctl/configure/kdd.mdx +++ b/calico_versioned_docs/version-3.32/operations/calicoctl/configure/kdd.mdx @@ -25,7 +25,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../../../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../../../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../../../reference/calicoctl/convert.mdx) - [calicoctl version](../../../reference/calicoctl/version.mdx) ### Default configuration diff --git a/calico_versioned_docs/version-3.32/operations/calicoctl/configure/overview.mdx b/calico_versioned_docs/version-3.32/operations/calicoctl/configure/overview.mdx index fc9d0e47f3..a9742f6729 100644 --- a/calico_versioned_docs/version-3.32/operations/calicoctl/configure/overview.mdx +++ b/calico_versioned_docs/version-3.32/operations/calicoctl/configure/overview.mdx @@ -25,7 +25,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../../../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../../../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../../../reference/calicoctl/convert.mdx) - [calicoctl version](../../../reference/calicoctl/version.mdx) calicoctl is also required for non-Kubernetes platforms such as OpenStack. diff --git a/calico_versioned_docs/version-3.32/operations/install-apiserver.mdx b/calico_versioned_docs/version-3.32/operations/install-apiserver.mdx index 1f0e2aa8be..01cebc0b10 100644 --- a/calico_versioned_docs/version-3.32/operations/install-apiserver.mdx +++ b/calico_versioned_docs/version-3.32/operations/install-apiserver.mdx @@ -56,7 +56,6 @@ calicoctl is still required for the following subcommands: - [calicoctl node](../reference/calicoctl/node/index.mdx) - [calicoctl ipam](../reference/calicoctl/ipam/index.mdx) -- [calicoctl convert](../reference/calicoctl/convert.mdx) - [calicoctl version](../reference/calicoctl/version.mdx) ## How to diff --git a/calico_versioned_docs/version-3.32/operations/native-v3-crds.mdx b/calico_versioned_docs/version-3.32/operations/native-v3-crds.mdx index 2e0e69c57c..79c417af5a 100644 --- a/calico_versioned_docs/version-3.32/operations/native-v3-crds.mdx +++ b/calico_versioned_docs/version-3.32/operations/native-v3-crds.mdx @@ -187,7 +187,6 @@ When using native `projectcalico.org/v3` CRDs, tier RBAC is enforced via the adm - [calicoctl node](../reference/calicoctl/node/index.mdx) subcommands - [calicoctl ipam](../reference/calicoctl/ipam/index.mdx) subcommands -- [calicoctl convert](../reference/calicoctl/convert.mdx) - [calicoctl version](../reference/calicoctl/version.mdx) ## Known limitations diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/convert.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/convert.mdx deleted file mode 100644 index 7d3ee482f1..0000000000 --- a/calico_versioned_docs/version-3.32/reference/calicoctl/convert.mdx +++ /dev/null @@ -1,96 +0,0 @@ ---- -description: Reference for the calicoctl convert command in Calico Open Source, used to convert v1 resource manifests into v3 format. ---- - -# calicoctl convert - -This sections describes the `calicoctl convert` command. - -Read the [calicoctl command line interface user reference](overview.mdx) -for a full list of calicoctl commands. - -:::note - -The available actions for a specific resource type may be -limited based on the datastore used for $[prodname] (etcdv3 / Kubernetes API). -Please refer to the -[Resources section](../resources/overview.mdx) -for details about each resource type. - -::: - -## Displaying the help text for 'calicoctl convert' command - -Run `calicoctl convert --help` to display the following help menu for the -command. - -``` -Usage: - calicoctl convert --filename= - [--output=] [--ignore-validation] - -Examples: - # Convert the contents of policy.yaml to a Calico v3 policy. - calicoctl convert -f ./policy.yaml -o yaml - - # Convert a policy based on the JSON passed into stdin. - cat policy.json | calicoctl convert -f - - -Options: - -h --help Show this screen. - -f --filename= Filename to use to create the resource. If set to - "-" loads from stdin. - -o --output= Output format. One of: yaml or json. - [Default: yaml] - --ignore-validation Skip validation on the converted manifest. - -Description: - Convert config files from Calico v1 or Kubernetes to Calico v3 API versions. Both YAML and JSON formats are accepted. - - The default output will be printed to stdout in YAML format. -``` - -:::note - -Currently the only Kubernetes API resource supported for conversion is NetworkPolicy. - -::: - -### Examples - -1. Convert a set of resources (of mixed type) from Calico v1 or Kubernetes to Calico v3 APIs using the data in resources.yaml. - - ```bash - calicoctl convert -f multi-resource-v1.yaml -o yaml > multi-resource-v3.yaml - ``` - - :::tip - - By default convert command outputs the converted resources to stdout, but it can be redirected to a file. - - ::: - -1. Convert a policy based on the JSON passed into stdin. - - ```bash - cat policy.json | calicoctl convert -f - - ``` - - Result will be printed to stdout. - -### Options - -``` --f --filename= Filename to use to convert the resource. If set to - "-" loads from stdin. --o --output= Output format. One of: yaml or json. - [Default: yaml] ---ignore-validation Skip validation on the converted manifest. -``` - -## See also - -- [Installing calicoctl](../../operations/calicoctl/install.mdx) -- [Resources](../resources/overview.mdx) for details on all valid resources, including file format - and schema -- [calicoctl get](get.mdx) for details on `calicoctl get` command to get the resources. diff --git a/calico_versioned_docs/version-3.32/reference/index.mdx b/calico_versioned_docs/version-3.32/reference/index.mdx index 41e2c9d78d..3d8bdd9c66 100644 --- a/calico_versioned_docs/version-3.32/reference/index.mdx +++ b/calico_versioned_docs/version-3.32/reference/index.mdx @@ -27,7 +27,6 @@ APIs, CLI, architecture and design, and FAQ. - diff --git a/calico_versioned_sidebars/version-3.32-sidebars.json b/calico_versioned_sidebars/version-3.32-sidebars.json index e3a1e03533..c378ca939d 100644 --- a/calico_versioned_sidebars/version-3.32-sidebars.json +++ b/calico_versioned_sidebars/version-3.32-sidebars.json @@ -630,7 +630,6 @@ "reference/calicoctl/cluster/diags" ] }, - "reference/calicoctl/convert", { "type": "category", "label": "ipam", diff --git a/sidebars-calico.js b/sidebars-calico.js index a8d9b1abb6..ebda38df7e 100644 --- a/sidebars-calico.js +++ b/sidebars-calico.js @@ -636,7 +636,6 @@ module.exports = { 'reference/calicoctl/cluster/diags', ], }, - 'reference/calicoctl/convert', { type: 'category', label: 'ipam', From 8022b7334215007a97518c83580fef1efcfb7f1a Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Thu, 23 Jul 2026 09:44:31 -0700 Subject: [PATCH 4/6] Refresh calicoctl help blocks with descriptions and examples Regenerated from the enriched cobra help output. --- calico/reference/calicoctl/apply.mdx | 12 +++++++++++- calico/reference/calicoctl/cluster/diags.mdx | 7 ++++++- calico/reference/calicoctl/cluster/overview.mdx | 2 +- calico/reference/calicoctl/create.mdx | 11 ++++++++++- .../calicoctl/datastore/migrate-policy-names.mdx | 7 ++++++- .../calicoctl/datastore/migrate/export.mdx | 7 ++++++- .../calicoctl/datastore/migrate/import.mdx | 7 ++++++- .../reference/calicoctl/datastore/migrate/lock.mdx | 6 +++++- .../calicoctl/datastore/migrate/overview.mdx | 4 +++- .../calicoctl/datastore/migrate/unlock.mdx | 5 ++++- calico/reference/calicoctl/datastore/overview.mdx | 5 +++-- calico/reference/calicoctl/delete.mdx | 11 ++++++++++- calico/reference/calicoctl/get.mdx | 12 +++++++++++- calico/reference/calicoctl/ipam/check.mdx | 8 +++++++- calico/reference/calicoctl/ipam/configure.mdx | 7 ++++++- calico/reference/calicoctl/ipam/overview.mdx | 4 +++- calico/reference/calicoctl/ipam/release.mdx | 11 ++++++++++- calico/reference/calicoctl/ipam/show.mdx | 11 ++++++++++- calico/reference/calicoctl/ipam/split.mdx | 7 ++++++- calico/reference/calicoctl/label.mdx | 14 +++++++++++++- calico/reference/calicoctl/node/checksystem.mdx | 5 ++++- calico/reference/calicoctl/node/diags.mdx | 7 ++++++- calico/reference/calicoctl/node/overview.mdx | 4 +++- calico/reference/calicoctl/node/run.mdx | 8 +++++++- calico/reference/calicoctl/node/status.mdx | 6 +++++- calico/reference/calicoctl/patch.mdx | 7 ++++++- calico/reference/calicoctl/replace.mdx | 8 +++++++- calico/reference/calicoctl/validate.mdx | 11 +++++++++-- calico/reference/calicoctl/version.mdx | 9 ++++++++- 29 files changed, 192 insertions(+), 31 deletions(-) diff --git a/calico/reference/calicoctl/apply.mdx b/calico/reference/calicoctl/apply.mdx index 03af919ae9..87181fe646 100644 --- a/calico/reference/calicoctl/apply.mdx +++ b/calico/reference/calicoctl/apply.mdx @@ -25,11 +25,21 @@ Run `calicoctl apply --help` to display the following help menu for the command. ``` -Apply a resource by file, directory or stdin +Create or update one or more Calico resources from a file, directory, or stdin, +in YAML or JSON format. Apply adds resources that don't exist yet and updates +those that do, so it's the right choice when you don't care whether the resource +is already present. Usage: calicoctl apply [flags] +Examples: + # Apply resources from a file. + calicoctl apply -f ./policy.yaml + + # Apply resources from stdin. + cat policy.json | calicoctl apply -f - + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. diff --git a/calico/reference/calicoctl/cluster/diags.mdx b/calico/reference/calicoctl/cluster/diags.mdx index 9b1f495101..6b9ededea2 100644 --- a/calico/reference/calicoctl/cluster/diags.mdx +++ b/calico/reference/calicoctl/cluster/diags.mdx @@ -18,11 +18,16 @@ Run `calicoctl cluster diags --help` to display the following help menu for the command. ``` -Collect snapshot of diagnostic info and logs related to Calico at the cluster-level +Collect a snapshot of cluster-wide Calico diagnostics and logs. Unlike node +diags, which runs on a single host, this gathers information across the +cluster. Usage: calicoctl cluster diags [flags] +Examples: + calicoctl cluster diags + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") --focus-nodes string Comma-separated list of nodes from which to try first to collect logs. diff --git a/calico/reference/calicoctl/cluster/overview.mdx b/calico/reference/calicoctl/cluster/overview.mdx index e33bc5fdef..88957a878a 100644 --- a/calico/reference/calicoctl/cluster/overview.mdx +++ b/calico/reference/calicoctl/cluster/overview.mdx @@ -15,7 +15,7 @@ Run `calicoctl cluster --help` to display the following help menu for the commands. ``` -Access cluster information +Access cluster-wide Calico information. Usage: calicoctl cluster [command] diff --git a/calico/reference/calicoctl/create.mdx b/calico/reference/calicoctl/create.mdx index 553f31ea63..14a8e1042b 100644 --- a/calico/reference/calicoctl/create.mdx +++ b/calico/reference/calicoctl/create.mdx @@ -25,11 +25,20 @@ Run `calicoctl create --help` to display the following help menu for the command. ``` -Create a resource by file, directory or stdin +Create one or more Calico resources from a file, directory, or stdin, in YAML +or JSON format. Use create when you want the command to fail if a resource +already exists; use apply if you'd rather create-or-update. Usage: calicoctl create [flags] +Examples: + # Create resources from a file. + calicoctl create -f ./policy.yaml + + # Create resources from stdin. + cat policy.json | calicoctl create -f - + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. diff --git a/calico/reference/calicoctl/datastore/migrate-policy-names.mdx b/calico/reference/calicoctl/datastore/migrate-policy-names.mdx index ec6c4bb33b..cd9685a4ff 100644 --- a/calico/reference/calicoctl/datastore/migrate-policy-names.mdx +++ b/calico/reference/calicoctl/datastore/migrate-policy-names.mdx @@ -23,11 +23,16 @@ Run `calicoctl datastore migrate-policy-names --help` to display the following h command. ``` -Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix +Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy +"default." tier prefix. Run this once when upgrading an etcdv3-backed cluster +past v3.32 so existing policy names match the current naming scheme. Usage: calicoctl datastore migrate-policy-names [flags] +Examples: + calicoctl datastore migrate-policy-names + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for migrate-policy-names diff --git a/calico/reference/calicoctl/datastore/migrate/export.mdx b/calico/reference/calicoctl/datastore/migrate/export.mdx index 940e3ed9f2..13f4b5cae2 100644 --- a/calico/reference/calicoctl/datastore/migrate/export.mdx +++ b/calico/reference/calicoctl/datastore/migrate/export.mdx @@ -15,11 +15,16 @@ Run `calicoctl datastore migrate export --help` to display the following help me command. ``` -Export the contents of the etcdv3 datastore to yaml +Export the contents of an etcdv3 datastore to YAML. This is the first step in +migrating to a Kubernetes datastore; feed the output into datastore migrate +import. Usage: calicoctl datastore migrate export [flags] +Examples: + calicoctl datastore migrate export > datastore.yaml + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for export diff --git a/calico/reference/calicoctl/datastore/migrate/import.mdx b/calico/reference/calicoctl/datastore/migrate/import.mdx index 4719a961b7..e075f5f291 100644 --- a/calico/reference/calicoctl/datastore/migrate/import.mdx +++ b/calico/reference/calicoctl/datastore/migrate/import.mdx @@ -15,11 +15,16 @@ Run `calicoctl datastore migrate import --help` to display the following help me command. ``` -Store and convert yaml of resources into the Kubernetes datastore +Import resources from a YAML export into a Kubernetes datastore. Takes the +output of datastore migrate export and loads it into the Kubernetes-backed +datastore. Usage: calicoctl datastore migrate import [flags] +Examples: + calicoctl datastore migrate import -f datastore.yaml + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -f, --filename string Filename to use to import resources. diff --git a/calico/reference/calicoctl/datastore/migrate/lock.mdx b/calico/reference/calicoctl/datastore/migrate/lock.mdx index d3e817c1d9..235c7830a2 100644 --- a/calico/reference/calicoctl/datastore/migrate/lock.mdx +++ b/calico/reference/calicoctl/datastore/migrate/lock.mdx @@ -15,11 +15,15 @@ Run `calicoctl datastore migrate lock --help` to display the following help menu command. ``` -Lock the datastore to prevent changes during migration +Lock the datastore to prevent changes during a migration. Run this before +exporting so nothing changes while the migration is in progress. Usage: calicoctl datastore migrate lock [flags] +Examples: + calicoctl datastore migrate lock + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for lock diff --git a/calico/reference/calicoctl/datastore/migrate/overview.mdx b/calico/reference/calicoctl/datastore/migrate/overview.mdx index c7606b51d5..ee2f97ac8b 100644 --- a/calico/reference/calicoctl/datastore/migrate/overview.mdx +++ b/calico/reference/calicoctl/datastore/migrate/overview.mdx @@ -15,7 +15,9 @@ Run `calicoctl datastore migrate --help` to display the following help menu for commands. ``` -Migrate the contents of an etcdv3 datastore to a Kubernetes datastore +Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. The +subcommands lock the datastore, export its contents to YAML, import them into +Kubernetes, and unlock when done. Usage: calicoctl datastore migrate [command] diff --git a/calico/reference/calicoctl/datastore/migrate/unlock.mdx b/calico/reference/calicoctl/datastore/migrate/unlock.mdx index 5ffd190aaf..5a3a618bdc 100644 --- a/calico/reference/calicoctl/datastore/migrate/unlock.mdx +++ b/calico/reference/calicoctl/datastore/migrate/unlock.mdx @@ -15,11 +15,14 @@ Run `calicoctl datastore migrate unlock --help` to display the following help me command. ``` -Unlock the datastore to allow changes after migration +Unlock the datastore to allow changes again once a migration is complete. Usage: calicoctl datastore migrate unlock [flags] +Examples: + calicoctl datastore migrate unlock + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for unlock diff --git a/calico/reference/calicoctl/datastore/overview.mdx b/calico/reference/calicoctl/datastore/overview.mdx index de1fb3880c..daf67f82df 100644 --- a/calico/reference/calicoctl/datastore/overview.mdx +++ b/calico/reference/calicoctl/datastore/overview.mdx @@ -15,14 +15,15 @@ Run `calicoctl datastore --help` to display the following help menu for the commands. ``` -Calico datastore management +Manage the Calico datastore, including migrating data between datastore types +and rewriting legacy policy names. Usage: calicoctl datastore [command] Available Commands: migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore - migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the tier prefix + migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy "default." tier prefix Flags: -h, --help help for datastore diff --git a/calico/reference/calicoctl/delete.mdx b/calico/reference/calicoctl/delete.mdx index 27aaa2c5cc..47a7519fae 100644 --- a/calico/reference/calicoctl/delete.mdx +++ b/calico/reference/calicoctl/delete.mdx @@ -25,11 +25,20 @@ Run `calicoctl delete --help` to display the following help menu for the command. ``` -Delete a resource by file, directory, stdin, or type and name +Delete one or more Calico resources, either by type and name or from a file, +directory, or stdin. Deleting a resource that doesn't exist is treated as an +error unless --skip-not-exists is set. Usage: calicoctl delete [KIND [NAME...]] [flags] +Examples: + # Delete specific policies by name. + calicoctl delete networkpolicy foo bar + + # Delete the resources described in a file. + calicoctl delete -f ./policy.yaml + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. diff --git a/calico/reference/calicoctl/get.mdx b/calico/reference/calicoctl/get.mdx index 1e05d8113a..7a47341958 100644 --- a/calico/reference/calicoctl/get.mdx +++ b/calico/reference/calicoctl/get.mdx @@ -25,11 +25,21 @@ Run `calicoctl get --help` to display the following help menu for the command. ``` -Get a resource by file, directory, stdin, or type and name +Get one or more Calico resources - all resources of a type, specific ones by +name, or those described in a file. Output can be a table (the default), YAML, +JSON, or a custom template; the YAML and JSON output can be fed back into apply +or replace. Usage: calicoctl get [KIND [NAME...]] [flags] +Examples: + # List all network policies. + calicoctl get networkpolicy + + # Get specific policies as YAML. + calicoctl get networkpolicy my-policy-1 my-policy-2 -o yaml + Flags: -A, --all-namespaces List the requested object(s) across all namespaces. -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") diff --git a/calico/reference/calicoctl/ipam/check.mdx b/calico/reference/calicoctl/ipam/check.mdx index 6ed9837a25..d0b19ca7a3 100644 --- a/calico/reference/calicoctl/ipam/check.mdx +++ b/calico/reference/calicoctl/ipam/check.mdx @@ -13,11 +13,17 @@ Read the [calicoctl overview](../overview.mdx) for a full list of calicoctl comm Run `calicoctl ipam check --help` to display the following help menu for the command. ``` -Check the integrity of the IPAM datastructures +Check the integrity of Calico's IPAM data structures and report leaked or +improperly allocated IP addresses. The report it produces can later be passed +to ipam release. Usage: calicoctl ipam check [flags] +Examples: + # Check IPAM and write a report of problem IPs. + calicoctl ipam check --show-problem-ips -o report.json + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for check diff --git a/calico/reference/calicoctl/ipam/configure.mdx b/calico/reference/calicoctl/ipam/configure.mdx index 7308cc458f..a475534030 100644 --- a/calico/reference/calicoctl/ipam/configure.mdx +++ b/calico/reference/calicoctl/ipam/configure.mdx @@ -14,11 +14,16 @@ Run `calicoctl ipam configure --help` to display the following help menu for the command. ``` -Configure IPAM +Configure cluster-wide Calico IPAM settings, such as strict affinity and the +maximum number of blocks per host. Usage: calicoctl ipam configure [flags] +Examples: + # Require strict affinity (disable IP borrowing). + calicoctl ipam configure --strictaffinity=true + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for configure diff --git a/calico/reference/calicoctl/ipam/overview.mdx b/calico/reference/calicoctl/ipam/overview.mdx index 76c291914b..9ec7ccd388 100644 --- a/calico/reference/calicoctl/ipam/overview.mdx +++ b/calico/reference/calicoctl/ipam/overview.mdx @@ -14,7 +14,9 @@ Run `calicoctl ipam --help` to display the following help menu for the commands. ``` -IP address management +Inspect and manage how Calico allocates IP addresses. These commands check +datastore integrity, release addresses, show usage, and tune IPAM +configuration. Usage: calicoctl ipam [command] diff --git a/calico/reference/calicoctl/ipam/release.mdx b/calico/reference/calicoctl/ipam/release.mdx index 51f92ced20..c372125f5b 100644 --- a/calico/reference/calicoctl/ipam/release.mdx +++ b/calico/reference/calicoctl/ipam/release.mdx @@ -14,11 +14,20 @@ Run `calicoctl ipam release --help` to display the following help menu for the command. ``` -Release a Calico assigned IP address +Release one or more Calico-assigned IP addresses. Release a single address +with --ip, or release the leaked addresses identified in a report from ipam +check. Usage: calicoctl ipam release [flags] +Examples: + # Release a single IP. + calicoctl ipam release --ip 10.0.0.1 + + # Release leaked IPs from a check report. + calicoctl ipam release --from-report report.json + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") --force Force release of leaked addresses. diff --git a/calico/reference/calicoctl/ipam/show.mdx b/calico/reference/calicoctl/ipam/show.mdx index fc779a9d46..40e4fc3e84 100644 --- a/calico/reference/calicoctl/ipam/show.mdx +++ b/calico/reference/calicoctl/ipam/show.mdx @@ -14,11 +14,20 @@ Run `calicoctl ipam show --help` to display the following help menu for the command. ``` -Show details of a Calico assigned IP address or overall IP usage +Show details of Calico IP address usage. With no flags it summarizes pool +usage; the flags drill into a specific address, individual blocks, borrowed +addresses, or the current IPAM configuration. Usage: calicoctl ipam show [flags] +Examples: + # Summarize IP pool usage. + calicoctl ipam show + + # Check whether a specific IP is in use. + calicoctl ipam show --ip 10.0.0.1 + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for show diff --git a/calico/reference/calicoctl/ipam/split.mdx b/calico/reference/calicoctl/ipam/split.mdx index 1017d53a50..53ddfbd6df 100644 --- a/calico/reference/calicoctl/ipam/split.mdx +++ b/calico/reference/calicoctl/ipam/split.mdx @@ -14,11 +14,16 @@ for a full list of calicoctl commands. Run `calicoctl ipam split --help` to display the following help menu for the command. ``` -Split an IP pool into the specified number of smaller IP pools +Split an IP pool into the given number of smaller pools of equal size. Useful +for carving a large pool into per-zone or per-node pools. Usage: calicoctl ipam split NUMBER [flags] +Examples: + # Split a pool into 4 smaller pools. + calicoctl ipam split 4 --name my-pool + Flags: --cidr string CIDR of the IP pool to split. -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") diff --git a/calico/reference/calicoctl/label.mdx b/calico/reference/calicoctl/label.mdx index 72fdab32b5..f5879d463e 100644 --- a/calico/reference/calicoctl/label.mdx +++ b/calico/reference/calicoctl/label.mdx @@ -25,11 +25,23 @@ Run `calicoctl label --help` to display the following help menu for the command. ``` -Add or update labels of resources +Add, update, or remove labels on an existing Calico resource. Set a label with +key=value (add --overwrite to replace an existing value), or remove one by +passing the key with --remove. Usage: calicoctl label KIND NAME [key=value | key] [flags] +Examples: + # Add a label to a node. + calicoctl label nodes node1 cluster=frontend + + # Overwrite an existing label value. + calicoctl label nodes node1 cluster=backend --overwrite + + # Remove a label. + calicoctl label nodes node1 cluster --remove + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for label diff --git a/calico/reference/calicoctl/node/checksystem.mdx b/calico/reference/calicoctl/node/checksystem.mdx index c3d3a2472d..e45941a32d 100644 --- a/calico/reference/calicoctl/node/checksystem.mdx +++ b/calico/reference/calicoctl/node/checksystem.mdx @@ -15,11 +15,14 @@ Run `calicoctl node checksystem --help` to display the following help menu for t command. ``` -Verify the compute host is able to run a Calico node instance +Verify that this host meets the system requirements to run a Calico node instance. Usage: calicoctl node checksystem [flags] +Examples: + calicoctl node checksystem + Flags: -h, --help help for checksystem -f, --kernel-config string Override the Kernel config file location. diff --git a/calico/reference/calicoctl/node/diags.mdx b/calico/reference/calicoctl/node/diags.mdx index 1a20fc37c9..c1d11e3fc3 100644 --- a/calico/reference/calicoctl/node/diags.mdx +++ b/calico/reference/calicoctl/node/diags.mdx @@ -15,11 +15,16 @@ Run `calicoctl node diags --help` to display the following help menu for the command. ``` -Gather a diagnostics bundle for a Calico node +Gather a diagnostics bundle from the Calico node on this host. Run it on the +affected node when troubleshooting a networking problem; it collects logs and +system information useful for diagnosis. Usage: calicoctl node diags [flags] +Examples: + calicoctl node diags + Flags: -h, --help help for diags --log-dir string The directory containing Calico logs. (default "/var/log/calico") diff --git a/calico/reference/calicoctl/node/overview.mdx b/calico/reference/calicoctl/node/overview.mdx index 0bf8674b6d..7934714ae1 100644 --- a/calico/reference/calicoctl/node/overview.mdx +++ b/calico/reference/calicoctl/node/overview.mdx @@ -18,7 +18,9 @@ Run `calicoctl node --help` to display the following help menu for the commands. ``` -Calico node management +Manage a Calico node instance. These commands run directly on the compute host +where the node is running, and cover starting the node, checking its status, +and gathering diagnostics. Usage: calicoctl node [command] diff --git a/calico/reference/calicoctl/node/run.mdx b/calico/reference/calicoctl/node/run.mdx index 9f64048f96..cb76ac8c82 100644 --- a/calico/reference/calicoctl/node/run.mdx +++ b/calico/reference/calicoctl/node/run.mdx @@ -15,11 +15,17 @@ Run `calicoctl node run --help` to display the following help menu for the command. ``` -Run the Calico node container image +Start the Calico node container on this host. Runs the calico/node image with +the supplied networking options; most options mirror fields on the node +resource and are autodetected when omitted. Usage: calicoctl node run [flags] +Examples: + # Start calico/node, autodetecting the IPv4 address. + calicoctl node run --ip autodetect --ip-autodetection-method can-reach=8.8.8.8 + Flags: --as string Set the AS number for this node. --backend string Specify which networking backend to use (bird|none). (default "bird") diff --git a/calico/reference/calicoctl/node/status.mdx b/calico/reference/calicoctl/node/status.mdx index 75dfccf06c..cdd25cc7fa 100644 --- a/calico/reference/calicoctl/node/status.mdx +++ b/calico/reference/calicoctl/node/status.mdx @@ -15,11 +15,15 @@ Run `calicoctl node status --help` to display the following help menu for the command. ``` -View the current status of a Calico node +Show the current status of the Calico node on this host, including uptime and +BGP peering states. Must be run on the node whose status you want. Usage: calicoctl node status [flags] +Examples: + calicoctl node status + Flags: -h, --help help for status diff --git a/calico/reference/calicoctl/patch.mdx b/calico/reference/calicoctl/patch.mdx index 2477241649..fbb4785f8d 100644 --- a/calico/reference/calicoctl/patch.mdx +++ b/calico/reference/calicoctl/patch.mdx @@ -15,11 +15,16 @@ Run `calicoctl patch --help` to display the following help menu for the command. ``` -Patch a pre-existing resource in place +Patch a single existing Calico resource in place. Use patch to change specific +fields without supplying the whole resource, as you'd have to with replace. Usage: calicoctl patch KIND NAME [flags] +Examples: + # Set a route reflector cluster ID on a node. + calicoctl patch node node-0 --patch '{"spec":{"bgp":{"routeReflectorClusterID":"224.0.0.1"}}}' + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -h, --help help for patch diff --git a/calico/reference/calicoctl/replace.mdx b/calico/reference/calicoctl/replace.mdx index 3089459e05..bb4388b371 100644 --- a/calico/reference/calicoctl/replace.mdx +++ b/calico/reference/calicoctl/replace.mdx @@ -25,11 +25,17 @@ Run `calicoctl replace --help` to display the following help menu for the command. ``` -Replace a resource by file, directory or stdin +Replace one or more existing Calico resources from a file, directory, or stdin, +in YAML or JSON format. Replace fails if a resource doesn't already exist; use +apply if you want it created in that case. Usage: calicoctl replace [flags] +Examples: + # Replace resources from a file. + calicoctl replace -f ./policy.yaml + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. diff --git a/calico/reference/calicoctl/validate.mdx b/calico/reference/calicoctl/validate.mdx index 75d0253652..108fde82be 100644 --- a/calico/reference/calicoctl/validate.mdx +++ b/calico/reference/calicoctl/validate.mdx @@ -20,11 +20,18 @@ It validates resource structure, syntax, and Calico-specific validation rules wi Run `calicoctl validate --help` to display the following help menu for the command. ``` -Validate a resource by file, directory or stdin without applying it +Validate one or more Calico resources from a file, directory, or stdin without +applying them. Validation runs entirely offline - checking syntax, structure, +and schema without touching the datastore - so it's useful for catching errors +before you apply resources to a cluster. Usage: calicoctl validate [flags] +Examples: + # Validate resources in a file. + calicoctl validate -f ./policy.yaml + Flags: -c, --config string Path to the file containing connection configuration in YAML or JSON format. (default "/etc/calico/calicoctl.cfg") -f, --filename string Filename to use to create/apply/replace/delete the resource. Use '-' for stdin. @@ -113,4 +120,4 @@ Global Flags: - [Installing calicoctl](../../operations/calicoctl/install.mdx) - [Resources](../resources/overview.mdx) for details on all valid resources, including file format and schema -- [NetworkPolicy](../resources/networkpolicy.mdx) for details on the $[prodname] selector-based policy model \ No newline at end of file +- [NetworkPolicy](../resources/networkpolicy.mdx) for details on the $[prodname] selector-based policy model diff --git a/calico/reference/calicoctl/version.mdx b/calico/reference/calicoctl/version.mdx index 6205a4b08b..03236c9959 100644 --- a/calico/reference/calicoctl/version.mdx +++ b/calico/reference/calicoctl/version.mdx @@ -17,11 +17,18 @@ Run `calicoctl version --help` to display the following help menu for the commands. ``` -Display the version of this binary +Display version information for calicoctl, and for the cluster when it can be reached. Usage: calicoctl version [flags] +Examples: + # Show client and cluster versions. + calicoctl version + + # Show only the client version. + calicoctl version --client + Flags: --client Display the client version only. -c, --config string Path to the file containing connection configuration. From 08473501f60ddcfe3a7b71b80d9b34dc275bd40a Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Fri, 24 Jul 2026 10:03:56 -0700 Subject: [PATCH 5/6] Fix migrate unlock grammar and drop stale convert entry from the v3.32 overview --- calico/reference/calicoctl/datastore/migrate/unlock.mdx | 2 +- .../version-3.32/reference/calicoctl/overview.mdx | 2 -- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/calico/reference/calicoctl/datastore/migrate/unlock.mdx b/calico/reference/calicoctl/datastore/migrate/unlock.mdx index 5a3a618bdc..e693be1abf 100644 --- a/calico/reference/calicoctl/datastore/migrate/unlock.mdx +++ b/calico/reference/calicoctl/datastore/migrate/unlock.mdx @@ -4,7 +4,7 @@ description: Reference for the calicoctl datastore migrate unlock command in Cal # calicoctl datastore migrate unlock -This sections describes the `calicoctl datastore migrate unlock` command. +This section describes the `calicoctl datastore migrate unlock` command. Read the [calicoctl Overview](../../overview.mdx) for a full list of calicoctl commands. diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/overview.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/overview.mdx index 4c7131d609..27a819ecd2 100644 --- a/calico_versioned_docs/version-3.32/reference/calicoctl/overview.mdx +++ b/calico_versioned_docs/version-3.32/reference/calicoctl/overview.mdx @@ -43,7 +43,6 @@ Usage: get Get a resource identified by file, directory, stdin or resource type and name. label Add or update labels of resources. - convert Convert config files between different API versions. validate Validate resource files for correctness. ipam IP address management. cluster Access cluster information. @@ -90,7 +89,6 @@ organized by top level command. - [calicoctl get](get.mdx) - [calicoctl label](label.mdx) - [calicoctl validate](validate.mdx) -- [calicoctl convert](convert.mdx) - [calicoctl ipam](ipam/overview.mdx) - [calicoctl node](node/index.mdx) - [calicoctl version](version.mdx) From 084fd1a9d7f35aed4cfea2a97d82b6ee651741f2 Mon Sep 17 00:00:00 2001 From: Casey Davenport Date: Fri, 24 Jul 2026 10:03:56 -0700 Subject: [PATCH 6/6] Leave the v3.32 migrate-policy-names docs to their own PR The command ships in v3.32.2, so its 3.32 reference page lands with that patch. This PR keeps the master cobra docs and the convert removal. --- .../datastore/migrate-policy-names.mdx | 75 ------------------- .../calicoctl/datastore/overview.mdx | 8 +- .../version-3.32-sidebars.json | 3 +- 3 files changed, 4 insertions(+), 82 deletions(-) delete mode 100644 calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx deleted file mode 100644 index 9eea2a112f..0000000000 --- a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/migrate-policy-names.mdx +++ /dev/null @@ -1,75 +0,0 @@ ---- -description: Reference for the calicoctl datastore migrate-policy-names command in Calico Open Source, used to fix pre-v3.32 policy names on an upgraded etcdv3 datastore. ---- - -# calicoctl datastore migrate-policy-names - -This section describes the `calicoctl datastore migrate-policy-names` command. - -Read the [calicoctl Overview](../overview.mdx) -for a full list of calicoctl commands. - -:::note - -This command is available in Calico v3.32.2 and later. You only need it on an -etcdv3 datastore (for example, OpenStack) that was created before v3.32 and -upgraded in place. A Kubernetes datastore is migrated automatically by -kube-controllers, so no manual step is required there. - -::: - -## Display the help text for 'calicoctl datastore migrate-policy-names' command - -Run `calicoctl datastore migrate-policy-names --help` to display the following help menu for the -command. - -``` -Usage: - calicoctl datastore migrate-policy-names [--config=] [--allow-version-mismatch] - -Options: - -h --help Show this screen. - -c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] - --allow-version-mismatch Allow client and cluster versions mismatch. - -Description: - Rewrite policy names in the datastore to drop the legacy "default." tier - prefix, aligning the stored name with the v3 resource name introduced in - v3.32. - - This is only needed for an etcdv3 datastore (for example OpenStack) that was - created before v3.32 and upgraded in place. A Kubernetes datastore is - migrated automatically by kube-controllers. The command is safe to re-run. -``` - -### Examples - -Rewrite any pre-v3.32 policy names in the datastore so they match their v3 names. - -```bash -calicoctl datastore migrate-policy-names -``` - -On completion, the command reports how many policies it rewrote. - -``` -Policy name migration complete, migrated 5 policies. -``` - -The command is idempotent. Running it again once every policy has already been -migrated reports `migrated 0 policies` and makes no changes. - -### General options - -``` --c --config= Path to the file containing connection - configuration in YAML or JSON format. - [default: /etc/calico/calicoctl.cfg] -``` - -## See also - -- [Install calicoctl](../../../operations/calicoctl/install.mdx) -- [Upgrade Calico on OpenStack](../../../operations/upgrading/openstack-upgrade.mdx) for the full upgrade procedure that runs this command diff --git a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx index e7532d44e3..7490ae094f 100644 --- a/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx +++ b/calico_versioned_docs/version-3.32/reference/calicoctl/datastore/overview.mdx @@ -9,17 +9,16 @@ This section describes the `calicoctl datastore` commands. Read the [calicoctl Overview](../overview.mdx) for a full list of calicoctl commands. -## Display the help text for 'calicoctl datastore' commands +## Display the help text for 'calicoctl datastore migrate' commands -Run `calicoctl datastore --help` to display the following help menu for the +Run `calicoctl datastore migrate --help` to display the following help menu for the commands. ``` Usage: calicoctl datastore [...] - migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. - migrate-policy-names Rewrite pre-v3.32 policy names in an etcdv3 datastore to drop the legacy "default." tier prefix. + migrate Migrate the contents of an etcdv3 datastore to a Kubernetes datastore. Options: -h --help Show this screen. @@ -36,4 +35,3 @@ Details on the `calicoctl datastore` commands are described in the documents lin organized by sub command. - [calicoctl datastore migrate](migrate/overview.mdx) -- [calicoctl datastore migrate-policy-names](migrate-policy-names.mdx) diff --git a/calico_versioned_sidebars/version-3.32-sidebars.json b/calico_versioned_sidebars/version-3.32-sidebars.json index c378ca939d..600f89341a 100644 --- a/calico_versioned_sidebars/version-3.32-sidebars.json +++ b/calico_versioned_sidebars/version-3.32-sidebars.json @@ -684,8 +684,7 @@ "reference/calicoctl/datastore/migrate/lock", "reference/calicoctl/datastore/migrate/unlock" ] - }, - "reference/calicoctl/datastore/migrate-policy-names" + } ] }, "reference/calicoctl/version"