This documentation gives rules for the naming convention of interconnected devices involved in a control system, 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) | facility/group/experiment | funtionality/family/type | sequential(3digit) |
---|---|---|---|
use lower case, no underscore (use dash instead).
Prefix
The prefix is 2 digit is used to quickly determine the network element type. In bold prefixes already used.
Prefix | Description |
---|---|
vl | Virtual Linux machine/server/cpu |
pl | Physical Linux machine/server/cpu |
vw | Virtual Windows |
pw | Physical Windows |
sw | switch |
il | ilo |
mv | motor controller |
cc | camera |
sc | serial converter (i.e moxa) |
gd | generic device (termother, sensors) |
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 |
ns | storage device (nas) |
dd | DAQ Device |
da | DAC Device |
facility/group/experiment
This field should give indication of the logic location/group/experiment 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, dafne,flame , cg (Control Group), eg ( Electronic Group : Selced)
Funtionality/family/type
This field should give additional information on the object functionality/family/type. In bold functionality/family/type already used.
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 |
dbn | Generic no-SQL |
dbs | Generic SQL |
mysql | mysql/mariadb |
mongo | MongoDB |
grafana | grafana |
bpm | Beam Position Monitor |
ctr | Control (current in use in BTF) |
mon | Monitoring, similar to grafana, but generic - (current in use) |
dev | Devil - (current in use) |
co | Console Control Room - (current in use) |
pc | Personal Computer |
rad | Device for Radio Protection |
dom | Domain (domain started by the Xen hypervisor on boot) - (used but usable for Hypervisor or Containers host machines) |
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 |
---|---|
bpm | beam position monitor |
cam | camera |
temp | thermometer |
... | |
... | |
..... |
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 pwfismelrad001 ## a physical windows machine of fismel for radio protection
5 Comments
Alessandro D'Uffizi
Jul 17, 2023Mi sembra buono. Cosa sarebbe comunque hactr ?
Riccardo Gargana
Jul 18, 2023La Naming Convention scritta da Andrea, deriva da una vecchia mia idea in cui i campi erano fissati, nello specifico il group era composto da 5 digit, quindi essendo btf piu corto con Luca abbiamo aggiunto la zona del tipo ha (hall/Sala), quindi sarebbe stato btfha (btf hall). Nella mia anche il campo Funtionality/family/type era fissato a 3 digit, ma abbiamo, quasi, deciso di lasciarlo variabile. CTR nello specifico sta per control, macchina abbastanza generica usata per il controllo di btf
Alessandro Stecchi
Jul 18, 2023Francesco Galletti
Oct 24, 2023Nel facility/group/experiment e' possibile aggiungere "cg" = "control group"? Servirebbe a coprire tutti i dispositivi (a nostro carico) intercambiabili fra le varie facility. Es. ICP-DAS lo possiamo montare sia du DAFNE che su SPARC etc. etc.
Francesco Galletti
Oct 30, 2023Aggiunto "dd" = "DAQ Device" nella sezione nei Prefix e "cg" = "Control Group" nella sezione facility/group/experiment.