mirror of https://github.com/YunoHost/ynh-dev.git synced 2024-09-03 20:05:59 +02:00

Alexandre Aubin bb4224b8fb Rework README, integrate notes about LXC from ljf

2018-09-04 02:25:26 +02:00

6.3 KiB

Raw Blame History

ynh-dev - Yunohost dev environnement manager

Report issues here: https://github.com/yunohost/issues

ynh-dev is a CLI tool to manage your local development environement for YunoHost. This allow you to develop on the various repository of the YunoHost project.

In particular, it allows :

to create a directory with a clone of each repository of the YunoHost project ;
to replace already installed yunohost debian packages by symlinks to those git clones ;
to manage yunohost instances on your host machine with Vagrant by:
- creating a Vagrant VM with a pre-installed Yunohost system ;
- sharing the dev environnement your host the VM (so you can develop directly on your host)
- finding the ip address of your yunohost vagrant vm

yhn-dev can be used either :

on your local machine with LXCs (you can peacefully develop independently of your internet connection)
on a remote machine dedicated to dev (e.g. if you need the VM to be exposed on internet : test let's encrypt, email stack ...)

Develop on your local machine

Here is the development flow:

Setup ynh-dev and the development environnement
Manage YunoHost's dev LXCs
Developping on your host, and testing in the container

1. Setup ynh-dev and the development environnement

First you need to install the dependencies. ynh-dev essentially requires git, vagrant, and an LXC ecosystem.

The following commands should work on Linux Mint 19 (and possibly on any Debian Stretch?) :

apt update
apt install git vagrant lxc-templates lxctl lxc cgroup-lite redir bridge-utils libc6 libvirt-clients debootstrap
vagrant plugin install vagrant-lxc
echo "cgroup        /sys/fs/cgroup        cgroup        defaults    0    0" | sudo tee -a /etc/fstab
sudo mount /sys/fs/cgroup
lxc-checkconfig 
echo "veth" | sudo tee -a /etc/modules
wget https://raw.githubusercontent.com/fgrehm/vagrant-lxc/2a5510b34cc59cd3cb8f2dcedc3073852d841101/lib/vagrant-lxc/driver.rb -o .vagrant.d/gems/2.5.1/gems/vagrant-lxc-1.4.2/lib/vagrant-lxc/driver.rb

If you run Archlinux, this page should be quite useful to setup LXC : https://github.com/fgrehm/vagrant-lxc/wiki/Usage-on-Arch-Linux-hosts

Then, go into your favorite development folder and deploy ynh-dev with :

curl https://raw.githubusercontent.com/alexAubin/ynh-dev/master/deploy.sh | bash

This will create a new ynh-dev folder with everything you need inside. In particular, you shall notice that there are clones or the various git repositories. In the next step, we shall start a LXC and 'link' those folders between the host and the LXC.

2. Learn how to manage YunoHost's dev LXCs

When ran on the host, the ./ynh-dev command allows you to manage YunoHost's dev LXCs.

First, you might want to start a new LXC with :

./ynh-dev start

This should download an already built LXC from build.yunohost.org. If this does not work (or the LXC is outdated), you might want to (re)build a fresh LXC locally with ./ynh-dev rebuild.

After starting the LXC, you should be automatically SSH'ed inside. If you later disconnect from the LXC, you can go back in with ./ynh-dev ssh

Later, you might want to destroy the LXC. You can do so with ./ynh-dev destroy.

3. Developping on your host, and testing in the container

After SSH-ing inside the container, you should notice that the directory /ynh-dev is a shared folder with your host. In particular, it contains the various git clones yunohost, yunohost-admin and so on - as well as the ./ynh-dev script itself.

Inside the container, ./ynh-dev can be used to link the git clones living in the host to the code being ran inside the container.

For instance, after running

./ynh-dev use-git yunohost

the code of the git clone 'yunohost' will be directly available inside the container. Which mean that running any yunohost command inside the container will use the code from the host... This allows to develop with any tool you want on your host, then test the changes in the container.

The use-git action can be used for any package among yunohost, yunohost-admin, moulinette and ssowat with similar consequences.

Note: The use-git operation can't be reverted now. DON'T DO THIS IN PRODUCTION !

Testing the web interface

You should be able to access the web interface via the IP address of the container. The IP can be known from inside the container using either from ip a or with ./ynh-dev ip.

If you want to access to the interface using the domain name, you shall tweak your /etc/hosts and add a line such as:

111.222.333.444 yolo.test

Note that ./ynh-dev use-git yunohost-admin has a particular behavior : it starts a gulp watcher that shall re-compile automatically any changes in the javascript code. Hence this particular use-git will keep running until you kill it after your work is done.

Advanced : using snapshots

Vagrant is not well integrated with LXC snapshots. However, you may still use lxc-snapshot directly to manage snapshots.

Develop on a remote server

Instead of running a LXC locally, you may choose (or need) to develop on a dev VPS. Be aware that this is a dev tool : do NOT run this procedure on a production environment !.

Since you do not need to manage LXC, the setup is somewhat "easier" :

Setup your VPS and install YunoHost
Setup ynh-dev and the development environnement
Develop and test

1. Setup your VPS and install YunoHost

Setup a VPS somewhere (e.g. Scaleway, Digital Ocean, ...) and install YunoHost following https://yunohost.org/#/install_manually

Depending on what you want to achieve, you might want to run the postinstall right away - and/or setup a domain with an actually working DNS.

2. Setup ynh-dev and the development environnement

Deploy a ynh-dev folder at the root of the filesystem with :

cd / 
curl https://raw.githubusercontent.com/alexAubin/ynh-dev/master/deploy.sh | bash
cd /ynh-dev

3. Develop and test

Inside the VPS, ./ynh-dev can be used to link the git clones to actual the code being ran.