|
1 |
| -# Jidoteki virtual appliance & live image administration |
| 1 | +# On-Prem virtual appliance & live image administration |
2 | 2 |
|
3 |
| -[](https://jidoteki.com) |
| 3 | +[](https://on-premises.com) [](https://travis-ci.org/on-prem/jidoteki-admin) [](https://github.com/aw/picolisp-semver) [](https://github.com/aw/picolisp-json) [](https://github.com/aw/picolisp-unit.git) |
4 | 4 |
|
5 |
| -[Jidoteki](https://jidoteki.com) installs the `Jidoteki Admin` package in `/opt/jidoteki`. |
| 5 | +[On-Prem](https://on-premises.com) installs the `On-Prem Admin` package in `/opt/jidoteki`. |
6 | 6 |
|
7 | 7 | This repository contains bash scripts, ansible roles, and other files needed to perform remote virtual appliance or live image administration, updates, etc.
|
8 | 8 |
|
9 |
| -## Requirements |
| 9 | +# Requirements |
10 | 10 |
|
11 | 11 | * Ansible 1.5.x
|
12 | 12 | * curl
|
| 13 | +* git |
13 | 14 | * sha1sum (from core-utils)
|
14 |
| -* [symlinktool](https://github.com/aw/tinycore-symlinktool) for running backups |
| 15 | +* [symlinktool](https://github.com/on-prem/tinycore-symlinktool) for running backups |
15 | 16 | * [openssl](https://openssl.org/) v1.0.2+, for validating TLS certs
|
16 | 17 | * [stunnel](https://www.stunnel.org) for validating TLS certs
|
17 | 18 |
|
18 |
| -## Ansible roles |
| 19 | +# Usage |
19 | 20 |
|
20 |
| -There is 1 role executed: |
| 21 | +``` |
| 22 | +# replace <destdir> with the directory prefix to install the files |
| 23 | +ansible-playbook jidoteki.yml -c local -i images.inventory -e prefix=<destdir> --tags=admin |
| 24 | +``` |
21 | 25 |
|
22 |
| - - admin |
| 26 | +### tags |
23 | 27 |
|
24 |
| -### admin role |
| 28 | +There exist two `tags` for running the ansible roles: |
| 29 | + |
| 30 | + - **admin**: executes every task in the role, installing all On-Prem Admin scripts |
| 31 | + - **lib**: only executes tasks related to the lib dependencies, without the On-Prem Admin scripts |
25 | 32 |
|
26 |
| -The `admin` configures directories and files in `/opt/jidoteki/admin` or `/opt/jidoteki/tinyadmin`. |
| 33 | +### admin role |
27 | 34 |
|
28 |
| -Here is what the `admin` role does: |
| 35 | +The `admin` role configures directories and files in `/opt/jidoteki/tinyadmin`: |
29 | 36 |
|
30 | 37 | * Create admin directory structure
|
31 | 38 | * Create admin directories writeable by root/admin
|
32 | 39 | * Create admin sftp uploads directory
|
33 | 40 | * Add SSH admin management scripts
|
34 | 41 | * Add SSH admin wrapper script
|
| 42 | + * Add SSH admin lib dependencies |
| 43 | + |
| 44 | +# Tests |
| 45 | + |
| 46 | +To run the tests, type `make check` |
35 | 47 |
|
36 | 48 | # Changelog
|
37 | 49 |
|
|
0 commit comments