https://github.com/bergerx/simplelxc

Main objective of this project is to create a running lxc as simple as "aptitude install simplelxc" and then "simplelxc create lxcname"
https://github.com/bergerx/simplelxc

Last synced: 27 days ago
JSON representation

Main objective of this project is to create a running lxc as simple as "aptitude install simplelxc" and then "simplelxc create lxcname"

• Host: GitHub
• URL: https://github.com/bergerx/simplelxc
• Owner: bergerx
• Created: 2012-01-09T14:24:54.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2012-02-28T02:28:22.000Z (almost 13 years ago)
• Last Synced: 2023-03-20T10:32:15.843Z (almost 2 years ago)
• Language: Shell
• Homepage:
• Size: 284 KB
• Stars: 9
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
=========

simplelxc

=========

-------------------------------------

Create a running LXC guest in minutes

-------------------------------------

:Author: Bekir Dogan 

:Date:   2012-01-23

:Copyright: GPLv2

:Version: 0.1

:Manual section: 1

:Manual group: simplelxc

SYNOPSIS

========

  *simplelxc  ...*

  *simplelxc template  ...*

DESCRIPTION

===========

Create new lxc servers on a machine (only Debian for now) as simple as this::

 $ sudo apt-get install simplelxc # install

 $ sudo simplelxc create test1 # create a guest (default wheezy) and run

 $ sudo simplelxc enter test1 # directly login to the guest as root

Main objective is to make testing of any program easy on personal computers

(for now it works only for Debian systems) without losing time for these:

 * does not require to manually configure networking on host system,

 * does not require to manually create template,

 * does not require to manually determining IP addresses,

 * does not require to manually configuring any other parameters needed.

Just install simplelxc, create a guest and go.

Main purpose of this project is to handle only simple tasks, so if you want to

manage production lxc installation you should consider using plain lxc

userspace control tool (http://lxc.sourceforge.net/) or projects like lxctl

(http://lxc.tl/).

OPTIONS

=======

Command line reference

Guest actions

-------------

Guest system operations, you can explicitly use "guest" parameter before action

name.

:simplelxc  `list`:

    List all available guests.

:simplelxc `create`  [] []:

    Create a guest system and immediately run it. If IP is omitted use the

    first unused address in given block in NETWORK configuration parameter. If

    template_name is omitted use default template in configuration file.

:simplelxc `copy`   []:

    Create a new guest from an existing guest by finding and changing IP

    address and host name to their new values.

:simplelxc `enter` :

    Enter to the guest system as root. This uses SSH to login to the

    guest lxc system using pre-shared keys (public key of host

    system). See NOTES.

:simplelxc `start` :

    Start the guest. Usually you don't need to run the guest manually, they

    start immediately after create.

:simplelxc `stop` :

    Stop the guest.

:simplelxc `restart` :

    Restart the guest system, this is usually required after you configure guest

    system.

:simplelxc `destroy` :

    Delete the guest without any warning. Be careful using this command.

:simplelxc `config` :

    Edit lxc config file of the guest. If you are not sure about what are you

    doing don't change this file.

:simplelxc `chroot` :

    Chroot into the guest root file system, if you are not sure about what you

    are doing you should use "enter". See the notes in "`template chroot`".

:simplelxc `info` :

    Show guest's IP, root file system, config file and if it is running or not.

Template actions

----------------

Typically you don't need to run these manually. Template's are only root file

systems with hostname as hostname- and IP address as 127.0.0.2.

When creating a guest, we just replace this two with original values of the

guest system.

:simplelxc `template list`:

    List all available templates.

:simplelxc `template create` [ []]:

    Create a new release from the given Debian release. If Debian release is

    omitted use given default template name in the simplelxc config. If

    template_name parameter is also omitted use given default template name.

:simplelxc `template copy`  :

    Create a new template from an existing template. Just copies the directory.

:simplelxc `template chroot` :

    Chroot into the template, you can modify template using this action. After

    issuing this action you will be in the templates directory structure but

    there is no abstraction for processes and proc and mount not issued in this

    environment. You can return back by "exit" command. But after installing

    any service in the chroot environment Debian immediately runs the service,

    you should stop the service before exit.

:simplelxc `template destroy` :

    Completely remove the template.

CONFIGURATION

=============

:/etc/simplelxc:

    Configuration file for simplelxc.

EXAMPLE

=======

Some simple scenarios

Testing a new package

---------------------

Testing your brand new package in a whole clean installation.

Testing without hesitation

--------------------------

If you need to compile and test a package but package doesn't supply an uninstall

functionality, what if you don't want that package after installation.

Temporary installations

-----------------------

For example you need a webserver with a LAMP installation with phpmyadmin::

 user@host:~$ sudo simplelxc create phpmyadmin

 user@host:~$ sudo simplelxc enter phpmyadmin

 root@pma:~# apt-get -y install mysql-server # give an mysql root password

 root@pma:~# apt-get -y install phpmyadmin # installs apache2, php5 and phpmyadmin, answer questions

 root@pma:~# cp /etc/phpmyadmin/apache.conf /etc/apache2/sites-available/phpmyadmin

 root@pma:~# a2ensite phpmyadmin

 root@pma:~# service apache2 reload

 root@pma:~# exit

 user@host:~$ sudo simplelxc info phpmyadmin # learn guest IP address: $guestip

 From browser open: http://<$guestip>/phpmyadmin

Takes nearly 10 minutes if you already have a guest before (so you should have

a template before). If that's your second guest like this, this time decreases

because no need to re-download packages from the archives.

NOTES

=====

`simplelxc`\(1) installs openssh-server and put the host systems key to any lxc

guest by default. This is needed because there is no reliable way to lxc attach

any process into the guest system.

SEE ALSO

========

* `lxc`\(1)

* `simplelxc` 

.. To generate a man page from this file: rst2man --strict README simplelxc.1

.. To generate an html page from this file: rst2html --strict README README.html