diff --git a/calico-cloud/networking/configuring/bgp.mdx b/calico-cloud/networking/configuring/bgp.mdx index fb634815a0..f419958a08 100644 --- a/calico-cloud/networking/configuring/bgp.mdx +++ b/calico-cloud/networking/configuring/bgp.mdx @@ -217,19 +217,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. -{/*//TODO-CC-XREFS [Follow these instructions] (../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin.*/} - -::: - -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-cloud_versioned_docs/version-23-2/networking/configuring/bgp.mdx b/calico-cloud_versioned_docs/version-23-2/networking/configuring/bgp.mdx index fb634815a0..f419958a08 100644 --- a/calico-cloud_versioned_docs/version-23-2/networking/configuring/bgp.mdx +++ b/calico-cloud_versioned_docs/version-23-2/networking/configuring/bgp.mdx @@ -217,19 +217,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. -{/*//TODO-CC-XREFS [Follow these instructions] (../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin.*/} - -::: - -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-enterprise/networking/configuring/bgp.mdx b/calico-enterprise/networking/configuring/bgp.mdx index 638f8ed2de..da6e7a6f8d 100644 --- a/calico-enterprise/networking/configuring/bgp.mdx +++ b/calico-enterprise/networking/configuring/bgp.mdx @@ -216,17 +216,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. [Follow these instructions](../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin. - -::: -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-enterprise/operations/clis/calicoctl/install.mdx b/calico-enterprise/operations/clis/calicoctl/install.mdx index 07f68ddbde..daeb9f9414 100644 --- a/calico-enterprise/operations/clis/calicoctl/install.mdx +++ b/calico-enterprise/operations/clis/calicoctl/install.mdx @@ -1,5 +1,5 @@ --- -description: Install the calicoctl command-line tool as a binary, container, or kubectl plugin so administrators can manage Calico Enterprise resources from any workstation. +description: Install the calicoctl command-line tool as a binary or container so administrators can manage Calico Enterprise resources from any workstation. --- # Install calicoctl @@ -20,7 +20,6 @@ $[prodname] datastore in the [configuration section](configure/index.mdx). You can run `calicoctl` on any host with network access to the $[prodname] datastore as either a binary or a container. -As a binary on a single host, you can also run it as a kubectl plugin. {/*- Change download URL to latest release if user browsing master branch. -*/} @@ -35,7 +34,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi -### Install calicoctl as a kubectl plugin on a single host - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following command to download the `calicoctl` binary. - -```bash -curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl -``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for kubectl to detect the plugin and allow you to use it. - -::: - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following commands to download the `calicoctl` binary. - -- ARM64 (Apple Silicon): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-arm64 - ``` - -- AMD64 (Intel): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-amd64 - ``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If you get the error, "cannot be opened because the developer cannot be verified" when using `calicoctl` for the first time, go to Applications > System Preferences > Security & Privacy in the **General** tab at the bottom of the window click `Allow anyway`. - -::: - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for `kubectl` to detect the plugin. - -::: - - - - -Use the following PowerShell command to download the `calicoctl` binary. - -:::tip - -Consider running PowerShell as administrator and navigating -to a location that's in your `PATH`. For example, `C:\Windows`. - -::: - -```bash -Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-windows-amd64.exe" -OutFile "kubectl-calico.exe" -``` - - - - -Verify the plugin works. - -```bash -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host 1. Ensure that you have the [`config.json` file with the private Tigera registry credentials](../../../getting-started/install-on-clusters/calico-enterprise.mdx#get-private-registry-credentials-and-license-key). diff --git a/calico-enterprise/operations/troubleshoot/troubleshooting.mdx b/calico-enterprise/operations/troubleshoot/troubleshooting.mdx index 08bf914c5c..1cbed324db 100644 --- a/calico-enterprise/operations/troubleshoot/troubleshooting.mdx +++ b/calico-enterprise/operations/troubleshoot/troubleshooting.mdx @@ -1,23 +1,23 @@ --- -description: Troubleshooting guide for Calico Enterprise clusters covering kubectl-calico diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. +description: Troubleshooting guide for Calico Enterprise clusters covering calicoctl diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. --- # Troubleshooting and diagnostics ## Logs and diagnostics -To collect diagnostics, download and install `calicoctl` somewhere in your `$PATH`. We recommend installing it as a kubectl plugin by [following these directions](../clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host). +To collect diagnostics, [install `calicoctl`](../clis/calicoctl/install.mdx) somewhere in your `$PATH`. -Assuming you installed the binary as a kubectl plugin, you can then create a diagnostics bundle by running the following command: +Create a diagnostics bundle by running the following command: ``` -kubectl calico cluster diags +calicoctl cluster diags ``` By default the command collects all logs. Optionally, you can select only those logs that are newer than a relative duration (specified in seconds, minutes or hours). For example: ``` -kubectl calico cluster diags --since=1h +calicoctl cluster diags --since=1h ``` To report a problem, contact Tigera Support. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/networking/configuring/bgp.mdx b/calico-enterprise_versioned_docs/version-3.21-2/networking/configuring/bgp.mdx index 0ef04c6fe8..1f2348916d 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/networking/configuring/bgp.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/networking/configuring/bgp.mdx @@ -215,17 +215,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. [Follow these instructions](../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin. - -::: -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-enterprise_versioned_docs/version-3.21-2/operations/clis/calicoctl/install.mdx b/calico-enterprise_versioned_docs/version-3.21-2/operations/clis/calicoctl/install.mdx index 97d5103379..113a4a6716 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/operations/clis/calicoctl/install.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/operations/clis/calicoctl/install.mdx @@ -20,7 +20,6 @@ $[prodname] datastore in the [configuration section](configure/index.mdx). You can run `calicoctl` on any host with network access to the $[prodname] datastore as either a binary or a container. -As a binary on a single host, you can also run it as a kubectl plugin. {/*- Change download URL to latest release if user browsing master branch. -*/} @@ -35,7 +34,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi -### Install calicoctl as a kubectl plugin on a single host - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following command to download the `calicoctl` binary. - -```bash -curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl -``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for kubectl to detect the plugin and allow you to use it. - -::: - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following commands to download the `calicoctl` binary. - -- ARM64 (Apple Silicon): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-arm64 - ``` - -- AMD64 (Intel): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-amd64 - ``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If you get the error, "cannot be opened because the developer cannot be verified" when using `calicoctl` for the first time, go to Applications > System Preferences > Security & Privacy in the **General** tab at the bottom of the window click `Allow anyway`. - -::: - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for `kubectl` to detect the plugin. - -::: - - - - -Use the following PowerShell command to download the `calicoctl` binary. - -:::tip - -Consider running PowerShell as administrator and navigating -to a location that's in your `PATH`. For example, `C:\Windows`. - -::: - -```bash -Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-windows-amd64.exe" -OutFile "kubectl-calico.exe" -``` - - - - -Verify the plugin works. - -```bash -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host 1. Ensure that you have the [`config.json` file with the private Tigera registry credentials](../../../getting-started/install-on-clusters/calico-enterprise.mdx#get-private-registry-credentials-and-license-key). diff --git a/calico-enterprise_versioned_docs/version-3.21-2/operations/troubleshoot/troubleshooting.mdx b/calico-enterprise_versioned_docs/version-3.21-2/operations/troubleshoot/troubleshooting.mdx index 06efe50bb1..4fa63bfeb9 100644 --- a/calico-enterprise_versioned_docs/version-3.21-2/operations/troubleshoot/troubleshooting.mdx +++ b/calico-enterprise_versioned_docs/version-3.21-2/operations/troubleshoot/troubleshooting.mdx @@ -6,18 +6,18 @@ description: View logs and diagnostics, common issues, and where to report issue ## Logs and diagnostics -To collect diagnostics, download and install `calicoctl` somewhere in your `$PATH`. We recommend installing it as a kubectl plugin by [following these directions](../clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host). +To collect diagnostics, [install `calicoctl`](../clis/calicoctl/install.mdx) somewhere in your `$PATH`. -Assuming you installed the binary as a kubectl plugin, you can then create a diagnostics bundle by running the following command: +Create a diagnostics bundle by running the following command: ``` -kubectl calico cluster diags +calicoctl cluster diags ``` By default the command collects all logs. Optionally, you can select only those logs that are newer than a relative duration (specified in seconds, minutes or hours). For example: ``` -kubectl calico cluster diags --since=1h +calicoctl cluster diags --since=1h ``` To report a problem, contact Tigera Support. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/networking/configuring/bgp.mdx b/calico-enterprise_versioned_docs/version-3.22-2/networking/configuring/bgp.mdx index 2e11b7548b..94f293fc46 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/networking/configuring/bgp.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/networking/configuring/bgp.mdx @@ -216,17 +216,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. [Follow these instructions](../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin. - -::: -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-enterprise_versioned_docs/version-3.22-2/operations/clis/calicoctl/install.mdx b/calico-enterprise_versioned_docs/version-3.22-2/operations/clis/calicoctl/install.mdx index 07f68ddbde..daeb9f9414 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/operations/clis/calicoctl/install.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/operations/clis/calicoctl/install.mdx @@ -1,5 +1,5 @@ --- -description: Install the calicoctl command-line tool as a binary, container, or kubectl plugin so administrators can manage Calico Enterprise resources from any workstation. +description: Install the calicoctl command-line tool as a binary or container so administrators can manage Calico Enterprise resources from any workstation. --- # Install calicoctl @@ -20,7 +20,6 @@ $[prodname] datastore in the [configuration section](configure/index.mdx). You can run `calicoctl` on any host with network access to the $[prodname] datastore as either a binary or a container. -As a binary on a single host, you can also run it as a kubectl plugin. {/*- Change download URL to latest release if user browsing master branch. -*/} @@ -35,7 +34,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi -### Install calicoctl as a kubectl plugin on a single host - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following command to download the `calicoctl` binary. - -```bash -curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl -``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for kubectl to detect the plugin and allow you to use it. - -::: - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following commands to download the `calicoctl` binary. - -- ARM64 (Apple Silicon): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-arm64 - ``` - -- AMD64 (Intel): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-amd64 - ``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If you get the error, "cannot be opened because the developer cannot be verified" when using `calicoctl` for the first time, go to Applications > System Preferences > Security & Privacy in the **General** tab at the bottom of the window click `Allow anyway`. - -::: - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for `kubectl` to detect the plugin. - -::: - - - - -Use the following PowerShell command to download the `calicoctl` binary. - -:::tip - -Consider running PowerShell as administrator and navigating -to a location that's in your `PATH`. For example, `C:\Windows`. - -::: - -```bash -Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-windows-amd64.exe" -OutFile "kubectl-calico.exe" -``` - - - - -Verify the plugin works. - -```bash -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host 1. Ensure that you have the [`config.json` file with the private Tigera registry credentials](../../../getting-started/install-on-clusters/calico-enterprise.mdx#get-private-registry-credentials-and-license-key). diff --git a/calico-enterprise_versioned_docs/version-3.22-2/operations/troubleshoot/troubleshooting.mdx b/calico-enterprise_versioned_docs/version-3.22-2/operations/troubleshoot/troubleshooting.mdx index 31c9f17327..46c35a267d 100644 --- a/calico-enterprise_versioned_docs/version-3.22-2/operations/troubleshoot/troubleshooting.mdx +++ b/calico-enterprise_versioned_docs/version-3.22-2/operations/troubleshoot/troubleshooting.mdx @@ -1,23 +1,23 @@ --- -description: Troubleshooting guide for Calico Enterprise clusters covering kubectl-calico diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. +description: Troubleshooting guide for Calico Enterprise clusters covering calicoctl diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. --- # Troubleshooting and diagnostics ## Logs and diagnostics -To collect diagnostics, download and install `calicoctl` somewhere in your `$PATH`. We recommend installing it as a kubectl plugin by [following these directions](../clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host). +To collect diagnostics, [install `calicoctl`](../clis/calicoctl/install.mdx) somewhere in your `$PATH`. -Assuming you installed the binary as a kubectl plugin, you can then create a diagnostics bundle by running the following command: +Create a diagnostics bundle by running the following command: ``` -kubectl calico cluster diags +calicoctl cluster diags ``` By default the command collects all logs. Optionally, you can select only those logs that are newer than a relative duration (specified in seconds, minutes or hours). For example: ``` -kubectl calico cluster diags --since=1h +calicoctl cluster diags --since=1h ``` To report a problem, contact Tigera Support. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/networking/configuring/bgp.mdx b/calico-enterprise_versioned_docs/version-3.23-2/networking/configuring/bgp.mdx index 638f8ed2de..da6e7a6f8d 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/networking/configuring/bgp.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/networking/configuring/bgp.mdx @@ -216,17 +216,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. [Follow these instructions](../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin. - -::: -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-enterprise_versioned_docs/version-3.23-2/operations/clis/calicoctl/install.mdx b/calico-enterprise_versioned_docs/version-3.23-2/operations/clis/calicoctl/install.mdx index 07f68ddbde..daeb9f9414 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/operations/clis/calicoctl/install.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/operations/clis/calicoctl/install.mdx @@ -1,5 +1,5 @@ --- -description: Install the calicoctl command-line tool as a binary, container, or kubectl plugin so administrators can manage Calico Enterprise resources from any workstation. +description: Install the calicoctl command-line tool as a binary or container so administrators can manage Calico Enterprise resources from any workstation. --- # Install calicoctl @@ -20,7 +20,6 @@ $[prodname] datastore in the [configuration section](configure/index.mdx). You can run `calicoctl` on any host with network access to the $[prodname] datastore as either a binary or a container. -As a binary on a single host, you can also run it as a kubectl plugin. {/*- Change download URL to latest release if user browsing master branch. -*/} @@ -35,7 +34,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi -### Install calicoctl as a kubectl plugin on a single host - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following command to download the `calicoctl` binary. - -```bash -curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl -``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for kubectl to detect the plugin and allow you to use it. - -::: - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following commands to download the `calicoctl` binary. - -- ARM64 (Apple Silicon): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-arm64 - ``` - -- AMD64 (Intel): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-amd64 - ``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If you get the error, "cannot be opened because the developer cannot be verified" when using `calicoctl` for the first time, go to Applications > System Preferences > Security & Privacy in the **General** tab at the bottom of the window click `Allow anyway`. - -::: - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for `kubectl` to detect the plugin. - -::: - - - - -Use the following PowerShell command to download the `calicoctl` binary. - -:::tip - -Consider running PowerShell as administrator and navigating -to a location that's in your `PATH`. For example, `C:\Windows`. - -::: - -```bash -Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-windows-amd64.exe" -OutFile "kubectl-calico.exe" -``` - - - - -Verify the plugin works. - -```bash -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host 1. Ensure that you have the [`config.json` file with the private Tigera registry credentials](../../../getting-started/install-on-clusters/calico-enterprise.mdx#get-private-registry-credentials-and-license-key). diff --git a/calico-enterprise_versioned_docs/version-3.23-2/operations/troubleshoot/troubleshooting.mdx b/calico-enterprise_versioned_docs/version-3.23-2/operations/troubleshoot/troubleshooting.mdx index 31c9f17327..46c35a267d 100644 --- a/calico-enterprise_versioned_docs/version-3.23-2/operations/troubleshoot/troubleshooting.mdx +++ b/calico-enterprise_versioned_docs/version-3.23-2/operations/troubleshoot/troubleshooting.mdx @@ -1,23 +1,23 @@ --- -description: Troubleshooting guide for Calico Enterprise clusters covering kubectl-calico diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. +description: Troubleshooting guide for Calico Enterprise clusters covering calicoctl diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. --- # Troubleshooting and diagnostics ## Logs and diagnostics -To collect diagnostics, download and install `calicoctl` somewhere in your `$PATH`. We recommend installing it as a kubectl plugin by [following these directions](../clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host). +To collect diagnostics, [install `calicoctl`](../clis/calicoctl/install.mdx) somewhere in your `$PATH`. -Assuming you installed the binary as a kubectl plugin, you can then create a diagnostics bundle by running the following command: +Create a diagnostics bundle by running the following command: ``` -kubectl calico cluster diags +calicoctl cluster diags ``` By default the command collects all logs. Optionally, you can select only those logs that are newer than a relative duration (specified in seconds, minutes or hours). For example: ``` -kubectl calico cluster diags --since=1h +calicoctl cluster diags --since=1h ``` To report a problem, contact Tigera Support. diff --git a/calico-enterprise_versioned_docs/version-3.24-1/networking/configuring/bgp.mdx b/calico-enterprise_versioned_docs/version-3.24-1/networking/configuring/bgp.mdx index 638f8ed2de..da6e7a6f8d 100644 --- a/calico-enterprise_versioned_docs/version-3.24-1/networking/configuring/bgp.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-1/networking/configuring/bgp.mdx @@ -216,17 +216,6 @@ calicoctl bgp peers Where `` is the resource name for one of the Calico node pods within your cluster. -:::note - -The above command can be run from anywhere you have access to kubectl. We recommend running it as a kubectl plugin. [Follow these instructions](../../operations/clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) for how to install `calicoctl` as a kubectl plugin. - -::: -If you install the binary as a kubectl plugin using the above instructions, you can then run the command as follows: - -```bash -kubectl calico bgp peers -``` - ### Change the default global AS number By default, all Calico nodes use the 64512 autonomous system, unless a per-node AS has been specified for the node. You can change the global default for all nodes by modifying the default **BGPConfiguration** resource. The following example command sets the global default AS number to **64513**. diff --git a/calico-enterprise_versioned_docs/version-3.24-1/operations/clis/calicoctl/install.mdx b/calico-enterprise_versioned_docs/version-3.24-1/operations/clis/calicoctl/install.mdx index 07f68ddbde..daeb9f9414 100644 --- a/calico-enterprise_versioned_docs/version-3.24-1/operations/clis/calicoctl/install.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-1/operations/clis/calicoctl/install.mdx @@ -1,5 +1,5 @@ --- -description: Install the calicoctl command-line tool as a binary, container, or kubectl plugin so administrators can manage Calico Enterprise resources from any workstation. +description: Install the calicoctl command-line tool as a binary or container so administrators can manage Calico Enterprise resources from any workstation. --- # Install calicoctl @@ -20,7 +20,6 @@ $[prodname] datastore in the [configuration section](configure/index.mdx). You can run `calicoctl` on any host with network access to the $[prodname] datastore as either a binary or a container. -As a binary on a single host, you can also run it as a kubectl plugin. {/*- Change download URL to latest release if user browsing master branch. -*/} @@ -35,7 +34,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi -### Install calicoctl as a kubectl plugin on a single host - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following command to download the `calicoctl` binary. - -```bash -curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl -``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for kubectl to detect the plugin and allow you to use it. - -::: - - - - -Log into the host, open a terminal prompt, and navigate to the location where you want to install the binary. - -:::note - -Consider navigating to a location that's in your `PATH`. For example, `/usr/local/bin/`. - -::: - -Use the following commands to download the `calicoctl` binary. - -- ARM64 (Apple Silicon): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-arm64 - ``` - -- AMD64 (Intel): - - ```bash - curl -o kubectl-calico -L $[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-darwin-amd64 - ``` - -Set the file to be executable. - -```bash -chmod +x kubectl-calico -``` - -:::note - -If you get the error, "cannot be opened because the developer cannot be verified" when using `calicoctl` for the first time, go to Applications > System Preferences > Security & Privacy in the **General** tab at the bottom of the window click `Allow anyway`. - -::: - -:::note - -If the location of `kubectl-calico` is not already in your `PATH`, move the file to one that is or add its location to your `PATH`. This is required for `kubectl` to detect the plugin. - -::: - - - - -Use the following PowerShell command to download the `calicoctl` binary. - -:::tip - -Consider running PowerShell as administrator and navigating -to a location that's in your `PATH`. For example, `C:\Windows`. - -::: - -```bash -Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-windows-amd64.exe" -OutFile "kubectl-calico.exe" -``` - - - - -Verify the plugin works. - -```bash -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host 1. Ensure that you have the [`config.json` file with the private Tigera registry credentials](../../../getting-started/install-on-clusters/calico-enterprise.mdx#get-private-registry-credentials-and-license-key). diff --git a/calico-enterprise_versioned_docs/version-3.24-1/operations/troubleshoot/troubleshooting.mdx b/calico-enterprise_versioned_docs/version-3.24-1/operations/troubleshoot/troubleshooting.mdx index 08bf914c5c..1cbed324db 100644 --- a/calico-enterprise_versioned_docs/version-3.24-1/operations/troubleshoot/troubleshooting.mdx +++ b/calico-enterprise_versioned_docs/version-3.24-1/operations/troubleshoot/troubleshooting.mdx @@ -1,23 +1,23 @@ --- -description: Troubleshooting guide for Calico Enterprise clusters covering kubectl-calico diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. +description: Troubleshooting guide for Calico Enterprise clusters covering calicoctl diagnostics bundles, log severity tuning, common failure patterns, and where to report issues. --- # Troubleshooting and diagnostics ## Logs and diagnostics -To collect diagnostics, download and install `calicoctl` somewhere in your `$PATH`. We recommend installing it as a kubectl plugin by [following these directions](../clis/calicoctl/install.mdx#install-calicoctl-as-a-kubectl-plugin-on-a-single-host). +To collect diagnostics, [install `calicoctl`](../clis/calicoctl/install.mdx) somewhere in your `$PATH`. -Assuming you installed the binary as a kubectl plugin, you can then create a diagnostics bundle by running the following command: +Create a diagnostics bundle by running the following command: ``` -kubectl calico cluster diags +calicoctl cluster diags ``` By default the command collects all logs. Optionally, you can select only those logs that are newer than a relative duration (specified in seconds, minutes or hours). For example: ``` -kubectl calico cluster diags --since=1h +calicoctl cluster diags --since=1h ``` To report a problem, contact Tigera Support. diff --git a/calico/operations/calicoctl/install.mdx b/calico/operations/calicoctl/install.mdx index ca2d299bdb..c7d3e3091c 100644 --- a/calico/operations/calicoctl/install.mdx +++ b/calico/operations/calicoctl/install.mdx @@ -1,5 +1,5 @@ --- -description: Install the calicoctl command-line tool as a binary, container, or kubectl plugin so administrators can manage Calico Open Source resources from any workstation. +description: Install the calicoctl command-line tool as a binary or container so administrators can manage Calico Open Source resources from any workstation. --- # Install calicoctl @@ -82,7 +82,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -189,121 +188,6 @@ Make sure you always install the version of `calicoctl` that matches the version -### Install calicoctl as a kubectl plugin on a single host - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - AMD64: - - curl -L {url}/calicoctl-linux-amd64 -o kubectl-calico - - - ARM64: - - curl -L {url}/calicoctl-linux-arm64 -o kubectl-calico - - - PPC64le: - - curl -L {url}/calicoctl-linux-ppc64le -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If the location of `kubectl-calico` is not already in your `PATH`, move the file - to one that is or add its location to your `PATH`. This is required in order for - kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - ARM64 (Apple Silicon): - - curl -L {url}/calicoctl-darwin-arm64 -o kubectl-calico - - - AMD64 (Intel): - - curl -L {url}/calicoctl-darwin-amd64 -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If you are faced with `cannot be opened because the developer cannot be verified` error when using `calicoctl` for the first time. - go to `Applications > System Preferences > Security & Privacy` in the `General` tab at the bottom of the window click `Allow anyway`. - - > If the location of `kubectl-calico` is not already in your `PATH`, move the file - > to one that is or add its location to your `PATH`. This is required in order for - > kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Use the following PowerShell command to download the `calicoctl` binary. - - :::tip - - Consider running PowerShell as administrator and navigating - to a location that's in your `PATH`. For example, `C:\Windows`. - - ::: - -Invoke-WebRequest -Uri "{url}/calicoctl-windows-amd64.exe" -OutFile kubectl-calico.exe - - - - -Verify the plugin works. - -``` -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of -the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host `calicoctl` ships as part of the combined `calico/calico` image. To install it as a diff --git a/calico_versioned_docs/version-3.29/operations/calicoctl/install.mdx b/calico_versioned_docs/version-3.29/operations/calicoctl/install.mdx index f951177303..5c39bf12d2 100644 --- a/calico_versioned_docs/version-3.29/operations/calicoctl/install.mdx +++ b/calico_versioned_docs/version-3.29/operations/calicoctl/install.mdx @@ -82,7 +82,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -189,121 +188,6 @@ Make sure you always install the version of `calicoctl` that matches the version -### Install calicoctl as a kubectl plugin on a single host - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - AMD64: - - curl -L {url}/calicoctl-linux-amd64 -o kubectl-calico - - - ARM64: - - curl -L {url}/calicoctl-linux-arm64 -o kubectl-calico - - - PPC64le: - - curl -L {url}/calicoctl-linux-ppc64le -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If the location of `kubectl-calico` is not already in your `PATH`, move the file - to one that is or add its location to your `PATH`. This is required in order for - kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - ARM64 (Apple Silicon): - - curl -L {url}/calicoctl-darwin-arm64 -o kubectl-calico - - - AMD64 (Intel): - - curl -L {url}/calicoctl-darwin-amd64 -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If you are faced with `cannot be opened because the developer cannot be verified` error when using `calicoctl` for the first time. - go to `Applications > System Preferences > Security & Privacy` in the `General` tab at the bottom of the window click `Allow anyway`. - - > If the location of `kubectl-calico` is not already in your `PATH`, move the file - > to one that is or add its location to your `PATH`. This is required in order for - > kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Use the following PowerShell command to download the `calicoctl` binary. - - :::tip - - Consider running PowerShell as administrator and navigating - to a location that's in your `PATH`. For example, `C:\Windows`. - - ::: - -Invoke-WebRequest -Uri "{url}/calicoctl-windows-amd64.exe" -OutFile kubectl-calico.exe - - - - -Verify the plugin works. - -``` -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of -the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host To install `calicoctl` as a container on a single host, log into the diff --git a/calico_versioned_docs/version-3.30/operations/calicoctl/install.mdx b/calico_versioned_docs/version-3.30/operations/calicoctl/install.mdx index f951177303..5c39bf12d2 100644 --- a/calico_versioned_docs/version-3.30/operations/calicoctl/install.mdx +++ b/calico_versioned_docs/version-3.30/operations/calicoctl/install.mdx @@ -82,7 +82,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -189,121 +188,6 @@ Make sure you always install the version of `calicoctl` that matches the version -### Install calicoctl as a kubectl plugin on a single host - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - AMD64: - - curl -L {url}/calicoctl-linux-amd64 -o kubectl-calico - - - ARM64: - - curl -L {url}/calicoctl-linux-arm64 -o kubectl-calico - - - PPC64le: - - curl -L {url}/calicoctl-linux-ppc64le -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If the location of `kubectl-calico` is not already in your `PATH`, move the file - to one that is or add its location to your `PATH`. This is required in order for - kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - ARM64 (Apple Silicon): - - curl -L {url}/calicoctl-darwin-arm64 -o kubectl-calico - - - AMD64 (Intel): - - curl -L {url}/calicoctl-darwin-amd64 -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If you are faced with `cannot be opened because the developer cannot be verified` error when using `calicoctl` for the first time. - go to `Applications > System Preferences > Security & Privacy` in the `General` tab at the bottom of the window click `Allow anyway`. - - > If the location of `kubectl-calico` is not already in your `PATH`, move the file - > to one that is or add its location to your `PATH`. This is required in order for - > kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Use the following PowerShell command to download the `calicoctl` binary. - - :::tip - - Consider running PowerShell as administrator and navigating - to a location that's in your `PATH`. For example, `C:\Windows`. - - ::: - -Invoke-WebRequest -Uri "{url}/calicoctl-windows-amd64.exe" -OutFile kubectl-calico.exe - - - - -Verify the plugin works. - -``` -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of -the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host To install `calicoctl` as a container on a single host, log into the diff --git a/calico_versioned_docs/version-3.31/operations/calicoctl/install.mdx b/calico_versioned_docs/version-3.31/operations/calicoctl/install.mdx index f951177303..5c39bf12d2 100644 --- a/calico_versioned_docs/version-3.31/operations/calicoctl/install.mdx +++ b/calico_versioned_docs/version-3.31/operations/calicoctl/install.mdx @@ -82,7 +82,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -189,121 +188,6 @@ Make sure you always install the version of `calicoctl` that matches the version -### Install calicoctl as a kubectl plugin on a single host - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - AMD64: - - curl -L {url}/calicoctl-linux-amd64 -o kubectl-calico - - - ARM64: - - curl -L {url}/calicoctl-linux-arm64 -o kubectl-calico - - - PPC64le: - - curl -L {url}/calicoctl-linux-ppc64le -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If the location of `kubectl-calico` is not already in your `PATH`, move the file - to one that is or add its location to your `PATH`. This is required in order for - kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - ARM64 (Apple Silicon): - - curl -L {url}/calicoctl-darwin-arm64 -o kubectl-calico - - - AMD64 (Intel): - - curl -L {url}/calicoctl-darwin-amd64 -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If you are faced with `cannot be opened because the developer cannot be verified` error when using `calicoctl` for the first time. - go to `Applications > System Preferences > Security & Privacy` in the `General` tab at the bottom of the window click `Allow anyway`. - - > If the location of `kubectl-calico` is not already in your `PATH`, move the file - > to one that is or add its location to your `PATH`. This is required in order for - > kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Use the following PowerShell command to download the `calicoctl` binary. - - :::tip - - Consider running PowerShell as administrator and navigating - to a location that's in your `PATH`. For example, `C:\Windows`. - - ::: - -Invoke-WebRequest -Uri "{url}/calicoctl-windows-amd64.exe" -OutFile kubectl-calico.exe - - - - -Verify the plugin works. - -``` -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of -the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host To install `calicoctl` as a container on a single host, log into the diff --git a/calico_versioned_docs/version-3.32/operations/calicoctl/install.mdx b/calico_versioned_docs/version-3.32/operations/calicoctl/install.mdx index ea1cdb8924..7360f79a0b 100644 --- a/calico_versioned_docs/version-3.32/operations/calicoctl/install.mdx +++ b/calico_versioned_docs/version-3.32/operations/calicoctl/install.mdx @@ -1,5 +1,5 @@ --- -description: Install the calicoctl command-line tool as a binary, container, or kubectl plugin so administrators can manage Calico Open Source resources from any workstation. +description: Install the calicoctl command-line tool as a binary or container so administrators can manage Calico Open Source resources from any workstation. --- # Install calicoctl @@ -82,7 +82,6 @@ Make sure you always install the version of `calicoctl` that matches the version ::: - [Install calicoctl as a binary on a single host](#install-calicoctl-as-a-binary-on-a-single-host) -- [Install calicoctl as a kubectl plugin on a single host](#install-calicoctl-as-a-kubectl-plugin-on-a-single-host) - [Install calicoctl as a container on a single host](#install-calicoctl-as-a-container-on-a-single-host) ### Install calicoctl as a binary on a single host @@ -189,121 +188,6 @@ Make sure you always install the version of `calicoctl` that matches the version -### Install calicoctl as a kubectl plugin on a single host - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - AMD64: - - curl -L {url}/calicoctl-linux-amd64 -o kubectl-calico - - - ARM64: - - curl -L {url}/calicoctl-linux-arm64 -o kubectl-calico - - - PPC64le: - - curl -L {url}/calicoctl-linux-ppc64le -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If the location of `kubectl-calico` is not already in your `PATH`, move the file - to one that is or add its location to your `PATH`. This is required in order for - kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Log into the host, open a terminal prompt, and navigate to the location where - you want to install the binary. - - :::tip - - Consider navigating to a location that's in your `PATH`. For example, - `/usr/local/bin/`. - - ::: - -1. Use the following commands to download the `calicoctl` binary. - - - ARM64 (Apple Silicon): - - curl -L {url}/calicoctl-darwin-arm64 -o kubectl-calico - - - AMD64 (Intel): - - curl -L {url}/calicoctl-darwin-amd64 -o kubectl-calico - -1. Set the file to be executable. - - ```bash - chmod +x kubectl-calico - ``` - - :::note - - If you are faced with `cannot be opened because the developer cannot be verified` error when using `calicoctl` for the first time. - go to `Applications > System Preferences > Security & Privacy` in the `General` tab at the bottom of the window click `Allow anyway`. - - > If the location of `kubectl-calico` is not already in your `PATH`, move the file - > to one that is or add its location to your `PATH`. This is required in order for - > kubectl to detect the plugin and allow you to use it. - - ::: - - - - -1. Use the following PowerShell command to download the `calicoctl` binary. - - :::tip - - Consider running PowerShell as administrator and navigating - to a location that's in your `PATH`. For example, `C:\Windows`. - - ::: - -Invoke-WebRequest -Uri "{url}/calicoctl-windows-amd64.exe" -OutFile kubectl-calico.exe - - - - -Verify the plugin works. - -``` -kubectl calico -h -``` - -You can now run any `calicoctl` subcommands through `kubectl calico`. - -:::note - -If you run these commands from your local machine (instead of a host node), some of -the node related subcommands will not work (like node status). - -::: - ### Install calicoctl as a container on a single host To install `calicoctl` as a container on a single host, log into the