Skip to main content
Version: 3.18 (latest)

Install calicoq

About installing calicoq​

You can run calicoq on any host with network access to the Calico Enterprise datastore as either a binary or a container.

note

Ensure that you install the binary on a Linux machine. The binary does not work on other machines.

For step-by-step instructions, refer to the section that corresponds to your desired deployment.

Install calicoq as a binary 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/.

  2. Use the following command to download the calicoq binary.

    curl -o calicoq -O -L https://downloads.tigera.io/ee/binaries/v3.18.3/calicoq

  3. Set the file to be executable.

    chmod +x calicoq
    note

    If the location of calicoq is not already in your PATH, move the file to one that is or add its location to your PATH. This will allow you to invoke it without having to prepend its location.

Next step:

Configure calicoq to connect to your datastore.

Install calicoq as a container on a single host​

  1. Ensure that you have the config.json file with the private Tigera registry credentials.

  2. From a terminal prompt, use the following command to either create or open the ~/.docker/config.json file.

    vi ~/.docker/config.json

  3. Depending on the existing contents of the file, edit it in one of the following ways.

    • New file: Paste in the entire contents of the config.json file from Tigera.

    • Existing file without quay.io object: Add the following lines from the config.json inside the "auth" object.

      "quay.io": {
        "auth": "<ROBOT-TOKEN-VALUE>",
        "email": ""
      }

    • Existing file with quay.io object: Add the following lines from the config.json inside the "quay.io" object.

      "auth": "<ROBOT-TOKEN-VALUE>",
      "email": ""

  4. Save and close the file.

  5. Use the following commands to pull the calicoq image from the Tigera registry.

    docker pull quay.io/tigera/calicoq:v3.18.3

  6. Confirm that the image has loaded by typing docker images.

    REPOSITORY                TAG               IMAGE ID       CREATED         SIZE
    tigera/calicoq    v3.18.3            e07d59b0eb8a   2 minutes ago   42MB

Next step:

Configure calicoq to connect to your datastore.