Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pull] master from 64kramsystem:master #14

Merged
merged 3 commits into from
Nov 23, 2021
Merged

[pull] master from 64kramsystem:master #14

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a793bd6
README: "Stability" section: Add types of errors
64kramsystem Nov 22, 2021
f026173
README: Add "Project status" section
64kramsystem Nov 22, 2021
f602cbb
Merge pull request #253 from 64kramsystem/update_maintenance_status
64kramsystem Nov 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

ZFS installer is a shell script program that fully prepares ZFS on a system, and allows an effortless installation of several Debian-based operating systems using their standard installer (or debootstrap, or any custom script).

- [Project status](#project-status)
- [Requirements and functionality](#requirements-and-functionality)
- [Comparison with Ubuntu built-in installer](#comparison-with-ubuntu-built-in-installer)
- [Instructions](#instructions)
Expand All @@ -14,6 +15,16 @@ ZFS installer is a shell script program that fully prepares ZFS on a system, and
- [Help](#help)
- [Credits](#credits)

## Project status

The project is in passive maintenance: I accept PRs but not issues, and I may apply minor changes on an irregular basis. Issues and discussions will be deactivated from Mon 29/Nov.

PR are always welcome! 😄 I guarantee quick feedback.

The reason for the discontinuation of the active maintenance is that O/S installers don't have stable specifications (see the [stability section](#stability)), and I don't have the resources to investigate breakages.

Supported distros may or may not work; I only guarantee support for Ubuntu Desktop LTS versions, since it's the distribution I use.

## Requirements and functionality

The program currently supports:
Expand Down Expand Up @@ -73,7 +84,13 @@ The project is carefully developed, however, it's practically impossible to guar
1. automated testing is not feasible; although debootstrap installations could be automated, the bulk of the work is related to the installers, which can't be automated without sophisticated GUI automation,
1. testing is time consuming, so it can be performed on a limited amount of distros at a time.

Errors due to installer will cause the script to terminate, so, generally speaking, if the script completes, the system has been successfully setup.
Broadly speaking, there are two types of breakages:

1. minor changes directly or indirectly related to the installer, for example:
- partition mounts change behavior (e.g. when they're dismounted)
- installed services change behavior (e.g. a new service creates an ephemeral file under /target/run, and the sync fails because the file disappears)
1. GRUB setup not working
- most annoying issue to debug; the installer will succeed, but the installed O/S won't boot

## Demo

Expand Down