Step 1: Confirm that GCP Cloud Canary is enabled for your account

Browse to your Console, enter your credentials, and click "Setup". You should see "Cloud Canary" in the settings menu and an entry for GCP Canary. If you don't, please contact support with your Google Cloud emails or domain to share the Canary image with.

Like other Cloud Canaries, a registered, but offline, Cloud Canary will still occupy a license. If you've terminated a bird on GCP, don't forget to decommission it on your Canary Console too.

Step 2: Launching your GCP Cloud Canary

Click "Launch" next to the GCP image, and this will show a window with the command line needed to launch an image:

Step 3: Configure the GCP instance and launching

You'll need a command line shell, where the gcloud cli tool can be run to launch the instance. For the easiest way to do this, we recommend using the Google Cloud Shell in your browser.

Now select the project to launch the GCP Canary in with the following command:

gcloud config set project [Your Project Name]

Copy and paste the command line to launch the instance. If there are other details about the instance you wish to configure, change the command line before running. (See the gcloud instance creation help for all the extra flags allowed.)

Some tips:

  • Your instance type does not need to be high powered. n1-standard-1 is fine.
  • The firewall rules you configure should allow traffic between the bird and the networks you want to monitor.
  • Exposing your instance to the public internet will produce lots of noise. We recommend not opening up ports to 0.0.0.0/0.

Once you run the command, the bird will boot and configure itself.

Step 4: Commission bird

When the bird is configured and running, it will contact the Console to register itself. You will then need to commission the device in the Canary console. In your Console tab, wait for the commission dialog.

Click "Commission Canary", and the bird's status will go green.

It's now ready for remote configuration to enable profiles and services. Tip: to help track the Canary in GCP, change the instance name in GCP when changing the Canary name on the Console to keep them sync.