Changelog for 66

In 0.8.0.0

Adaptation to oblibs 0.3.1.0

Synthesized Release Notes

Nearing the End of Breaking Changes: This release marks a major step towards the end of planned breaking changes for version 66. Version 0.7.0.0 introduced stability in the directory hierarchy of the 66 ecosystem, and version 0.8.0.0 solidified the stability of frontend file keys. While the implementation of events may happen in version 0.9.0.0, this can potentially occur without breaking existing 66 components(see roadmap).
Introduction of Snapshot Command: A new snapshot command has been added, offering a comprehensive backup solution for the 66 ecosystem. This feature guarantees that you can restore the exact state of the ecosystem before any changes. It also enables the replication of ecosystems across different hosts to maintain consistent states and behaviors. Importantly, using snapshots does not alter the state of running services.
Transparent Upgrade Process: The release includes a new upgrade process that is fully transparent to the user. Whether a migration involves changes to the resolve file or other components, 66 automatically detects version upgrades and makes the necessary adjustments, ensuring continuity with the new version. This process does not affect the state of running services, and an automatic snapshot is created during the migration to facilitate easy recovery if needed.

New features

New keys for Input/Output redirection (StdIn, StdOut, StdErr) have been added to control the behavior of standard input, output, and error, respectively.
A new 66 snapshot command allows users to create, remove, list, and restore snapshots, providing enhanced backup and reliability management.
An automatic migration process is now available, ensuring seamless upgrades. This process is completely transparent to the user and is triggered by any 66 command following an upgrade of the 66 program.

Frontend files

Key Name Formatting Changes: The @ prefix in key names has been removed, and key names now start with a capital letter. Additionally, the - character has been removed from composite names and also replaced by a capital letter. 66 will automatically migrate the frontend files present on your system, but this will only apply to active services(i.e., those listed when running 66 tree status with the field contents). You may need to manually translate your own frontend files.

To help with this, use the script below by running: ./migration_service.sh /path/to/my/<FrontendFile>

#!/bin/sh

service="${1}"

sed -e "s:\[main\]:\[Main\]:g" \
    -e "s:@type:Type:g" \
    -e "s:@description:Description:g" \
    -e "s:@version:Version:g" \
    -e "s:@depends:Depends:g" \
    -e "s:@requiredby:RequiredBy:g" \
    -e "s:@optsdepends:OptsDepends:g" \
    -e "s:@options:Options:g" \
    -e "s:@flags:Flags:g" \
    -e "s:@notify:Notify:g" \
    -e "s:@user:User:g" \
    -e "s:@timeout-kill:TimeoutStart:g" \
    -e "s:@timeout-up:TimeoutStart:g" \
    -e "s:@timeout-finish:TimeoutStop:g" \
    -e "s:@timeout-down:TimeoutStop:g" \
    -e "s:@maxdeath:MaxDeath:g" \
    -e "s:@down-signal:DownSignal:g" \
    -e "s:@hiercopy:CopyFrom:g" \
    -e "s:@intree:InTree:g" \
    -e "s:\[start\]:\[Start\]:g" \
    -e "s:@build:Build:g" \
    -e "s:@runas:RunAs:g" \
    -e "s:@execute:Execute:g" \
    -e "s:\[stop\]:\[Stop\]:g" \
    -e "s:\[logger\]:\[Logger\]:g" \
    -e "s:@destination:Destination:g" \
    -e "s:@backup:Backup:g" \
    -e "s:@maxsize:MaxSize:g" \
    -e "s:@timestamp:Timestamp:g" \
    -e "s:\[environment\]:\[Environment\]:g" \
    -e "s:\[regex\]:\[Regex\]:g" \
    -e "s:@configure:Configure:g" \
    -e "s:@directories:Directories:g" \
    -e "s:@files:Files:g" \
    -e "s:@infiles:InFiles:g" \
    -i ${service}

See Rosetta Stone for the list of keyword name changes.

Behavior enhancements

The 66 status command now provides an overview of all system services, organized by tree, when no specific service is specified.
The Identifier feature has been expanded: in addition to @I, 66 now recognizes seven new identifiers to facilitate the creation of more generic frontend files.
Module configuration: Two more news variables are exported at execution time of the configure script called MOD_ENVIRONMENT_ADMDIR= and MOD_ENVIRONMENT_USERDIR=.
The 66 remove command is designed to always succeed, ensuring that no service becomes impossible to remove.

Deprecated and Obsolete keywords

The deprecated key @shebang has been completely removed and is no longer recognized by the parser.

The Destination key (previously @destination) in the [Logger] section is now deprecated and replaced by new StdIn, StdOut, and StdErr keywords. For compatibility, the parser will automatically handle the conversion.

Removal of Deprecated Options:

For the disable command: -F, -R options are removed.
For the parse command: -F, -C,-c,-m` options are removed.
For the stop command: -X, -K options are removed.

Bug Fixes

Command line-defined timeouts now take precedence.
Do not create finish script if section [Stop] doesn't exist.
Proper handling of errno during signal reception.
Fixed the resolution of the source frontend file in a module's resolve file for a service.
Prevented crashes when encountering an empty field in a seed file.
Corrected parsing errors when an unknown key is found at the end of the frontend file.
The 66 tree status command now only displays services associated with a specific tree.
Fixed behavior of the -l option at execl-envfile program.
Always deal with logger at disable time.

In 0.7.2.1

Bugs fix:
- Respect the VERBOSITY during the whole boot process.
- Fix importation of the kernel command line environment variables.
- Fix order of precedence for the build of the environment variable used during the whole boot process.

In 0.7.2.0

Adapt to oblibs 0.3.0.1`
Bugs fix:
- Logger destination directory for a oneshot or logger destination directory for a service inside a module are now properly deleted at remove subcommand invocation.
- Allow empty modules.
- Respect the associated tree of a service at enable process time if it were already enabled.
Behavior changes:
- The -s and -c options to the configure subcommand are now mutually exclusive.
- Service inside module cannot be reconfigured alone. The whole module must be reconfigured instead.
- To be consistent between subcommand, the scandir reload subcommand was renamed to scandir reconfigure. The old subcommand invocation still work.
- The configuration directory used to build a module is not kept anymore after a parse process. A temporary is used instead.
New features:
- The contains of the or for root and regular user respectively is imported by default at scandir start command invocation. Although this can be changed at compile time by passing the --with-sysadmin-environment=DIR, --with-user-environment=DIR for root and regular user respectively
Enhancement:
- Avoid to crash at unsupervise process with a corrupted service. This allows to avoid to be stuck at remove command invocation for a corrupted service or a corrupted state service within module.
- Avoid to crash at stop process if the service is already unsupervised.
- Earn rapidity at unsupervise process by sending only one signal for all services to the fdholder service.
- Use temporary directory for the creation of a the module configuration directories.
- Complete review of the struct enum ecosystem and passing from an O(n*m) algorithm to O(1). This also serves as preparation for future releases that will include new sections and key fields.

In 0.7.1.1

Bugs fix:
- corrected environment computation and string cleanup from the frontend key.
- fixed the value of the intree key.
- ensured sufficient space for renaming interdependencies.
- fixed the use of parse_list functions, even in the case of multiple lines.

In 0.7.1.0

Adapt to oblibs 0.3.0.0
Bugs fix:
- make exclusive -s and -c options at configure command.
- respect -s option for edition at configure command.
- provide wall command documentation. This command was added from 0.7.0.0 tag but the documentation wasn't.
- fix closing string at parse time.
- typo fix.
Complete review of the execl-envfile program. Adapting it to the new lexer and environ familly functions make it faster and easier to debug and use less HEAP memory.
Remove deprecated env key of the @options field.

In 0.7.0.2

Hot fix:
- Always build the graph with the service associated to a module.

In 0.7.0.1

Bug fix:
- Fix buffer overflow at tree administration
- Typo fix

In 0.7.0.0

Adaptation to skalibs 2.14.1.0
Adaptation to execline 2.9.4.0
Adaptation to s6 2.12.0.3
Adaptation to oblibs 0.2.1.0

This release marks a significant rewrite of 66, introducing a new UI and serving as a comprehensive service supervision suite and independent service manager.

Primarily, expect no compatibility with previous versions due to:

The removal of s6-rc support. 66 is now a complete independent service management based on s6 for init and service supervision.
A complete overhaul of the folder structure for storage and runtime directories, simplifying it considerably.
An overhaul of tree behavior. Trees now function as services, and a complete tree dependency graph has been implemented.
Services can now depend on each other regardless of whether the service is declared on the same tree or the declaration order of the tree. For instance, if service Sb depends on service Sa and Sa is within TreeB while service Sb is within TreeA, and TreeB depends on TreeA, launching TreeA will start Sa even if TreeB isn't started first. When TreeB is executed, Sb will find Sa already started and commence directly.

For UI changes, frontend file convertion and clean of the 66 architecture, a Rosetta stone is available.

Frontend Files

New fields have been added:

@requiredby: Specifies which service is required-by another service. For example, if service Sa declares service Sb as required-by Sa's dependency, Sb won't start until Sa does. This allows building complex graph structures without modifying every frontend file of each service.
@earlier: Declares any service as an earlier one, starting as soon as the scandir is running, similar to tty12. This field is mandatory for services intended to start earlier.
@intree: Specifies the tree to use at enable/start time.

The following field has been removed:

@extdepends: No longer necessary as services can depend on any service regardless of the tree used.

Frontend files for regular account must be now localized at /usr/share/66/service/user, /etc/66/service/user or ${HOME}/.66/service.

Behavioral changes:

@options:
- pipeline: This option was removed. It was only present for s6-rc.
- env: This option was removed. The simple declaration of the [environment] section is sufficient to activate the options.
@shebang: Deprecated but kept for compatibility reasons. Declare your shebang directly within the @execute field. Refers to frontend documentation for futhers information.
@build: Not mandatory anymore, as it will be declared 'auto' by default.
@addservices: This options was removed from the [regex] section.

The classic type now accepts the fields @depends and @requiredby. The classic type replaces the longrun type.

Logger destinations for oneshot type services can now be declared on a tmpfs directory, particularly useful during boot time.

Services can be started without being enabled first. In this case, the service won't start on the next reboot.

The bundle and longrun types have been removed, replaced by classic, oneshot, and module types. For compatibility reasons, if your old frontend file declares the service as a longrun type, the parser will convert it to a classic type automatically. No automatic conversion is made for services of type bundle.

[Environment] Section

This section now allows reusing the same variable from the actual environment. For instance:

socket_name=!/run/dbus/system_bus_socket
cmd_args=!--system --address=unix:path=${socket_name}
PATH=/usr/local/bin:${PATH}

The order of key-value pair declaration doesn't matter:

cmd_args=!--system --address=unix:path=${socket_name}
socket_name=!/run/dbus/system_bus_socket

Variable name must be between ${} to get it value. For instance, $var is not replaced by its value.

Double-quote within value must be escaped with backslash \. Refers to the updated documentation of execl-envfile for futhers information.

Module Changes

The module directory structure has been completely redesigned for better intuitiveness and comprehensiveness. Expect no compatibility with the previous version; a rewrite is required if you use module on your system.

A module cannot contain another module; instead, you can declare it as a dependency via @depends or @requiredby. These can also be specified through the configure module script.

Refer to the specific module page for furthers information.

Trees

Trees now react as services regarding graph dependencies. You can declare a tree depending on or required-by others.

A default named global tree is provided. Services without their localization defined or users not specifying a tree to use will be defined within that tree.

A seed file can be provided for automatic tree configuration at creation time. For example, it defines depends/requiredby dependencies of the tree.

If a service declares a non-existing tree, the tree will be created automatically with a default configuration, but without any depends/requiredby dependencies. To configure the tree with specific requirements at creation time, provide and install seed file with your service.

Configure Script

Removed flags: - --with-system-module=DIR - --with-sysadmin-module=DIR - --with-user-module=DIR

Added flags: - --with-default-tree-name=NAME - --max-path-size=KB - --max-service-size=KB - --max-tree-name-size=KB - --with-system-seed=DIR - --with-sysadmin-seed=DIR - --with-user-seed=DIR

The slashpackage convention was removed.

Skeleton files

The skeleton files shudown, reboot, poweroff and halt are removed and replaced by 66 reboot, 66 poweroff, 66 halt command respectively.

Code Changes

The code has been largely rewritten and simplified, offering more features with approximately the same number of code lines. Additionally, the code now uses less HEAP memory, although this optimization is ongoing.

The parser was completely rewritten and heavily optimized, significantly reducing the time to parse a service(by three times).

The start process was rewritten due to the removal of s6-rc. Oblibs now provide general functions to build any Acyclic graph.

The code for the module part was revamped and greatly simplified.

In 0.6.2.0

WARNING: 66-update is no longer compatible with 66 version under 0.5.0.0.
Adapt to skalibs 2.11.0.0
Adapt to execline 2.8.1.0
Adapt to s6 2.11.0.0
Adapt to s6-rc 0.5.2.3
Adapt to oblibs 0.1.4.0

In 0.6.1.3

Adapt to skalibs 2.10.0.3.
Adapt to execline 2.8.0.1.
Adapt to s6 2.10.0.3.
Adapt to s6-rc 0.5.2.2.
Bugs Fix:
- 66-boot: fix call of 66-scandir -c option.
- configure script: fix installation of skel/init.conf file.
Configure script: remove the slashpackage convention.

In 0.6.1.2

Bugs fix:
- Avoid segmentation fault if 66-init is used without arguments. Thanks Timothy Murphy.
- Fix the build of man pages.
- Documentation fix.
66-env:
- Bug fix:
  - Create the user configuration file at -r option if it doesn't exist yet.
  - Fix -c option.
66-inservice
- Do not output warn message from upstream configuration file at contents display.
- Bug fix:
  - Respect the number passed by -p options.

In 0.6.1.1

Bugs fix:
- remove the exclamation mark from variable at module parse time before passing it to the script configure

In 0.6.1.0

Bugs fix:
- Avoid to crash if no tree is enabled yet.
- Documentation fix.
- Handle correctly the return value of s6_rc_servicedir_manage.
- Fix 66-all command at s6-svscan control file of a regular user scandir creation.
- Handle correctly a same(or commented) key=value pair on multiple service configuration file.
execl-envfile:
- new option:
  - -v: allows verbosity changes.
- Bug fix:
  - Handle correctly a same(or commented) key=value pair on multiple service configuration file.
66-env:
- new option:
  - -e editor: Allows to choose the editor to use for the edition of the configuration file.

In 0.6.0.1

Bugs fix:
- Respect variables value from kernel command line.
- Fix release number at 66-upgrade.html file.
- Fix string lenght at regex replacement time.

In 0.6.0.0

Adapt to skalibs 2.10.0.0
Adapt to execline 2.7.0.0
Adapt to s6 2.10.0.0
Adapt to s6-rc 0.5.2.1
Adapt to oblibs 0.1.2.0
Bugs fix:
- 66-tee -c: check if backup is empty.
- parse_module: avoid infinite loop at dependencies resolution on sub-module.
- 66-disable: do not crash if the service is not enabled at state check.
- execl-envfile: fix parse process for a configuration file.
66-disable:
- new options:
  - -R: removes configuration files and logger directory of the service. So, no components of the service is kept.
66-env:
- -r can be passed multiple time
66-tree:
- -U option is now deprecated and passed to 66-all.
66-all:
- new argument:
  - unsupervise: unsupervise all services of a tree. This argument replace the 66-tree -U command.
66-inservice:
- It displays the absolute path of the file at Environment file field.
- The -c option is now no longer available.
66-update:
- the -c option is now no longer available.
66-env:
- the -d option is now no longer available.
66-enable:
- the -c|m|C|i is now deprecated. The configuration file is handled automatically (see Service configuration file for further information.)
- -I: new options to avoid the copy of a modified configuration file.
66-parser:
- deprecated the -c|m|C to follow changes about the 66-enable tool.
66-scandir: the interface change.
- The owner argument is now an option(-o) and the arguments are create|remove.
- The up option is passed to 66-scanctl.
- The -e option is passed to 66-scanctl.
- New options:
  - -B: specifies to create a scandir for a container. In this case, a /run/66/scandir/container/halt file is created(see 66-boot for further information).
  - -c: do not set the catch-all logger.
skeleton file: (see 66-boot for further information).
- init.conf:
  - New variables:
    - CONTAINER: specifies to boot inside a container.
    - RCINIT_CONTAINER: absolute path to the init file used to boot inside a container.
    - CATCHLOG: create or not the catch-all logger.
  - Variable removed:
    - ISHELL.
- rc.init.container: file used in case of boot inside a container.
- ishell: not longer available.
66-scanctl: the interface change.
- arguments signal are now: start|stop|reload|nuke|zombies.
- New options: this two options are only valid for a start signal.
  - -d: file descriptor to use for readiness notification.
  - -t: perform a scan every rescan milliseconds.
66-boot:
- New option:
  - -z: to use color
66-shutdownd:
- swicth -B and -C (which is renamed to -c) to be consistent with the 66-scandir tool.
frontend:
- nosetsid value at @flags key is deprecated and have no effects if it defined.
- new format for the @options key:
  - log: the logger is automatically created even if the value log is not set. If you don't want a logger at all prefix the value log with an exclamation mark as it: !log.
  - env: if the environment section is defined, the env value is not mandatory. Also, the old behavior is always valid: if the env value is set, the [envrionment] must be set.
html documentation: documentation is now versionned.
New tool:
- 66-nuke: this tool is a strict copy of the [s6-linux-init-nuke] (https://skarnet.org/software/s6-linux-init/s6-linux-init-nuke.html) tool.

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