3.2. Sites

3.2.1. Overview

A site represents a physical install location for one or more gateway devices. Using sites to organize your gateways allows you to configure those gateways from one place in the user interface. A site may have many gateways in it, but each gateway may only be assigned to one site.

Note

Gateways that are not in a site may be managed and configured individually. For more on this see Configuration.

Each site has the following components:

  • Name: The name of the site.

    Important

    Once you create a site, you will not be able to rename it. If you want to duplicate a site, see Duplicating a Site.

  • Description: An optional description for the site.

  • Location: An optional location for the site. This value is only used for description of the site, and does not affect any of the timed features of the site.

  • Time Zone: An optional timezone locale for the site. This value is only used for showing site-related timestamps in the site’s local time.

    Important

    The Edge Direct backend operates solely with respect to UTC time. This is to ensure greater stability and support for our global customer base.

    If you do not specify a timezone on your site, all site-related timestamps will display in UTC time.

  • Configuration: A site enables users to configure many gateways at once. We use our configuration state mechanism to manage this. For more information on the different types of configurations, as well as an in-depth explanation of how a configuration moves from state to state, see Configuration.

  • Configuration Variables: A site’s configuration applies to many gateways. Using configuration variables allows each gateway to provide individual values to that configuration. Or, if some gateways use the same values as each other, those values can be attached to the site as “defaults”.

    Another way site configuration variables are used is to enforce a value as “required”.

    More detail in Configuration Variables, below.

  • Gateways: A list of gateways in the site

  • Maintenance Window: This component is mandatory for each site. The default maintenance window is “immediate/ongoing”, which means that all configuration changes are immediately made available for gateways to apply.

    Other types of maintenance window are “weekly”, “monthly”, and “quarterly”. Using one of these types will prevent changes to your site’s gateways until the maintenance window opens.

    For more detail, see Maintenance Windows, below.

  • Tags: As with gateways, key:value tags may be applied to sites. See Tag Keys for more information.

3.2.2. Site List View

../_images/sites-list.png

The site page lists all your organization’s sites. It shows a summary of each site’s gateway status and configuration status, as well as a summary of the current or upcoming maintenance window.

Clicking on a site will bring up the site detail view.

3.2.3. Site Detail View

../_images/details.png

The site detail view initially shows the site’s basic information, such as tags, description, location, and timezone. It also allows the user to update this information.

Maintenance Windows

../_images/maintenance-window.png

The site maintenance window tab shows the details of the site’s maintenance window, as well as the gateway behavior settings related to that window.

The four types of maintenance window are:

  • immediate/ongoing: sites with this cadence will make configuration changes available to gateways immediately.

    Note

    A gateway must be online in order to apply configuration changes. For more detail on how configurations are applied, see Configuration.

  • weekly: sites with this cadence will make configuration changes available to gateways once per week, for a defined duration. You may specify the day of the week and the hour of the day (in UTC time) that the window will open.

    Example: “Every Wednesday at 03:00 UTC”

  • monthly: sites with this cadence will make configuration changes available to gateways once per month, for a defined duration. You may specify the week of the month, day of the week, and hour of the day (in UTC time) that the window will open.

    Example: “2nd Wednesday of the month at 03:00 UTC”

  • quarterly: sites with this cadence will make configuration changes available to gateways once every three months, for a defined duration. You may specify the month of the quarter, week of the month, day of the week, and hour of the day (in UTC time) that the window will open.

    Example: “2nd Wednesday of the month (Months: February/May/August/November) at 03:00 UTC”

A maintenance window’s duration may not be shorter than 8 hours. This is to allow plenty of time for each gateway to receive its updates, and for administrators to catch and correct potential errors with these changes.

A window’s duration may not be longer than 24 hours. If you wish to have your site’s maintenance window open longer than 24 hours, consider updating it to an “immediate/ongoing” cadence.

The other setting on this tab is about updating gateways that were offline during a maintenance window. If set to “immediately” then gateways that come online after a maintenance window has already closed will receive the updates from that window. If set to “during next maintenance window” then those gateways will not receive any updates until the next maintenance window opens.

Configuration

../_images/configuration.png

The configuration tab of the site detail view shows a few things

  1. A table showing a breakdown of configurations by type and by state, with a number of gateways that currently have that configuration state. Each table row has an Edit button to schedule new configurations of that type for the next maintenance window.

  2. A list of current configurations by type, already applied to gateways in the site.

    Note

    If a gateway is offline during a maintenance window, then comes online afterwards, and the site is set to update this gateway immediately, the gateway will receive and apply these current configurations.

    Additionally, gateways newly-added to a site will immediately have the site’s current configurations applied to them, regardless of the site’s maintenance window.

  3. A table showing the site’s configuration variables, including the ability to create new ones and import existing ones from the organization.

Configuration Variables

This section of the Configuration tab shows the configuration variables that will be applied to this site’s configurations. For more information on working with Configuration Variables, see Configuring Multiple Gateways.

Gateways

../_images/gateways.png

The gateways tab of the site detail view shows the current state of each gateway in the site. It allows a user to add new gateways to the site, and remove existing gateways from the site.

Clicking on a gateway will take you to the Gateway Detail View.

3.2.4. Creating a Site

Duplicating a Site

When creating a new site, you have the option to duplicate the configuration from another existing site.

You can duplicate configuration in two modes:
Basic - Simply copies all configuration sections.
Advanced - allows you to choose specific sections to copy, individually.