Snippets Groups Projects

4 years ago
8ec73200

html documentation is now versionned · 8ec73200
Eric Vidal authored 4 years ago

8ec73200

History

html documentation is now versionned
Eric Vidal authored 4 years ago

upgrade.md 18.90 KiB

title: The 66 Suite: upgrade author: Eric Vidal eric@obarun.org

Changelog for 66

Upgrade/downgrade instructions

Warning From the version v0.5.0.0 this procedure is no longer mandatory even on major release. 66-update can now be consider as a convenient tool to rebuild your tree automatically instead of doing it manually.

Upgrading/downgrading between major versions may require the use of the 66 tool 66-update. In each case the release note will specify it. To update, first upgrade/downgrade the 66 package. Then make a dry-run using the -d option of the 66-update tool:

# 66-update -d

You should not have any error messages before going further. If you get an error message, please fix it first. If you do not have any idea of what to do to fix the issue, reverse your previous installation and consider asking for help on the 66 mailing list.

The dry-run option -d does not change anything on your system, you need to really update your system:

# 66-update

This same process and command use needs to be done by (or as) each regular user.

See the 66-update documentation page for further information.

In 0.5.1.0

Bugs fix:
- Avoid to parse twice a service coming from a service of type module.
66-disable: new options: - -F: forces the service to be disabled even if it's already marked disabled. See the 66-disable documentation page for further information.

In 0.5.0.1

Bugs fix:
- Handle old service format where the version directory doesn't exist. This is last release handling this case.
- 66-tree: Remove the live tree state directory in any case even if the directory is empty.

In 0.5.0.0

This is a Major release, you need to update your trees with 66-update tool. If you skip from a version earlier than 0.4.0.1, the 66-update will not work. In this case, you need to reconstruct your trees manually. Downgrading to a previous version will not work either, due to the new format of the resolve inner files.

Adapt to oblibs v0.1.0.0
Pass the writing of the resolve files to a CDB format. From that point onward the 66-update will no longer be mandatory, even after major version release.
Adapt 66-update to the new CDB format where applicable.
Bugs fix:
- Write the dependencies of the contents file for a module in the proper order as to avoid multiple repeated names.
- 66-update:
  - Get the correct exit status at tree contents process.
  - Fix segmentation fault when a crash occur at enable time.
- Compilation configure script improvements and bugs fix.
- Fix the location of the modules directory service at enable time. The place of the module frontend file determines the place of the result process for the service module directory.
- Fix the creation of the logger directory when field @build is not set.
- Fix -r signal and -R signal behavior at 66-start tool.
The rc.init skeleton file does not launch the ISHELL script anymore during a crash at stage2. It's the responsability of the sysadmin to deal with this error at his convenience.
@destination field in section [logger] is no longer mandatory at the use of @build with value custom.
66-env:
- -e is now the default option.
- -L displays now all key=value pair from all files found at the configuration directory. new options:
  - -c: changes the current symlink to the specified version.
  - -V: displays available version.
  - -i: import an extra configuration file from one version to another.
  - -s: handle a specific version for command -L|V|e|r.
All key=value pairs from init.conf skeleton file can be now passed to the kernel command line. Also, variables from init.conf are now passed to the rc.init skeleton file as arguments.
@version field is now mandatory.
The version symlink of the configuration file points now to the configuration directory instead of the configuration file. This allows overwriting a same key=value with the writing of an extra configuration file instead of changing the upstream file.
66-in{resolve,state}: field Real logger name name is renamed Real_logger_name.
66-enable:
- Allow the use of a different version of a configuration file than the frontend service file, if any of -c/m/C options are used. new option:
  - -i: import extra configuration files from a previous version.

In 0.4.0.1

Hot fix: @build is no longer mandatory even for [stop] section.

In 0.4.0.0

This is a Major release, you need to update your trees with 66-update tool.

new extra-tools:
- execl-envfile: this tool come from 66-tools software and was incorporated inside the 66 software.
  - It parses now all files found at a directory by alphabetical order.
Documentation is now written in markdown format. Lowdown software it necessary to build in html and manpages format.
Bugs fix:
- 66-update: respect the tree start order.
- 66-tree: fix behavior when we have only one tree enabled.
- 66-inservice: do not crash in case of empty log file.
- Fix reverse dependencies search for a service with type module.
- Respect timestamp format given at compile time for the uncaught-logs.
- Accept empty environment file.
Configuration service files: These files is now automatically versioned in function of the field @version declared on the frontend service file e.g. /etc/66/conf/<service>/version/<file>. A symlink called version is created or updated at /etc/66/conf/<service>/version. This symlink point to the configuration file currently in use. Also, you can now write and save your own configuration file for a service inside the configuration service directory. All files found on that directory will be parsed and exported to the environment of the service at start time. The parse process is made on alphabetical order.
@hiercopy field accept now relative path.
@build field is no longer mandatory. If it not set, auto is the default.
@version field must be in the form digit.digit.digit e.g. 0.10.2.
module service type:
- General code improvement and evolve.
- Add @addservices field at [regex] section.
- Disabling a service contained inside a module is not possible. This break entirely the module operation.
- Sub module directories is no longer mandatory. 66-enable will create it if it doesn't exist.
- 66-enable export some variable environment at configure script runtime-see modules-service documentation page.
- Fix cyclic dependency: a module cannot call it itself.
- Redesign of the inner directories structure: instantiated service service must be define at service@/ sub-directory where other type go to service/ sub-directory. .configure/ is now named configure.
- All configuration files for each service contained inside the module is written inside the versioned directory of the module e.g. /etc/66/conf/<module>/<version>/<service>/<service_version>/file. This allows to have multiple module using a same service with a specific configuration for each service.
66-inresolve: add field Real_exec_run,Real_exec_finish for the service and logger associated to display the exact contain of the run/up and finish/down files respectively.
66-enable: The absolute path of the frontend service can also be set but must contain the primary path of the path define at compile time by --with-system-service or --with-sysadm-service or --with-user-service e.g. /etc/66/service/lamp/httpd.
66-env:
- General code improvement.
- Follow the change about the versioned configuration service file.

In 0.3.0.3

Hot fix: Avoids overwriting the current file

In 0.3.0.2

Fix check and installation of user configuration file directory.
Add missing 66-inresovle and 66-instate* documentation.

In 0.3.0.1

Fix @optsdepends and @extdepends behavior: These two fields now respect correctly the start order of the service's dependencies.
66-inservice change: The field Optional dependencies and External dependencies displays now the name of the tree where the service is currently enabled after the : colon mark if any:
```
External dependencies : dbus-session@obarun:base gvfsd:desktop
Optional dependencies : picom@obarun:desktop
```

In 0.3.0.0

This is a Major release, you need to update your trees with 66-update tool.

Bugs fix
skalibs dependency bumped to 2.9.2.1
exeline dependency bumped to 2.6.0.1
s6 dependency bumped to 2.9.1.0
s6-rc dependency bumped to 0.5.1.2
oblibs dependency bumped to 0.0.6.0
Add -z to all tools to enable colorization:
- 66-in{service,tree} and 66-update tools change the -c option to -z option to be consistent between all tools.
66-start and 66-stop exit 0 instead of 110 if the service is not enabled.
Frontend service file change:
- The field @type accepts a new kind of service called module. A module can be considered as an instantiated service. It works the same way as a service frontend file but allows to configure a set of different kind of services before executing the enable process. Also, the set of the services can be configured with the conjunction of a script called configure which can be written on any language.
- module also comes with a new section named [regex] which contains the following field:
  - @configure
  - @directories
  - @files
  - @infiles
  Please see the frontend documentation for futher information.
- Allow commenting out of a service inside @contents, @depends, @optdepends, @extdepends field with the # character. The service name must begin with a # character without any space between the # and the name of the service, so it can be ignored.
```
@depends = ( foo #bar fooB )
```
- Add @version field: This field is currently not mandatory to allow time to adapt the existing service files on your system, but it will be mandatory in a future release.
- Comments in the [environment] section is now kept at parsing process and written to the final service configuration file. This is useful to explain the use of a variable without the need to look on the executable script.
66-in{service,tree} display now up,down or unintialized on status and graph dependencies field for oneshot, bundle, module services. This allows us to know if e.g an oneshot service is currently up or down.
66-enable now accepts the new option -m. This option reacts the same as the -c option for new key=value pair but overwrites the change of the admin on existing key=value pair. A key=value pair which doesn't exist on the frontend file remains untouched.
Oneshot now accepts the option log at the field @options. This allows a oneshot to have its own logger. As any other service the log file can be seen with the 66-inservice tool. The log destination can be controlled by the @destination field at the [logger] section. Default is set at compile time by the --with-system-log or --with-user-log flag.
New debug tools:
- 66-inresolve: This tool allows to read the contents of the resolve file.
- 66-instate: This tool allows to read the contents of the state file.
--disable-s6-log-notification was added on the configure script to disable logger's readiness notification. By default it use the file descriptor number 3.
--with-s6-log-timestamp flag was added on the configure script to set the default output date format for a logger at the compile time. See configure --help command.
--with-system-module, --with-sysadmin-module, --with-user-module flags was added on the configure script to set the default system, sysadmin and user module directory respectively.
--with-system-script, --with-user-script flags was added on the configure script to set the default system and user script directory respectively.

In 0.2.5.2

Fix build: Remove bytes.h oblibs header file

In 0.2.5.1

Bugs fix
66-tree -S options: if after_tree and tree have the same name, tree is considered as the very first tree to start.
66-unmountall: do not umount SS_LIVE
Add SIGPWR control file at creation of .s6-svscan directory

In 0.2.5.0

Bugs Fix: Bad memory allocation
66-tree: add -S option which allows to order the start tree process even after it creation.

In 0.2.4.1

Hot fix: fix html documentation

In 0.2.4.0

Bugs fix: Bad memory allocation.
Enable again RB_DISABLE_CAD but don't crash if its not available and warn user
- Add @optsdepends and @extdepends field at [main] section:
  - @optsdepends can be considere as: "enable one on this service or none"
  - @extdepends can be considere as: "enable the service if it is not already declared on a tree"
- 66-in{tree,service}:
  - in case of empty value the tools return None
  - add -n option: this avoids to display the name of the field.
  - add field at 66-intree:
    - start: displays the list of tree(s) started before
    - allowed: displays a list of allowed user to use the tree
    - symlinks: displays the target of tree's symlinks
  - add field at 66-inservice:
    - optsdepends: displays the service's optional dependencies
    - extdepends: displays the service's external dependencies
- 66-shutdown skeleton: be safier and check if options are past
- New tool:
  - 66-update: The 66-update program makes a complete transition of trees and the live directory using a old 66 format (the one being replaced) with the new 66 format.

In 0.2.3.2

Fix bad annoucement at 66-svctl
Warn in case of bad key at parenthesis parsing process

In 0.2.3.1

Bugs fix: bad allocation memory
Makefile: remove creation of empty directories. 66-tree will check all directories and create it if it missing.

In 0.2.3.0

Adapt to oblibs 0.0.4.0
Remove RB_DISABLE_CAD at 66-boot by default and allow to enable it with -c option. Starting on virtual system like lxc crash with this option. Well be safe on every case.
Use of new function log_? familly from oblibs:
- standardization of the exit code
- standardization of the verbosity output
- allow verbosity to 4 to display debug message
Doc typo fix

In 0.2.2.2

Adapt to skalibs 2.9.1.0
Remove insta_? deprecated function

In 0.2.2.1

Typo fix at html documentation
Fix 66-intree without options

In 0.2.2.0

Bugs fix: Always check the existing of the 66 heart directories
66-info is now deprecated and splitted into two differents API:
- 66-intree give informations about tree
- 66-inservice give informations about services

In 0.2.1.2

Hot fix: fix 66-info graph display.

In 0.2.1.1

Hot fix: fix the build of the service dependencies graph.

In 0.2.1.0

Bugs fix.
A synchronization is now made on reboot even with force option.
The field @name has no effects except for instantiated service but can be omitted. The name of the frontend file is took as name. In case of instantiated service, the field @name must contain the complete name of the frontend service file -- Refer to the frontend documentation page.
New skeleton file: rc.shutdown.final. This skeleton file will be run at the very end of the shutdown procedure, after all processes have been killed and all filesystems have been unmounted, just before the system is rebooted or the power turned off. This script normally remains empty.
Extra tools has removed and provided as an independent programs at ttps://framagit.org/Obarun/66-tools.git except for 66-echo and 66-unmountall program which are a dependent part of 66.
The account to run the s6-log program at the associate service logger can be set at compilation time by the --with-s6-log-user=USER options. The default is root. Obviously, the @runas field at the [logger] section overwritte it. This options set the account to run the uncaught-logs too. Also, this option can be overwritten with the '-l' option at 66-boot invocation and the '-L' option at 66-scandir invocation.

In 0.2.0.4

Bugs fix on memory allocation
Respect policies decision of user:
- Remove -m option from 66-boot on init file
Add -d feature to 66-scandir

In 0.2.0.3

66-parser: Fix write of configuration file, add -c|C features

In 0.2.0.2

Fix the written of user configuration file
Fix oneshot and bundle status check
Add -l features to 66-tree, rewrite tree_unsupervise function

In 0.2.0.0

New tools:
- 66-boot.
- 66-scanctl.
- 66-shutdown.
- 66-shutdownd.
- 66-hpr.
- 66-env.
- 66-parser.
- 66-which.
- 66-echo.
- 66-unmountall.
- execl-subuidgid.
New @key field and change on frontend file:
- [Logger] section accept a @depends field, @timestamp accept none as value, readiness notification is a default.
- @hiercopy in [main] allow to copy any file or directory coming from the directory of the service.
66-envfile is now deprecated, use execl-envfile in replacement.
66-enable: add -F, -c, -C features.
66-svctl is now asynchrone to launch services.
Man pages are available.
Environment variables limitation: maximum 100 files by directory, each file cannot contain more than 4096 bytes or 50 variables.
Syntax to unexport variable with execl-envfile change: the exclamation mark '!' need to be placed at begin of value instead of key.
Bugs fix

In 0.1.0.1

Bugs fix
Add 66-getenv,66-writenv and 66-gnwenv extra-tools

In 0.1.0.0

Logger for nested tree at scandir creation time is disabled.
Pass graph function to new ss_resolve_graph_? function.
Split resolve file and state flags.
Add ss_state_? function.
Really unsupervise rc service, add rc_manage, rc_unsupervise function.
Fix -U option for 66-tree.
Fix 66-info, add -c option.

In 0.0.2.2

Hot fix, do not stop an empty db.

In 0.0.2.1

Hot fix, do not append inner bundle with empty word.