EnOS Tutorial on top of Grid'5000

[rcherrueau]

Tutorial is index.org. It is an org mode file written to:

• Produce the tutorial as an rst file for the EnOS documentation. To generate the rst file, load the ox-rst.el' file from https://github.com/msnoigrs/ox-rst into emacs. Then do,C-c C-e r r' or M-x org-rst-export-to-rst'. The rst file will be available underenos/docs/tutorial/index.rst'. Caution: the remove of line references in source blocks (i.e., -r') doesn't work with ox-rst.el'. We have to remove them manually in the index.rst'. The following emacs-lisp command does the job. Executes it withC-c C-c'.

  ,----
  |   (find-file "index.rst")
  |   (with-current-buffer "index.rst"
  |     (goto-char (point-min))
  |     (while (re-search-forward "(ref:.+?)" nil t)
  |       (replace-match ""))
  |     (save-buffer))
  `----

• Produce bash scripts to test the tutorial. To generate the bash scripts and yaml configuration file do C-c C-v t' or M-x org-babel-tangle'. The bash script and configuration files will be available under `enos/tests/functionnal/tests/tutorial/'.

To export, clean line refs, and tangle code execute the following elisp code.

,----
| (org-babel-tangle)
| (load-file "~/.emacs.d/private/ox-rst.el")
| (require 'ox-rst)
| (org-rst-export-to-rst)
| (find-file "index.rst")
| (with-current-buffer "index.rst"
|   (goto-char (point-min))
|   (while (re-search-forward "(ref:.+?)" nil t)
|     (replace-match ""))
|   (save-buffer))
`----

See *Appendix > ** How to export this tutorial

[rcherrueau]

I added a commit to prepare the next version of the TP. I bet for stable/rocky and pip install "enos[openstack]==5.0.0. And I added an Emacs function to automatically update the TP. See my commit message.

To update the TP when a new version of EnOS appears, change in the
following the values of `new-os-version' and `new-enos-install' with the
value of the next release. Then executes the code with `C-c C-c'.

See * Appendix > ** Update with a new version of EnOS

,----
| (let ((cur-os-version "stable/rocky")
|       (new-os-version "stable/rocky")
|       (cur-enos-install "pip install \"enos[openstack]==5.0.0\"")
|       (new-enos-install "pip install \"enos[openstack]==5.0.0\""))
|   (defun enos/update-tuto (cur-version new-version)
|     (with-current-buffer (current-buffer)
|       (goto-char (point-min))
|       (while (search-forward cur-version nil t)
|         (replace-match new-version))
|       (save-buffer)))
|   (enos/update-tuto cur-os-version new-os-version)
|   (enos/update-tuto cur-enos-install new-enos-install))
`----