Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A geographic coordinate expressed as a latitude and longitude.

KeyValue
latitudeLatitude of the location.
longitudeLongitude of the location.


| Key | Value | |-----------------------------|----------------------------| | latitude | Latitude of the location. | | longitude | Longitude of the location. |

...

An opaque host name that can be translated to a coordinate via an inventory provider (e.g., A&AI).

KeyValue
host_name Host name identifying a location.


| Key | Value | |-----------------------------|----------------------------| | host_name | Host name identifying a location. |

...

Common Language Location Identification (CLLI) code(https://en.wikipedia.org/wiki/CLLI_code).


KeyValue
clli_code 8 character CLLI.


| Key | Value | |-----------------------------|----------------------------| | clli_code | 8 character CLLI. |

...

Support for this schema is deferred.|

Key

...

Value
iso_country_codeThe abbreviated country name associated with the placemark.
postal_codeThe postal code associated with the placemark.
administrative_areaThe state or province associated with the placemark.

...

sub_administrative_area

...

Additional administrative area information for the placemark.

...

locality

...

The city associated with the placemark.

...

sub_locality

...

Additional city-level information for the placemark.

...

thoroughfare

...

The street address associated with the placemark.

...

sub_thoroughfare

...

Additional street-level information for the placemark.

...

Questions

  • What geocoder can we use to convert placemarks to a latitude/longitude?

Examples

The following examples illustrate a location expressed in coordinate, host_name, CLLI, and placemark, respectively.

locations:
  location_using_coordinates:
    latitude: 32.897480
    longitude: -97.040443

  host_location_using_host_name:
    host_name: USESTCDLLSTX55ANZ123

  location_using_clli:
    clli_code: DLLSTX55

  location_using_placemark:
    sub_thoroughfare: 1
    thoroughfare: ATT Way
    locality: Bedminster
    administrative_area: NJ
    postal_code: 07921-2694

Demands

A demand can be satisfied by using candidates drawn from inventories. Each demand is uniquely named. Inventory is considered to be opaque and can represent anything from which candidates can be drawn.

A demand's resource requirements are determined by asking an inventory provider for one or more sets of inventory candidates against which the demand will be made. An explicit set of candidates may also be declared, for example, if the only candidates for a demand are predetermined.

Demand criteria is dependent upon the inventory provider in use.

...


| Key | Value | |-----------------------------|----------------------------| | iso_country_code | The abbreviated country name associated with the placemark. | | postal_code | The postal code associated with the placemark. | | administrative_area | The state or province associated with the placemark. | | sub_administrative_area | Additional administrative area information for the placemark. | | locality | The city associated with the placemark. | | sub_locality | Additional city-level information for the placemark. | | thoroughfare | The street address associated with the placemark. | | sub_thoroughfare | Additional street-level information for the placemark. |

Questions

  • What geocoder can we use to convert placemarks to a latitude/longitude?

Examples

The following examples illustrate a location expressed in coordinate, host_name, CLLI, and placemark, respectively.

locations:
  location_using_coordinates:
    latitude: 32.897480
    longitude: -97.040443

  host_location_using_host_name:
    host_name: USESTCDLLSTX55ANZ123

  location_using_clli:
    clli_code: DLLSTX55

  location_using_placemark:
    sub_thoroughfare: 1
    thoroughfare: ATT Way
    locality: Bedminster
    administrative_area: NJ
    postal_code: 07921-2694

Demands

A demand can be satisfied by using candidates drawn from inventories. Each demand is uniquely named. Inventory is considered to be opaque and can represent anything from which candidates can be drawn.

A demand's resource requirements are determined by asking an inventory provider for one or more sets of inventory candidates against which the demand will be made. An explicit set of candidates may also be declared, for example, if the only candidates for a demand are predetermined.

Demand criteria is dependent upon the inventory provider in use.

Provider-agnostic Schema

KeyValue
inventory_provider A HAS-supported inventory provider.
inventory_typeThe reserved word cloud (for cloud regions) or the reserved word service (for existing service instances). Exactly one inventory type may be specified.
attributes (Optional)A list of key-value pairs, that is used to select inventory candidates that match all the specified attributes. The key should be a uniquely identifiable attribute at the inventory provider.
service_type (Optional)If inventory_type is service, a list of one or more provider-defined service types. If only one service type is specified, it may appear without list markers ([]).
service_id (Optional)If inventory_type is service, a list of one or more provider-defined service ids. If only one service id is specified, it may appear without list markers ([]).
default_cost (Optional)The default cost of an inventory candidate, expressed as currency. This must be specified if the inventory provider may not always return a cost.
required_candidates (Optional)A list of one or more candidates from which a solution will be explored. Must be a valid candidate as described in the candidate schema.
excluded_candidates (Optional)A list of one or more candidates that should be excluded from the search space. Must be a valid candidate as described in the candidate schema.
existing_placement (Optional)The current placement for the demand. Must be a valid candidate as described in the candidate schema.


| Key | Value | |------------------------|--------------------------| | inventory_provider | A HAS-supported inventory provider. | | inventory_type | The reserved word cloud (for cloud regions) or the reserved word service (for existing service instances). Exactly one inventory type may be specified. | | attributes (Optional) | A list of key-value pairs, that is used to select inventory candidates that match all the specified attributes. The key should be a uniquely identifiable attribute at the inventory provider. | | service_type (Optional) | If inventory_type is service, a list of one or more provider-defined service types. If only one service type is specified, it may appear without list markers ([]). | | service_id (Optional) | If inventory_type is service, a list of one or more provider-defined service ids. If only one service id is specified, it may appear without list markers ([]). | | default_cost (Optional) | The default cost of an inventory candidate, expressed as currency. This must be specified if the inventory provider may not always return a cost. | | required_candidates (Optional) | A list of one or more candidates from which a solution will be explored. Must be a valid candidate as described in the candidate schema. | | excluded_candidates (Optional) | A list of one or more candidates that should be excluded from the search space. Must be a valid candidate as described in the candidate schema. | | existing_placement (Optional) | The current placement for the demand. Must be a valid candidate as described in the candidate schema. |

...