thodg/cl-unix-cybernetics/README.md

• Show log

  Commit

• Hash : 8f7fbd0a
  Author : Thomas de Grivel
  Date : 2022-03-28T20:11:38
  

  license

Download

  $ sbcl --eval '(repo:install :adams)'

  $ cd ~/common-lisp/cl-adams/adams
  $ make
  $ sudo cp build/adams /usr/local/bin/adams

  ;;  Adams
  (add-to-list 'auto-mode-alist '("\\.adams\\'" . lisp-mode))

  #!/usr/local/bin/adams --script

  (resource 'host "adams.kmx.io"
            :user "adams"
            (resource 'user "adams"
                      :shell "/bin/sh"
                      :ensure :present))

  (with-host "adams.kmx.io"
    (sync *host*))

  $ chmod 755 tutorial.adams
  $ ./tutorial.adams

  ;; Thomas de Grivel (kmx.io)
  (resource 'group "dx"
            :gid 19256
            :ensure :present)
  (resource 'user "dx"
            :uid 19256
            :gid 19256
            :home "/home/dx"
            :ensure :present)

  #!/usr/local/bin/adams --script

  (resource 'host "adams.kmx.io"
            :user "adams"
            (resource 'user "adams"
                      :shell "/bin/sh"
                      :ensure :present)
            #.(include "user/dx"))

  (with-host "adams.kmx.io"
    (sync *host*))

Source

• README.md

• Adams 0.3.2
  ===========
  
  Adams is a UNIX system administration tool written in Common Lisp.
  
  You describe your systems (hosts) using resources having properties.
  
  The properties are then probed and synchronized by Adams using only
  `/bin/sh` on the remote host, and `/usr/bin/ssh` on the control host.
  
  
  Configuration example
  ---------------------
  
  Check out
  <https://github.com/kmx-io/kmx-io/>
  for a detailed example of Adams usage.
  
  
  Current status
  --------------
  
  Adams is currently able to use a local shell or connect to remote hosts
  via ssh.
  
  Adams is this hardcore hacker using only `/bin/sh` commands.
  This makes `ksh` and `bash` suitable shells for adams as they are
  compatible with `/bin/sh`.
  
  Supported resource types :
   - Host (hostname)
   - User (useradd, usermod, userdel)
   - Group (groupadd, groupmod, groupdel)
   - File (owner, group, permissions, content)
   - Directory (owner, group, permissions)
   - Package (Debian, OpenBSD)
  
  
  Security design
  ---------------
  
  You should only allow Adams what you would allow your system operators :
    - a shell accessible through SSH using a public key
    - apropriate sudo permissions
  
  All commands issued to the remote hosts can be logged.
  
  Adams does not grant the hosts access to its workstation while it works.
  Adams does not grant access to data belonging to any host.
  Adams does not send any data that is not of direct concern to the host.
  In short, all UNIX permissions are respected, Adams is a regular UNIX user.
  
  
  Usage
  -----
  
  
  ### 1. Install [repo](https://github.com/common-lisp-repo/repo).
  
  
  ### 2. Fetch adams sources.
  
  ``` shell
    $ sbcl --eval '(repo:install :adams)'
  ```
  
  
  ### 3. Build and install the `adams` binary
  
  ``` shell
    $ cd ~/common-lisp/cl-adams/adams
    $ make
    $ sudo cp build/adams /usr/local/bin/adams
  ```
  
  
  ### 4. Configure emacs (optional)
  
  In your `~/.emacs` file :
  ``` emacs-lisp
    ;;  Adams
    (add-to-list 'auto-mode-alist '("\\.adams\\'" . lisp-mode))
  ```
  
  
  ### 5. Write some resources in a `.adams` script
  
  In the `tutorial.adams` file :
  ``` common-lisp
    #!/usr/local/bin/adams --script
  
    (resource 'host "adams.kmx.io"
              :user "adams"
              (resource 'user "adams"
                        :shell "/bin/sh"
                        :ensure :present))
  
    (with-host "adams.kmx.io"
      (sync *host*))
  ```
  
  
  ### 6. Profit.
  
  ``` shell
    $ chmod 755 tutorial.adams
    $ ./tutorial.adams
  ```
  
  The `tutorial.adams` script will synchronize the host "adams.kmx.io"
  according to the resource specifications given in the file.
  
  
  ### 7. DRY up your scripts using `#.(include "file")`
  
  In the `user/dx.adams` file :
  ``` common-lisp
    ;; Thomas de Grivel (kmx.io)
    (resource 'group "dx"
              :gid 19256
              :ensure :present)
    (resource 'user "dx"
              :uid 19256
              :gid 19256
              :home "/home/dx"
              :ensure :present)
  ```
  
  In your main script :
  ``` common-lisp
    #!/usr/local/bin/adams --script
  
    (resource 'host "adams.kmx.io"
              :user "adams"
              (resource 'user "adams"
                        :shell "/bin/sh"
                        :ensure :present)
              #.(include "user/dx"))
  
    (with-host "adams.kmx.io"
      (sync *host*))
  ```
  
  
  [License](LICENSE.md)
  ---------------------
  
  
  Contribute
  ----------
  
  To contribute, fork this repository and send us a pull request.
  
  Please publish under the
  [ISC License](https://en.wikipedia.org/wiki/ISC_license)
  terms.
  
  
  Authors
  -------
  
  Thomas de Grivel <thoxdg@gmail.com>
  

Download