Naming environment

From Grid5000
Jump to: navigation, search

A common naming convention for the environments to make the understanding of their content easier for everybody.

Note: this convention applies for the environments made by the Grid'5000 staff for users, so it is not a requirement for the environments made by users.

Contents

Environment

The goal of finding a good name is to quickly know what the environment contains by just looking at its name. This name must be as short as possible to make it easy to type, when using Kadeploy for instance.

To clearly show what represents the environment, its name is composed of 4 part:

Note: when registering the environment into the database of kaenvironments, you must preserve the four parts that compose the name of the environment for everybody talking on the same thing when problems occur.

Distribution release

First thing mentioned in the environment name is the distribution on which this environment is based and more specifically the release of this distribution used. The distribution release name used corresponds to the naming convention used by the distribution.

Debian

For Debian-based environment, release code name is used because every Debian users knows these codes well. Some examples:

Fedora

For Fedora-based environment, project name plus release number is used because it is the common way to name these release (ie. people do not know the related code name well for this distribution). Some examples:

Note: the word Core does not occur here, because the Fedora Project dropped it since its 7th release.

Ubuntu

For Ubuntu-based environment, project name plus release date is used because it is the common way to name these release (ie. people do not know well the related code name yet). Some examples:

Architecture

Architecture represents the CPU family for which the environment was made. One environment made for Grid'5000 match one of the following architecture:

Family

Family expresses the software and configuration content of the environment. Each of the following environment are based on the one mentioned right above.

base

The minimal software and configuration to deploy on any Grid'5000 hardware.

nfs

Adds the LDAP login and the NFS home directory mount.

big

Adds a lot of software packages to cover the major usages.

ref

Adds more software and configuration specific of the current Grid'5000 site.

Version

Version is composed of a major number and a minor number. These numbers reflect the services offered in the environment, the version of the software they contained, etc. Version allows to track the evolution, the bug correction of an environment. Minor number incrementation means bug fixes, software upgrade. Major number incrementation means adding new softwares or new services.

Image archive

The way to name the image archive of an environment is to use the name of this environment and add the file suffix of the archive. For instance:

sid-x64-base-1.0.tgz

Postinstall archive

The way to name the postinstall archive of an environment is to use the name of this environment and add -post, to distinguish image archive from postinstall archive, plus the file suffix of the archive. For instance:

sid-x64-base-1.0-post.tgz

Related wiki page

The way to name the wiki page related to an environment is to use the name of this environment. For instance:

Sid-x64-base-1.0
Personal tools
Namespaces

Variants
Actions
Public Portal
Users Portal
Admin portal
Wiki special pages
Toolbox