{
"info": {
"author": "Tom Lazar",
"author_email": "tom@tomster.org",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 4 - Beta",
"Environment :: Console",
"Intended Audience :: System Administrators",
"License :: OSI Approved :: BSD License",
"Operating System :: POSIX :: BSD :: FreeBSD",
"Programming Language :: Python",
"Topic :: System :: Systems Administration"
],
"description": "``ezjail-remote`` is a 'remote control' and convenience wrapper for the ``ezjail-admin`` command of the most excellent `ezjail `_ tool (which in turn is itself a convenience wrapper for `jails `_, `FreeBSD `_'s leight-weight virtualization solution).\n\nIts main features are:\n\n * more sophisticated support for flavours, i.e. interactive configuration and/or templating as opposed to ezjail's hardcoded flavours\n * you can ssh into jails created by ``ezjail-remote`` immediately upon creation (no more manual mucking about with sshd config or uploading your public key!)\n * unlike ``ezjail-admin``, ``ezjail-remote`` is not installed on the jail host, but on your local machine. This means *it doesn't introduce any further dependencies on the jail host whatsoever* (ezjail itself purposefully limits itself to ``sh``).\n\n..note: In general ezjail-remote tries to keep up with ezjail development, so unless stated otherwise, it requires (and by default also installs) the latest version of ezjail (version 3.2.2 as of this writing).\n\nUsage\n=====\n\nezjail-remote uses the `fabric `_ library to remotely run its tasks. Basically it provides a so-called *fabfile* that contains all of the commands of ``ezjail-admin``.\n\nThis means that its usage differs slightly from that of ``ezjail-admin``. In particular, you provide the hostname of the jail server via the ``-H`` switch and the parameters for the command (such as the name of the jail etc) separated with a colon, like so::\n\n ezjail-remote -H host(s) :param1,param2,param3\n\nor::\n\n ezjail-remote -H host(s) :param1=foo,param3=bar\n\nSee the `full documentation of what fabric has to offer here `_.\n\nIn particualar, you can...\n\n * run ``ezjail-remote --help`` to see a list of the available *options*\n * run ``ezjail-remote -l`` to see a list of the available *commands*\n * run ``ezjail-remote -d COMMAND`` to see a detailed description of a command\n\nAs a side effect of using fabric, you can run ezjail-admin commands against multiple jailhosts at the same time.\n\nBootstrapping\n=============\n\nezjail-remote doesn't only make it easy to create and manage jails, it also helps you set up a jailhost environment from scratch. This is done with the ``bootstrap`` and ``install`` commands.\n\nTo successfully run the bootstrap command the following requirements need to be met on the host:\n\n * sshd is up and running\n * ssh login for root is (temporarily) enabled\n * currently we also require an internet connection (to install ezjail) but this will eventually be replaced with uploading a copy of ezjail.\n\nFor example (logged in as root on the console)::\n\n echo 'PermitRootLogin yes' >> /etc/ssh/sshd_config\n echo 'ifconfig_em0=DHCP' >> /etc/rc.conf\n passwd # give yourself a TEMP_PASSWORD\n dhclient em0 # note the IP_ADDR you get\n /etc/rc.d/sshd onestart\n\n\nNow you can run the bootstrap command using the temporary password you gave yourself::\n\n ezjail-remote -H IP_ADDR bootstrap\n\nThis \n\n * disables root login\n * permanently enables SSH for the jail host (and limits it to the primary IP address)\n * creates an admin user with your username and public SSH key\n\n..note: Before installing ezjail with the ``install`` command you may want to set up additional things, such as ZFS pools, network interface aliases, etc.\n\nTo install ezjail you can use the ``install`` command, which either installs it from the ports or from CVS (for the brave)::\n\n ezjail-remote -H IP_ADDR install\n\nIf you want to use a CVS snapshot::\n\n ezjail-remote -H IP_ADDR install:source=cvs\n\nIf you want to use ZFS (and you should!) supply the pool it should use via the jailzfs parameter::\n\n ezjail-remote -H IP_ADDR install:jailzfs='jails/ezjail'\n\n\nCommands\n========\n\nIn its simplest form, ezjail remote offers the exact same commands as ezjail-admin, namely ``[archive|config|console|create|delete|install|list|restore|start|stop|update]``. In addition to that it provides enhanced versions of ``create`` and ``destroy`` (the latter a more thorough variant of the ``delete`` command.)\n\ncreate\n------\n\ncreates a new jail instance on the given host, creates an admin user with sudo privileges and enables ssh access via public key.\n\nafter setting up the jail it attempts to execute a method named ``setup`` from ``ezjailremote.flavours.``, passing on all parameters, including any additional, arbitrary keyword arguments.\n\nparameters\n**********\n\nname\n name of the new jail, *required*\n\nIP\n the IP address, *required*\n\nadmin\n name of the admin user for the jail, defaults to the current user. the user will be created and added to ``wheel`` (which in turn will be allowed to sudo without password).\n\nkeyfile\n public key to install for the admin user, defaults to ``~/.ssh/identity.pub``.\n\nflavour\n the name of the local flavour, defaults to ``basic``.\n\nctype\n defaults to None and refers to the `-c` flag, meaning, you can set it to `simple`, `bde`, `eli` or `zfs`.\n\n\ndestroy\n-------\n\nstops, removes and deletes the given jail instance (but not before asking you one last time, explicitely). however, once you confirm, the jail is irrevocably *gone*.\n\nparameters\n**********\n\nname\n name of the new jail, *required*\n\nInstallation\n============\n\nSimply use easy_install::\n\n easy_install ezjail-remote\n\nDevelopment\n===========\n\nTo develop ezjail-remote itself, check out a copy of this repository and then::\n\n virtualenv . --no-site-package\n ./bin/python setup.py develop\n\nTODO\n====\n\n * document flavour development\n * use a base class for flavours\n * list them (with their docstr) with ezjail-remote list-flavours\n * allow chaining/nesting/stacking of flavours (i.e. always include basic)\n\nChange history\n==============\n\n0.2.2 - 2013-05-03\n------------------\n\n * Use ezjail version 3.2.2 feature to create ZFS jails by default\n * Make use and configuration of sshd in created jail optional\n * Various smaller bugfixes\n * officially out of alpha :)\n\n0.2.1 - 2012-09-10\n------------------\n\n * add support for creating ZFS (and other image based) jails\n\n0.2 - 2012-09-07\n----------------\n\n * split installation into ``bootstrap`` (which has proven itself useful outside of a ezjail setup) and ``install``\n * added support for ZFS\n * can install ezjail from CVS\n * added support for flavours outside the ezjail-remote package itself (using namespace packages for ezjailremote.flavours.\\*)\n * added `start`, `stop` and `jls` commands.\n\n0.1 - 2011-07-29\n----------------\n\nInitial release. Provides 'pass through' of all commands, as well as enhanced versions for ``create`` and ``destroy``.",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/tomster/ezjail-remote",
"keywords": "ezjail,FreeBSD,fabric",
"license": "BSD",
"maintainer": null,
"maintainer_email": null,
"name": "ezjailremote",
"package_url": "https://pypi.org/project/ezjailremote/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/ezjailremote/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/tomster/ezjail-remote"
},
"release_url": "https://pypi.org/project/ezjailremote/0.2.2/",
"requires_dist": null,
"requires_python": null,
"summary": "a remote control and convenience wrapper for ezjail",
"version": "0.2.2"
},
"last_serial": 791838,
"releases": {
"0.1": [
{
"comment_text": "",
"digests": {
"md5": "091baee6992fc5799cc5ae0880ce78ee",
"sha256": "bfbb970599a5cd6645a4f90cc474bcb52b1e1cc22a4be9c9fdaa14531984a9cb"
},
"downloads": -1,
"filename": "ezjailremote-0.1.zip",
"has_sig": false,
"md5_digest": "091baee6992fc5799cc5ae0880ce78ee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11744,
"upload_time": "2011-07-29T12:27:04",
"url": "https://files.pythonhosted.org/packages/22/8f/a31c1d0d82b011e6752688560d1993c23afc4622543d354f2b19cc06fd26/ezjailremote-0.1.zip"
}
],
"0.2": [
{
"comment_text": "",
"digests": {
"md5": "82086ec254bdb2b3e9871c0d873203e8",
"sha256": "a4b9d4d4dae0e8fffb40fa164db77e980b7ba72909c10b8ebaa4eb609e22c0b2"
},
"downloads": -1,
"filename": "ezjailremote-0.2.zip",
"has_sig": false,
"md5_digest": "82086ec254bdb2b3e9871c0d873203e8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21313,
"upload_time": "2012-09-07T13:55:54",
"url": "https://files.pythonhosted.org/packages/cb/7d/de3fb23deecde8256028399583b5087a1b3d375925e5c211b67acdff9509/ezjailremote-0.2.zip"
}
],
"0.2.1": [
{
"comment_text": "",
"digests": {
"md5": "f43fa2faa76bef61780f6d19676eba69",
"sha256": "059962ddb8b1bbd41ca91e2542982454919cfaaf2c1bb5da12bd5905ad5c3c88"
},
"downloads": -1,
"filename": "ezjailremote-0.2.1.zip",
"has_sig": false,
"md5_digest": "f43fa2faa76bef61780f6d19676eba69",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 21777,
"upload_time": "2012-09-10T15:13:33",
"url": "https://files.pythonhosted.org/packages/c4/f2/a21ba5b4062f935a83d7803a25620f67cd55c46462509b257210eb6b296c/ezjailremote-0.2.1.zip"
}
],
"0.2.2": [
{
"comment_text": "",
"digests": {
"md5": "dad16a7a77d10f1533c3438fd3f7ca92",
"sha256": "3d8a4f178f85f8357c92c78b4ed6956fbd640556cac9a2e6689f27cfa2658faa"
},
"downloads": -1,
"filename": "ezjailremote-0.2.2.zip",
"has_sig": false,
"md5_digest": "dad16a7a77d10f1533c3438fd3f7ca92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23036,
"upload_time": "2013-05-03T12:56:52",
"url": "https://files.pythonhosted.org/packages/07/44/d6e6f41f0abc7987145075fc511bd8223812352c625f966af4ab3a1c741f/ezjailremote-0.2.2.zip"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "dad16a7a77d10f1533c3438fd3f7ca92",
"sha256": "3d8a4f178f85f8357c92c78b4ed6956fbd640556cac9a2e6689f27cfa2658faa"
},
"downloads": -1,
"filename": "ezjailremote-0.2.2.zip",
"has_sig": false,
"md5_digest": "dad16a7a77d10f1533c3438fd3f7ca92",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23036,
"upload_time": "2013-05-03T12:56:52",
"url": "https://files.pythonhosted.org/packages/07/44/d6e6f41f0abc7987145075fc511bd8223812352c625f966af4ab3a1c741f/ezjailremote-0.2.2.zip"
}
]
}