Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 0 additions & 13 deletions calico-cloud/networking/configuring/bgp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -217,19 +217,6 @@ calicoctl bgp peers <NODE_NAME>

Where `<NODE_NAME>` 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 <NODE_NAME>
```

### 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**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -217,19 +217,6 @@ calicoctl bgp peers <NODE_NAME>

Where `<NODE_NAME>` 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 <NODE_NAME>
```

### 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**.
Expand Down
11 changes: 0 additions & 11 deletions calico-enterprise/networking/configuring/bgp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -216,17 +216,6 @@ calicoctl bgp peers <NODE_NAME>

Where `<NODE_NAME>` 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 <NODE_NAME>
```

### 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**.
Expand Down
111 changes: 1 addition & 110 deletions calico-enterprise/operations/clis/calicoctl/install.mdx
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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. -*/}

Expand All @@ -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
Expand Down Expand Up @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi
</TabItem>
</Tabs>

### Install calicoctl as a kubectl plugin on a single host

<Tabs>
<TabItem label="Linux" value="Linux-3">

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.

:::

</TabItem>
<TabItem label="macOS" value="macOS-4">

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.

:::

</TabItem>
<TabItem label="Windows" value="Windows-5">

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"
```

</TabItem>
</Tabs>

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).
Expand Down
10 changes: 5 additions & 5 deletions calico-enterprise/operations/troubleshoot/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -215,17 +215,6 @@ calicoctl bgp peers <NODE_NAME>

Where `<NODE_NAME>` 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 <NODE_NAME>
```

### 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**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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. -*/}

Expand All @@ -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
Expand Down Expand Up @@ -132,113 +130,6 @@ Invoke-WebRequest -Uri "$[downloadsurl]/ee/binaries/$[releaseTitle]/calicoctl-wi
</TabItem>
</Tabs>

### Install calicoctl as a kubectl plugin on a single host

<Tabs>
<TabItem label="Linux" value="Linux-3">

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.

:::

</TabItem>
<TabItem label="macOS" value="macOS-4">

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.

:::

</TabItem>
<TabItem label="Windows" value="Windows-5">

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"
```

</TabItem>
</Tabs>

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).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading