27 lines
969 B
ReStructuredText
27 lines
969 B
ReStructuredText
Conventions
|
|
===========
|
|
|
|
Naming convention for servers
|
|
-----------------------------
|
|
|
|
Server names have the form ``lx-purpose-[0-9][0-9].psi.ch``, where
|
|
``purpose`` is the purpose of the server or the service provided by it. Examples are:
|
|
|
|
- ``lx-boot-01.psi.ch`` is the **boot** server
|
|
|
|
The production server always has an DNS alias `purpose.psi.ch` and clients should always use this alias to connect to the server.
|
|
|
|
When putting system names into configuration files, we always use lower case and
|
|
the fully qualified domain name. Good: ``boot.psi.ch``.
|
|
|
|
|
|
Names for programs
|
|
------------------
|
|
|
|
The general conventions regarding filenames apply (see `File system hierarchy
|
|
and filenames`_). In addition, scripts should not include a suffix indicating
|
|
the language they are written in. The latter is an implementation detail and
|
|
does not matter to the caller of the script/program. A good name could be
|
|
``pli-system-info``, a bad one would be ``pli-system-info.sh``.
|
|
|