Activating an appliance

Prev Next

This section describes how to export the seed file, activate, and deactivate an appliance.


Exporting the seed file/ISO

Once the new appliance record has been created within the admin UI, you'll need a seed file to activate the target appliance.

To export the seed file:

  1. Navigate to Appliances (System > Appliances).

  2. Hover over the newly-created appliance in the list and select Export Seed File/ISO.

NOTE

It is not possible to seed a newer target appliance than the Controller version you are using to export the seed.


Activate the appliance

If you haven’t already, you will need to perform an appliance installation on a physical/virtual host or use a Cloud instance of the appliance. Ensure you have SSH access to the new appliance and that it has access to the Controller on port 443.

When the new appliance finds a valid JSON (or ISO) seed file, it automatically activates. The seed file remains valid only for the Seed Lifetime that was selected. It is also possible to seed an appliance manually once it is up and running.

  • After a new appliance has been seeded, it will establish communication towards the Controller. As part of the registration it will get a signed certificate and change its status from Pending to Active.

  • Once activated, the temporary certificate included in the seed file is deleted. This means a seed file can only be used once if activation succeeded, so a new seed file will have to be generated to reactivate it.

  • Once communications are established, the Controller messages the appliances. For example, asking for health status or telling Gateways which tokens are no longer valid.


Manually seeding an appliance

NOTE

If you are re-seeding an existing appliance, you may need to wipe it before it will accept a new seed file. This can be done by using the command sudo cz-config wipe-appliance --force

If you need to seed an appliance manually, you do this by passing the seed to the appliance.

NOTE

If you download the JSON seed file, it may be renamed but must end in -seed.json or be exactly seed.json

To pass the seed to the appliance:

With SSH access

  1. Grab the seed using the RAW option which copies the JSON to the clipboard.

  2. SSH in to the appliance and enter nano seed.json, paste the seed, and save.

For the cloud

Upload the seed using SCP to the appliance. For example: scp -i ~/keys/mykey ~/Desktop/newgateway-seed.json cz@newgateway.wherever.com:

For remote hardware

Mount the seed ISO to the appliance using the Virtual Media function in the iDRAC.

For local hardware

  1. Prepare a FAT32-formatted USB drive. Any size will do.

  2. Copy the seed to root on the USB drive.

  3. If the appliance is not running already, power it on and wait a few minutes to let it start.

  4. Insert the USB drive.

  5. After a few minutes, the admin should see the new appliance in the dashboard. The USB drive can now be removed.

For a virtual host

  1. Mount seed ISO to virtual machine.

  2. cz-configd should detect this file and automatically register the appliance. The appliance will report Appliance seed configuration file picked up at /home/cz/seed.json.

  3. If this does not happen, restart cz-configd by entering: sudo service cz-configd restart


Deactivating or migrating an existing appliance

You can deactivate an appliance when migrating it from one host to another, or when removing an appliance from a Collective that you intend to reactivate in the future.

If migrating, the existing appliance needs to be deactivated and taken offline; the seed file is then re-exported for the new appliance.

NOTE

If you are migrating a Gateway, it is recommended to have another Gateway serving the same Site to ensure that migration is seamless.

To deactivate an appliance:

  1. In the Appliances page, select the three dots next to the appliance and select Deactivate.

NOTE

You cannot deactivate an active Controller. The Controller function must be disabled first.

  1. To avoid having the new and old appliances claim the same hostnames:

    • Power down the old appliance; or

    • Wipe the appliance using the command: sudo cz-config wipe-appliance --force

The appliance will no longer appear as Active in the Appliances page.