Location Minimal

This schema extension provides a self-contained Region -> Country -> Metro -> Site hierarchy for storing location data, with the Site carrying facility, physical address, timezone and status. Its Site node is the same as the one in extensions/location_site, so the two can be loaded together. A location name is unique across every tier, so a single-country deployment should enter the hierarchy at Country, with Region as the national node, rather than repeating a country under several regions.

Details

Dependencies:
- base

Nodes

Region

Label: Region
Description: A geographical region grouping countries and sites.
Namespace: Location
Icon: carbon:cics-region-target
Inherit From: LocationGeneric, IpamPrefixScope

Country

Label: Country
Description: A country, sitting between a region and the metros it contains.
Namespace: Location
Icon: gis:search-country
Inherit From: LocationGeneric

Metro

Label: Metro
Description: A metropolitan area grouping the sites of one city or urban region.
Namespace: Location
Icon: healthicons:city
Inherit From: LocationGeneric

Site

Label: Site
Description: A physical location hosting equipment, such as a data center or an office.
Namespace: Location
Icon: ri:building-line
Inherit From: LocationGeneric, LocationHosting, IpamPrefixScope, IpamVLANGroupScope

Attributes

name	kind	optional	default_value	choices
status	Dropdown	False	active	active, planned, staging, decommissioning, deprecated
facility	Text	True
physical_address	Text	True
timezone	Text	True

Code

version: '1.0'
nodes:
- name: Region
  namespace: Location
  description: A geographical region grouping countries and sites.
  label: Region
  icon: carbon:cics-region-target
  include_in_menu: true
  menu_placement: LocationGeneric
  inherit_from:
  - LocationGeneric
  - IpamPrefixScope
  parent: ''
  children: LocationCountry
- name: Country
  namespace: Location
  description: A country, sitting between a region and the metros it contains.
  label: Country
  icon: gis:search-country
  include_in_menu: true
  menu_placement: LocationGeneric
  inherit_from:
  - LocationGeneric
  parent: LocationRegion
  children: LocationMetro
- name: Metro
  namespace: Location
  description: A metropolitan area grouping the sites of one city or urban region.
  label: Metro
  icon: healthicons:city
  include_in_menu: true
  menu_placement: LocationGeneric
  inherit_from:
  - LocationGeneric
  parent: LocationCountry
  children: LocationSite
- name: Site
  namespace: Location
  description: A physical location hosting equipment, such as a data center or an
    office.
  label: Site
  icon: ri:building-line
  include_in_menu: true
  menu_placement: LocationGeneric
  inherit_from:
  - LocationGeneric
  - LocationHosting
  - IpamPrefixScope
  - IpamVLANGroupScope
  parent: LocationMetro
  display_label: name__value
  attributes:
  - name: status
    kind: Dropdown
    default_value: active
    choices:
    - name: active
      label: Active
      color: '#00d25b'
    - name: planned
      label: Planned
      color: '#2196f3'
    - name: staging
      label: Staging
      color: '#f0ad4e'
    - name: decommissioning
      label: Decommissioning
      color: '#ff9800'
    - name: deprecated
      label: Deprecated
      color: '#6c757d'
    optional: false
    order_weight: 1200
  - name: facility
    kind: Text
    unique: false
    optional: true
    order_weight: 1150
  - name: physical_address
    kind: Text
    unique: false
    optional: true
    order_weight: 1400
  - name: timezone
    kind: Text
    optional: true
    order_weight: 1300

Details​

Nodes​

Region​

Country​

Metro​

Site​

Attributes​

Code​