Merge branch 'document' into 'master'

   git/index	

   ifttt/index

   lint

   remote-dev/index

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

 Remote Development

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

The section contains instructions to setup remote development environment. That is developer runs odoo and probably other tools on remote server rather on his machine. Advantages of this approach are:

* easy way to provide big computing capacity

* the same environment from any device

* easy way to demonstrate work

Usage

=====

.. toctree::

   :maxdepth: 1

   ssh-forwarding

   run-local-files-remotely

   x2go

Containers administration

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

.. toctree::

   lxd/lxd

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

 LXD Containers

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

.. code-block:: sh

    # For understanding LXC see https://wiki.debian.org/LXC

    # Based on:

    # lxd + docker: https://stgraber.org/2016/04/13/lxd-2-0-docker-in-lxd-712/

    # lxd network (static ip): https://stgraber.org/2016/10/27/network-management-with-lxd-2-3/

    LXD_NETWORK="dev-network2"

    # install lxd 2.3+

    apt-get install software-properties-common iptables-persistent

    add-apt-repository ppa:ubuntu-lxc/lxd-stable

    apt-get update

    apt-get dist-upgrade

    apt-get install lxd

    # init lxd

    lxd init

    # init network

    lxc network create ${LXD_NETWORK}

    lxc network show ${LXD_NETWORK}  # check ipv4.address field

    ############################

    # Per each Developer

    GITHUB_USERNAME="yelizariev"

    CONTAINER="${GITHUB_USERNAME}"

    SERVER_DOMAIN="${GITHUB_USERNAME}.dev.it-projects.info"

    NGINX_CONF="dev-${GITHUB_USERNAME}.conf"

    LOCAL_IP="10.37.82.100"  # use one from network subnet

    PORT="10100"  # unique per each developer

    # https://discuss.linuxcontainers.org/t/docker-cannot-write-to-devices-allow/998/3

    read -r -d '' RAW_LXC <<EOF

    lxc.apparmor.profile=unconfined

    lxc.mount.auto="proc:rw sys:rw cgroup:rw"

    lxc.cgroup.devices.allow=a

    lxc.cap.drop=

    EOF

    lxc init ubuntu-daily:18.04 ${CONTAINER} -p default && \

    lxc network attach ${LXD_NETWORK} ${CONTAINER} eth0 && \

    lxc config device set ${CONTAINER} eth0 ipv4.address ${LOCAL_IP} && \

    lxc config set ${CONTAINER} security.privileged true && \

    # allow run docker in previliged mode. 

    # https://discuss.linuxcontainers.org/t/failed-to-write-a-rwm-to-devices-allow-operation-not-permitted-in-privileged-container/925/3

    lxc config set ${CONTAINER} raw.lxc "$RAW_LXC"

    # forward ssh port

    iptables -t nat -A PREROUTING -p tcp --dport ${PORT} -j DNAT \

      --to-destination ${LOCAL_IP}:22

    # save iptables record. Otherwise it's disappeared after rebooting

    sudo netfilter-persistent save

    sudo netfilter-persistent reload

    PASS="$(< /dev/urandom tr -dc _A-Za-z0-9 | head -c${1:-32};echo;)"

    lxc start ${CONTAINER}

    lxc exec ${CONTAINER} -- apt-get update && \

    lxc exec  ${CONTAINER} -- apt dist-upgrade -y

    # colorize prompt:

    lxc exec ${CONTAINER} -- sed -i "s/#force_color_prompt=yes/force_color_prompt=yes/" /root/.bashrc && \

    lxc exec ${CONTAINER} -- sed -i "s/01;32m/01;36m/" /root/.bashrc && \

    # install some packages

    lxc exec  ${CONTAINER} -- apt install docker.io htop python3-pip -y && \

    lxc exec  ${CONTAINER} -- ln -s /usr/bin/pip3 /usr/bin/pip && \

    lxc exec  ${CONTAINER} -- pip install odooup && \

    # https://docs.docker.com/v17.09/compose/install/#install-compose

    lxc exec  ${CONTAINER} -- curl -L https://github.com/docker/compose/releases/download/1.18.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose && \

    lxc exec  ${CONTAINER} -- chmod +x /usr/local/bin/docker-compose && \

    # update git. See https://github.com/xoe-labs/odooup/issues/8

    # TODO: this may not be needed in ubuntu 18

    lxc exec ${CONTAINER} -- add-apt-repository ppa:git-core/ppa -y && \

    lxc exec ${CONTAINER} -- apt-get update && \

    lxc exec ${CONTAINER} -- apt-get install git -y && \

    lxc exec ${CONTAINER} -- adduser noroot --disabled-password --gecos "" && \

    lxc exec ${CONTAINER} -- mkdir -p /root/.ssh && \

    lxc exec ${CONTAINER} -- bash -c "curl --silent https://github.com/${GITHUB_USERNAME}.keys >> /root/.ssh/authorized_keys" && \

    # access for noroot

    lxc exec ${CONTAINER} -- bash -c "echo $PASS > /root/noroot-password"     && \

    lxc exec ${CONTAINER} -- bash -c "echo noroot:$PASS | chpasswd "     && \

    lxc exec ${CONTAINER} -- sudo -u "noroot" bash -c "mkdir -p /home/noroot/.ssh" && \

    lxc exec ${CONTAINER} -- sudo -u "noroot" bash -c "curl --silent https://github.com/${GITHUB_USERNAME}.keys >> /home/noroot/.ssh/authorized_keys" && \

    lxc exec ${CONTAINER} -- sudo -u "noroot" sed -i "s/01;32m/01;93m/" /home/noroot/.bashrc && \

    # Manage Docker as a non-root user https://docs.docker.com/install/linux/linux-postinstall/

    lxc exec ${CONTAINER} -- usermod -aG docker noroot && \

    lxc exec ${CONTAINER} -- usermod -aG sudo noroot && \

    lxc exec ${CONTAINER} -- locale-gen --purge en_US.UTF-8 && \

    lxc exec ${CONTAINER} -- bash -c "echo -e 'LANG=\"en_US.UTF-8\"\nLANGUAGE=\"en_US:en\"\n' > /etc/default/locale"

    lxc config device add ${CONTAINER} sharedcachenoroot disk path=/home/noroot/.cache source=/var/lxc/share/cache && \

    lxc stop ${CONTAINER} && \

    lxc start ${CONTAINER}

    ## nginx on host machine

    cd /tmp/

    curl -s https://raw.githubusercontent.com/it-projects-llc/odoo-devops/master/docs/remote-dev/lxd/nginx.conf > nginx.conf

    sed -i "s/NGINX_SERVER_DOMAIN/.${SERVER_DOMAIN}/g" nginx.conf

    sed -i "s/SERVER_HOST/${LOCAL_IP}/g" nginx.conf

    cp nginx.conf /etc/nginx/sites-available/${NGINX_CONF}

    ln -s /etc/nginx/sites-available/${NGINX_CONF} /etc/nginx/sites-enabled/${NGINX_CONF}

    # then restart nginx in a usual way

    ###################

    # Control commands

    # delete container

    lxc delete CONTAINER-NAME

    # see iptables rules

    iptables -L -t nat

    # delete nat rule

    iptables -t nat -D PREROUTING POSITION_NUMBER

server {

    listen 80;

    server_name NGINX_SERVER_DOMAIN;

    location / {

        proxy_pass http://SERVER_HOST:80;

    }

    charset utf-8;

    ## increase proxy buffer to handle some OpenERP web requests

    proxy_buffers               16 64k;

    proxy_buffer_size           128k;

    ## set headers

    proxy_set_header            Host $host;

    proxy_set_header            X-Real-IP       $remote_addr;

    proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_set_header            X-Forwarded-Proto $scheme;

    proxy_read_timeout         600s;

    client_max_body_size        200m;

    #general proxy settings

    proxy_next_upstream error timeout invalid_header http_500 http_502 http_503;

    # by default, do not forward anything

    proxy_redirect       off;

    proxy_buffering      off;

}

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

 How to mount local files on a server

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

sshfs

=====

On your local machine:

.. code-block:: sh

    # Step 1. Install ssh server on your local machine

    # TODO

    # Step 2. Configure ssh keys on you local machine

    cat cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys 

    # Step 3. Connect to your server

    ssh USERNAME@SERVER -p 22 -A -R 10000:localhost:22

On your remote server:

.. code-block:: sh

    # Step 4. Mount your directory on remote server

    sshfs -p 10000 -o idmap=user,nonempty \

                 LOCALUSERNAME@127.0.0.1:/PATH/TO/LOCAL/FOLDER /PATH/TO/REMOTE/FOLDER

References

==========

* https://superuser.com/questions/616182/how-to-mount-local-directory-to-remote-like-sshfs