diff --git a/admin-guide/guidelines.rst b/admin-guide/guidelines.rst index 9bc51418..37d3748c 100644 --- a/admin-guide/guidelines.rst +++ b/admin-guide/guidelines.rst @@ -1,11 +1,6 @@ Guidelines ========== -.. toctree:: - :maxdepth: 1 - - guidelines/conventions - Version Control --------------- @@ -51,6 +46,7 @@ has to avoid as much as possible dependency from external services availability. A WAN outage or a remote http server failure should not influence the installation system. For this reason, all the external code is mirrored internally in specific git repositories. + Servers and services -------------------- @@ -66,5 +62,26 @@ Development Workflow The general inspiration comes from `this post `_. -Regarding the puppet code this is more detailed description of our current -workflow: + +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``. diff --git a/admin-guide/guidelines/conventions.rst b/admin-guide/guidelines/conventions.rst deleted file mode 100644 index ad2fefa7..00000000 --- a/admin-guide/guidelines/conventions.rst +++ /dev/null @@ -1,26 +0,0 @@ -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``. -