docs/dev-manual/gitlab.rst

   1 GitLab
   2 ======
   3
   4 |Gromacs| is transitioning to GitLab for source code management, issue tracking,
   5 and integrated automation for testing and documentation.
   6
   7 The repository contains DockerFiles and GitLab Runner configuration
   8 files to support automated testing and documentation builds.
   9 General information on configuring GitLab CI pipelines can be found
  10 in the official `Gitlab documentation <https://docs.gitlab.com/ee/ci/yaml/>`_.
  11
  12 The GitLab CI configuration entry point is the :file:`.gitlab-ci.yml` file
  13 at the root of the source tree.
  14 Configuration templates are found in the files in the
  15 :file:`admin/ci-templates/` directory.
  16
  17 Docker images used by GitLab Runner are available on `Docker Hub <https://hub.docker.com/u/gromacs>`__.
  18 Images are (re)built manually from DockerFiles in :file:`admin/dockerfiles`.
  19
  20 This documentation is incomplete, pending resolution of :issue:`3275`.
  21
  22 ..  todo:: Expand this documentation to resolve :issue:`3275`
  23
  24 Pipeline execution
  25 ------------------
  26
  27 .. todo:: Discuss the distinct characteristics of |Gromacs| CI pipelines to relevant to job configuration.
  28
  29 .. todo:: Comment on the number of pipelines that can be or which are likely to be running at the same time.
  30
  31 Configuration files
  32 ~~~~~~~~~~~~~~~~~~~
  33
  34 At the root of the repository, :file:`.gitlab-ci.yml` defines the stages and
  35 some default parameters, then includes files from :file:`admin/gitlab-ci/` to
  36 define jobs to be executed in the pipelines.
  37
  38 Note that job names beginning with a period (``.``) are
  39 `"hidden" <https://docs.gitlab.com/ee/ci/yaml/#hidden-keys-jobs>`_.
  40 Such jobs are not directly eligible to run, but may be used as templates
  41 via the `*extends* job property <https://docs.gitlab.com/ee/ci/yaml/#extends>`_.
  42
  43 Job parameters
  44 ~~~~~~~~~~~~~~
  45
  46 Refer to https://docs.gitlab.com/ee/ci/yaml for complete documentation on
  47 GitLab CI job parameters, but note the following GROMACS-specific conventions.
  48
  49 .. glossary::
  50
  51     before_script
  52         Used by several of our templates to prepend shell commands to
  53         a job *script* parameter.
  54         Avoid using *before-script* directly, and be cautious
  55         about nested *extends* overriding multiple *before_script* definitions.
  56
  57     cache
  58         There is no global default, but jobs that build software will likely
  59         set *cache*. To explicitly unset *cache* directives, specify a job
  60         parameter of ``cache: {}``.
  61         Refer to `GitLab docs <https://docs.gitlab.com/ee/ci/yaml/#cache>`__
  62         for details. In particular, note the details of cache identity according
  63         to `cache:key <https://docs.gitlab.com/ee/ci/yaml/#cachekey>`__
  64
  65     image
  66         Part of the tool chain configuration. Instead of setting *image*
  67         directly, *extend* a *.use_<toolchain>* template from
  68         :file:`admin/gitlab-ci/global.gitlab-ci.yml`
  69
  70     variables
  71         Many job definitions will add or override keys in *variables*.
  72         Refer to `GitLab <https://docs.gitlab.com/ee/ci/yaml/#variables>`__
  73         for details of the merging behavior. Refer to :ref:`variables` for local usage.
  74
  75 Global templates
  76 ~~~~~~~~~~~~~~~~
  77
  78 In addition to the templates in the main job definition files,
  79 common "mix-in" functionality and behavioral templates are defined in
  80 :file:`admin/gitlab-ci/global.gitlab-ci.yml`.
  81
  82 Jobs beginning with ``.use-`` provide mix-in behavior, such as boilerplate for
  83 jobs using a particular tool chain.
  84
  85 Jobs beginning with a `parameter <https://docs.gitlab.com/ee/ci/yaml>`__
  86 name allow parameters to be set in a single place for common job characteristics.
  87 If providing more than a default parameter value, the job name should be suffixed
  88 by a meaningful descriptor and documented within
  89 :file:`admin/gitlab-ci/global.gitlab-ci.yml`
  90
  91 Job names
  92 ~~~~~~~~~
  93
  94 Job names should
  95
  96 1. Indicate the purpose of the job.
  97 2. Indicate relationships between multi-stage tasks.
  98 3. Distinguish jobs in the same stage.
  99 4. Distinguish job definitions throughout the configuration.
 100
 101 Jobs may be reassigned to different stages over time, so including the stage
 102 name in the job name is not helpful, generally. If tags like "pre" and "post,"
 103 or "build" and "test" are necessary to distinguish phases of, say, "webpage,"
 104 then such tags can be buried at the end of the job name.
 105
 106 Stylistically, it is helpful to use delimiters like ``:`` to distinguish the
 107 basic job name from qualifiers or details. Also consider
 108 `grouping jobs <https://docs.gitlab.com/ee/ci/pipelines/index.html#grouping-jobs>`__
 109
 110 .. _variables:
 111
 112 Variables
 113 ~~~~~~~~~
 114
 115 The GitLab CI framework, GitLab Runner, plugins, and our own scripts set and
 116 use several `variables <https://docs.gitlab.com/ee/ci/variables/README.html>`__.
 117
 118 Default values are available from the ``.variables:default`` definition in
 119 :file:`admin/gitlab-ci/global.gitlab-ci.yml`.
 120 Many of the mix-in / template jobs provide additional or overriding definitions.
 121 Other variables may be set when making final job definitions.
 122
 123 Variables may control the behvior of GitLab-CI (those beginning with ``CI_``),
 124 GitLab Runner and supporting infrastructure, or may be used by job definitions,
 125 or passed along to the environment of executed commands.
 126
 127 *variables* keys beginning with ``KUBERNETES_`` relate to the GitLab Runner
 128 `Kubernets executor <https://docs.gitlab.com/runner/executors/kubernetes.html#the-kubernetes-executor>`__
 129
 130 Other important variable keys are as follows.
 131
 132 .. glossary::
 133     COMPILER_MAJOR_VERSION
 134         Integer version number provided by toolchain mix-in for convenience and
 135         internal use.
 136
 137     CMAKE_COMPILER_SCRIPT
 138         CMake command line options for a tool chain. A definition is provided by
 139         the mix-in toolchain definitions (e.g. ``.use-gcc8``) to be appended to
 140         :command:`cmake` calls in a job's *script*.
 141
 142     CMAKE_MPI_OPTIONS
 143         Provide CMake command line arguments to define GROMACS MPI build options.
 144
 145     EXTRA_INSTALLS
 146         List additional OS package requirements. Used in *before_script* for some
 147         mix-in job definitions to install additional software dependencies. If
 148         using such a job with *extends*, override this variable key with a
 149         space-delimited list of packages (default: ``""``). Consider proposing a
 150         patch to the base Docker images to include the dependency to reduce
 151         pipeline execution time.
 152
 153 .. todo:: Define common variables.
 154     ``BUILD_DIR``, ``INSTALL_DIR``, ``CACHE_FALLBACK_KEY``, ...