Location Minimal

This schema extension is minimal but will provide you with basic items to store location related data, as a Region -> Country -> Site hierarchy. It defines the same Location.Site node as extensions/location_site, so load one or the other, not both. Note that LocationGeneric.name is unique across every location kind, so a name used at one tier cannot be reused at another; a single-country deployment therefore enters the hierarchy at Country (with Region as the national node) rather than duplicating 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 sites it contains.
• Namespace: Location
• Icon: gis:search-country
• 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	description	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 sites it contains.
  label: Country
  icon: gis:search-country
  include_in_menu: true
  menu_placement: LocationGeneric
  inherit_from:
  - LocationGeneric
  parent: LocationRegion
  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: LocationCountry
  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