This documentation gives rules for the naming convention of interconnected devices, in particular the DNS name of servers/cpu/console and networked instrumentation.
This documentation follows Eupraxia-PM-QA-0020-NamingConvention.pdf and integrates pre-existent conventions with some simplification to be more suitable to be used as DNS
Format
The format is the following
| prefix(2digit) | zone/group | funtionality/family/type | sequential(3digit) |
|---|---|---|---|
Prefix
The prefix is 2 digit is used to quickly determine the network element type.
| Prefix | Description |
|---|---|
| vl | Virtual Linux machine/server/cpu |
| pl | Physical Linux machine/server/cpu |
| vw | Virtual Windows |
| pw | Physical Linux |
| dl | Docker Linux |
| dw | Docker Windows |
| sw | switch |
| il | ilo |
| mv | motor controller |
| cc | camera |
| sc | serial converter (i.e moxa) |
| dc | digital converter |
| ac | analog converter |
| io | generic i/o device |
| os | oscilloscope |
| ps | power supply |
| bd | Beam instrumentation |
| fd | Fluid device controllers |
| rd | RF device |
| vd | Vacuum device |
| qd | Cryogenic device |
| un | undulator device |
| sd | Safety device, Radioprotection, Access System Convetional sagety |
..... |
Zone/group
This field should give indication of the logic location/group where the device is located or to what group/experiment it belongs. Note that networked elements may change the physical position so specify an exact position/location must be carefully evaluated.
Examples
sparc, btf, tex, dcs, dafne... can be good for devices in the control of the facilities.
Funtionality/family/type
This field should give additional information on the object functionality/family/type.
This information is up to the owner, but should recall the functionality of the object.
Examples
Often a machine/docker/device has a particular functionality. Specify the functionality is the preferred extension that we use:
funtionality | Description |
|---|---|
| mem | Memory Cache generic (memcached/couchbase) |
| couch | Memory Cache (couchbase) |
| db | Generic Database |
| influx | InfluxDB |
| sql | Generic SQL |
| mysql | mysql/mariadb |
| mongo | MongoDB |
| grafana | grafana |
| ... | |
| bpm | Beam Position Monitor |
..... |
Often an object is instead identified by its the commercial name:
family/type | Description |
|---|---|
| moxa | For moxa ethernet to serial converters |
| icpdas | For ADC/DAC converters |
| nuc | For CPUs used mainly for consoles |
| libera | For beam position monitor |
| ... | |
..... |
Often an object is instead identified by its functionality:
family/type | Description |
|---|---|
| moxa | For moxa ethernet to serial converters |
| icpdas | For ADC/DAC converters |
| nuc | For CPUs used mainly for consoles |
| ... | |
| ... | |
..... |
Examples
vldantemem001 ## a good example of a memcached server on a virtual linux machine for the DanteControSystem plsparcmem001 ## a good example of a memcached server on a physical linux machine serving sparc bdsparcbpm001 ## a generic bpm in sparc vwbtfhactr005 ## a virtual windows server in btf