The pid1 package

[ Tags: library, mit, program, system ] [ Propose Tags ]

Please see README.md or view Haddocks at https://www.stackage.org/package/pid1


[Skip to Readme]

Properties

Versions 0.1.0.0, 0.1.0.1, 0.1.1.0, 0.1.2.0
Change log ChangeLog.md
Dependencies base (>=4.6 && <5), directory, pid1, process (>=1.2), unix [details]
License MIT
Copyright 2016 Michael Snoyman
Author Michael Snoyman
Maintainer michael@snoyman.com
Category System
Home page https://github.com/fpco/pid1#readme
Source repository head: git clone https://github.com/fpco/pid1
Uploaded Thu Jul 13 15:47:34 UTC 2017 by MichaelSnoyman
Updated Fri Jul 14 14:08:13 UTC 2017 by HerbertValerioRiedel to revision 1
Distributions Arch:0.1.2.0, LTSHaskell:0.1.2.0, NixOS:0.1.2.0, Stackage:0.1.2.0, Tumbleweed:0.1.2.0
Executables pid1
Downloads 1796 total (153 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2017-07-13 [all 1 reports]
Hackage Matrix CI

Modules

[Index]

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for pid1-0.1.2.0

[back to package description]

pid1

Build Status

Do signal handling and orphan reaping for Unix PID1 init processes.

This provides a Haskell library, and an executable based on that library, for initializing signal handlers, spawning and child process, and reaping orphan processes. These are the responsibilities that must be fulfilled by the initial process in a Unix system, and in particular comes up when running Docker containers.

This library/executable will automatically detect if it is run as some process besides PID1 and, if so, use a straightforward exec system call instead.

NOTE This package is decidedly not portable, and will not work on Windows. If you have a use case where you think it makes sense to run on Windows, I'd be interested in hearing about it.

For a discussion on why this is useful, see this repo.

Usage

pid1 [-e|--env ENV] [-u|--user USER] [-g|--group GROUP] [-w|--workdir DIR] [-t|--timeout TIMEOUT] COMMAND [ARG1 ARG2 ... ARGN]

Where:

  • -e, --env ENV - Override environment variable from given name=value pair. Can be specified multiple times to set multiple environment variables.
  • -u, --user USER - The username the process will setuid before executing COMMAND
  • -g, --group GROUP - The group name the process will setgid before executing COMMAND
  • -w, --workdir DIR - chdir to DIR before executing COMMAND
  • -t, --timeout TIMEOUT - timeout (in seconds) to wait for all child processes to exit

The recommended use case for this executable is to embed it in a Docker image. Assuming you've placed it at /sbin/pid1, the two commonly recommended usages are:

  1. Override the entrypoint, either via ENTRYPOINT in your Dockerfile or --entrypoint on the command line.

    docker run --rm --entrypoint /sbin/pid1 fpco/pid1 ps
    
  2. Add /sbin/pid1 to the beginning of your command.

    docker run --rm --entrypoint /usr/bin/env fpco/pid1 /sbin/pid1 ps