diff options
Diffstat (limited to 'docs/en/tutorials')
| -rw-r--r-- | docs/en/tutorials/quick-start.html | 58 | ||||
| -rw-r--r-- | docs/en/tutorials/quick-start/guide/commands.html | 0 | ||||
| -rw-r--r-- | docs/en/tutorials/quick-start/index.html | 58 | ||||
| -rw-r--r-- | docs/en/tutorials/quick-start/platform.html | 0 | ||||
| -rw-r--r-- | docs/en/tutorials/single-node-email.html | 4 | ||||
| -rw-r--r-- | docs/en/tutorials/single-node-email/index.html | 4 | ||||
| -rw-r--r-- | docs/en/tutorials/vagrant.html | 8 | ||||
| -rw-r--r-- | docs/en/tutorials/vagrant/index.html | 8 |
8 files changed, 114 insertions, 26 deletions
diff --git a/docs/en/tutorials/quick-start.html b/docs/en/tutorials/quick-start.html index d2670b30..d275a321 100644 --- a/docs/en/tutorials/quick-start.html +++ b/docs/en/tutorials/quick-start.html @@ -123,6 +123,9 @@ Quick Start Tutorial - LEAP Platform Documentation <a href="quick-start/index.html#install-pre-requisites">Install pre-requisites</a> </li> <li> + <a href="quick-start/index.html#the-platform-recipes">The platform recipes</a> + </li> + <li> <a href="quick-start/index.html#install-the-leap-command-line-utility">Install the LEAP command-line utility</a> </li> </ol> @@ -139,6 +142,9 @@ Quick Start Tutorial - LEAP Platform Documentation <li> <a href="quick-start/index.html#option-b-add-a-local-node">Option B: Add a local node</a> </li> + <li> + <a href="quick-start/index.html#option-c-add-a-virtual-machine-in-the-cloud">Option C: Add a virtual machine in the cloud</a> + </li> </ol> </li> <li> @@ -197,7 +203,7 @@ Quick Start Tutorial - LEAP Platform Documentation <ol> <li>A local Vagrant virtual machine: a Vagrant machine can only be useful for testing.</li> -<li>A real or paravirtualized server: The server must have Debian Jessie installed, and you must be able to SSH into the machine as root. Paravirtualization includes KVM, Xen, OpenStack, Amazon, but not VirtualBox or OpenVZ.</li> +<li>A real or paravirtualized server: The server must have Debian Jessie installed, and you must be able to SSH into the machine as root. Paravirtualization includes KVM, Xen, OpenStack, Amazon, but not VirtualBox or OpenVZ. Proxmox has an known issue <a href="https://leap.se/code/issues/8683">when changing the resolver</a></li> </ol> </li> </ol> @@ -214,15 +220,20 @@ Quick Start Tutorial - LEAP Platform Documentation <h1><a name="prepare-your-workstation"></a>Prepare your workstation</h1> -<p>In order to be able to manage your servers, you need to install the <code>leap</code> command on your workstation:</p> +<p>In order to be able to manage your servers, you need to setup the LEAP Platform on your desktop. This consists of three parts: the platform recipes, the <code>leap</code> command, and your provider instance. We will go over these step-by-step below, you can find more details in the <a href="quick-start/platform.html">platform introduction</a>.</p> <h3><a name="install-pre-requisites"></a>Install pre-requisites</h3> <p>Install core prerequisites on your workstation.</p> -<p><em>Debian & Ubuntu</em></p> +<p><em>Debian Unstable (sid)</em></p> + +<pre><code>workstation$ sudo apt-get install git rsync openssh-client openssl zlib1g-dev +</code></pre> + +<p><em>Other Debian & Ubuntu</em></p> -<pre><code>workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2 +<pre><code>workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2 zlib1g-dev </code></pre> <p><em>Mac OS</em></p> @@ -231,9 +242,38 @@ Quick Start Tutorial - LEAP Platform Documentation workstation$ ruby-install ruby </code></pre> +<h3><a name="the-platform-recipes"></a>The platform recipes</h3> + +<p>The LEAP platform recipes are a set modules designed to work together to provide you everything you need to manage your provider. You typically do not need to modify these, but do need them available for deploying your provider.</p> + +<p>To obtain the platform recipes, simply clone the git repository, and then check out the most recent stable release branch:</p> + +<pre><code>workstation$ git clone -b version/0.9.x https://leap.se/git/leap_platform +</code></pre> + +<p>If you want to get the latest development branch (Beware: it could be unstable !) you could simply use the master branch instead by:</p> + +<pre><code>workstation$ git clone https://leap.se/git/leap_platform +</code></pre> + <h3><a name="install-the-leap-command-line-utility"></a>Install the LEAP command-line utility</h3> -<p>Install the <code>leap</code> command system-wide:</p> +<p>The <code>leap</code> <a href="quick-start/guide/commands.html">command line tool</a> is what you use to manage everything about your provider.</p> + +<p>Keep these rules in mind:</p> + +<ul> +<li><code>leap</code> is run on your workstation: The <code>leap</code> command is always run locally on your workstation, never on a server you are deploying to.</li> +<li><code>leap</code> is run from within a provider instance: The <code>leap</code> command requires that the current working directory is a valid provider instance, except when running <code>leap new</code> to create a new provider instance.</li> +</ul> + + +<p>If on Debian Unstable (sid), simply do this:</p> + +<pre><code>workstation$ sudo apt install leap-cli +</code></pre> + +<p>Otherwise, you will need to do this:</p> <pre><code>workstation$ sudo gem install leap_cli </code></pre> @@ -340,14 +380,18 @@ workstation$ leap cert csr <h3><a name="option-b-add-a-local-node"></a>Option B: Add a local node</h3> -<p>Create a node, with the services “webapp” and “couchdb”, and then start the local virtual machine:</p> +<p>Create a node, with the services “webapp”, “soledad” and “couchdb”, and then start the local virtual machine:</p> -<pre><code>workstation$ leap node add --local wildebeest services:webapp,couchdb +<pre><code>workstation$ leap node add --local wildebeest services:webapp,couchdb,soledad workstation$ leap local start wildebeest </code></pre> <p>It will take a while to download the Virtualbox base box and create the virtual machine.</p> +<h3><a name="option-c-add-a-virtual-machine-in-the-cloud"></a>Option C: Add a virtual machine in the cloud</h3> + +<p>In order to create a provider using the cloud, please follow this <a href="https://leap.se/en/docs/platform/guide/virtual-machines">instructions</a>.</p> + <h1><a name="deploy-your-provider"></a>Deploy your provider</h1> <h3><a name="initialize-the-node"></a>Initialize the node</h3> diff --git a/docs/en/tutorials/quick-start/guide/commands.html b/docs/en/tutorials/quick-start/guide/commands.html new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/en/tutorials/quick-start/guide/commands.html diff --git a/docs/en/tutorials/quick-start/index.html b/docs/en/tutorials/quick-start/index.html index 27b21238..ae617e1b 100644 --- a/docs/en/tutorials/quick-start/index.html +++ b/docs/en/tutorials/quick-start/index.html @@ -123,6 +123,9 @@ Quick Start Tutorial - LEAP Platform Documentation <a href="index.html#install-pre-requisites">Install pre-requisites</a> </li> <li> + <a href="index.html#the-platform-recipes">The platform recipes</a> + </li> + <li> <a href="index.html#install-the-leap-command-line-utility">Install the LEAP command-line utility</a> </li> </ol> @@ -139,6 +142,9 @@ Quick Start Tutorial - LEAP Platform Documentation <li> <a href="index.html#option-b-add-a-local-node">Option B: Add a local node</a> </li> + <li> + <a href="index.html#option-c-add-a-virtual-machine-in-the-cloud">Option C: Add a virtual machine in the cloud</a> + </li> </ol> </li> <li> @@ -197,7 +203,7 @@ Quick Start Tutorial - LEAP Platform Documentation <ol> <li>A local Vagrant virtual machine: a Vagrant machine can only be useful for testing.</li> -<li>A real or paravirtualized server: The server must have Debian Jessie installed, and you must be able to SSH into the machine as root. Paravirtualization includes KVM, Xen, OpenStack, Amazon, but not VirtualBox or OpenVZ.</li> +<li>A real or paravirtualized server: The server must have Debian Jessie installed, and you must be able to SSH into the machine as root. Paravirtualization includes KVM, Xen, OpenStack, Amazon, but not VirtualBox or OpenVZ. Proxmox has an known issue <a href="https://leap.se/code/issues/8683">when changing the resolver</a></li> </ol> </li> </ol> @@ -214,15 +220,20 @@ Quick Start Tutorial - LEAP Platform Documentation <h1><a name="prepare-your-workstation"></a>Prepare your workstation</h1> -<p>In order to be able to manage your servers, you need to install the <code>leap</code> command on your workstation:</p> +<p>In order to be able to manage your servers, you need to setup the LEAP Platform on your desktop. This consists of three parts: the platform recipes, the <code>leap</code> command, and your provider instance. We will go over these step-by-step below, you can find more details in the <a href="platform.html">platform introduction</a>.</p> <h3><a name="install-pre-requisites"></a>Install pre-requisites</h3> <p>Install core prerequisites on your workstation.</p> -<p><em>Debian & Ubuntu</em></p> +<p><em>Debian Unstable (sid)</em></p> + +<pre><code>workstation$ sudo apt-get install git rsync openssh-client openssl zlib1g-dev +</code></pre> + +<p><em>Other Debian & Ubuntu</em></p> -<pre><code>workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2 +<pre><code>workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2 zlib1g-dev </code></pre> <p><em>Mac OS</em></p> @@ -231,9 +242,38 @@ Quick Start Tutorial - LEAP Platform Documentation workstation$ ruby-install ruby </code></pre> +<h3><a name="the-platform-recipes"></a>The platform recipes</h3> + +<p>The LEAP platform recipes are a set modules designed to work together to provide you everything you need to manage your provider. You typically do not need to modify these, but do need them available for deploying your provider.</p> + +<p>To obtain the platform recipes, simply clone the git repository, and then check out the most recent stable release branch:</p> + +<pre><code>workstation$ git clone -b version/0.9.x https://leap.se/git/leap_platform +</code></pre> + +<p>If you want to get the latest development branch (Beware: it could be unstable !) you could simply use the master branch instead by:</p> + +<pre><code>workstation$ git clone https://leap.se/git/leap_platform +</code></pre> + <h3><a name="install-the-leap-command-line-utility"></a>Install the LEAP command-line utility</h3> -<p>Install the <code>leap</code> command system-wide:</p> +<p>The <code>leap</code> <a href="guide/commands.html">command line tool</a> is what you use to manage everything about your provider.</p> + +<p>Keep these rules in mind:</p> + +<ul> +<li><code>leap</code> is run on your workstation: The <code>leap</code> command is always run locally on your workstation, never on a server you are deploying to.</li> +<li><code>leap</code> is run from within a provider instance: The <code>leap</code> command requires that the current working directory is a valid provider instance, except when running <code>leap new</code> to create a new provider instance.</li> +</ul> + + +<p>If on Debian Unstable (sid), simply do this:</p> + +<pre><code>workstation$ sudo apt install leap-cli +</code></pre> + +<p>Otherwise, you will need to do this:</p> <pre><code>workstation$ sudo gem install leap_cli </code></pre> @@ -340,14 +380,18 @@ workstation$ leap cert csr <h3><a name="option-b-add-a-local-node"></a>Option B: Add a local node</h3> -<p>Create a node, with the services “webapp” and “couchdb”, and then start the local virtual machine:</p> +<p>Create a node, with the services “webapp”, “soledad” and “couchdb”, and then start the local virtual machine:</p> -<pre><code>workstation$ leap node add --local wildebeest services:webapp,couchdb +<pre><code>workstation$ leap node add --local wildebeest services:webapp,couchdb,soledad workstation$ leap local start wildebeest </code></pre> <p>It will take a while to download the Virtualbox base box and create the virtual machine.</p> +<h3><a name="option-c-add-a-virtual-machine-in-the-cloud"></a>Option C: Add a virtual machine in the cloud</h3> + +<p>In order to create a provider using the cloud, please follow this <a href="https://leap.se/en/docs/platform/guide/virtual-machines">instructions</a>.</p> + <h1><a name="deploy-your-provider"></a>Deploy your provider</h1> <h3><a name="initialize-the-node"></a>Initialize the node</h3> diff --git a/docs/en/tutorials/quick-start/platform.html b/docs/en/tutorials/quick-start/platform.html new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/en/tutorials/quick-start/platform.html diff --git a/docs/en/tutorials/single-node-email.html b/docs/en/tutorials/single-node-email.html index 6678fec3..d3372f91 100644 --- a/docs/en/tutorials/single-node-email.html +++ b/docs/en/tutorials/single-node-email.html @@ -144,11 +144,13 @@ Quick email - LEAP Platform Documentation <p>In our example, we would edit <code>nodes/wildebeest.json</code>:</p> <pre><code>{ - "ip_address": "1.1.1.1", + "ip_address": "XXX.XXX.XXX.XXX", "services": ["couchdb", "webapp", "mx", "soledad"] } </code></pre> +<p>Where “XXX.XXX.XXX.XXX” should be replaced by your IP provider.</p> + <p>Here, we added <code>mx</code> and <code>soledad</code> to the node’s <code>services</code> list. Briefly:</p> <ul> diff --git a/docs/en/tutorials/single-node-email/index.html b/docs/en/tutorials/single-node-email/index.html index 45a1264f..fd501790 100644 --- a/docs/en/tutorials/single-node-email/index.html +++ b/docs/en/tutorials/single-node-email/index.html @@ -144,11 +144,13 @@ Quick email - LEAP Platform Documentation <p>In our example, we would edit <code>nodes/wildebeest.json</code>:</p> <pre><code>{ - "ip_address": "1.1.1.1", + "ip_address": "XXX.XXX.XXX.XXX", "services": ["couchdb", "webapp", "mx", "soledad"] } </code></pre> +<p>Where “XXX.XXX.XXX.XXX” should be replaced by your IP provider.</p> + <p>Here, we added <code>mx</code> and <code>soledad</code> to the node’s <code>services</code> list. Briefly:</p> <ul> diff --git a/docs/en/tutorials/vagrant.html b/docs/en/tutorials/vagrant.html index 3d4f0520..e473ce82 100644 --- a/docs/en/tutorials/vagrant.html +++ b/docs/en/tutorials/vagrant.html @@ -437,12 +437,12 @@ $ leap local save web1 <p>Clone the platform with</p> -<pre><code>git clone --recursive -b develop https://github.com/leapcode/leap_platform.git +<pre><code>git clone https://leap.se/git/leap_platform </code></pre> <p>Start the vagrant box with</p> -<pre><code>cd leap_platform +<pre><code>cd leap_platform/tests/example-provider vagrant up </code></pre> @@ -531,7 +531,7 @@ started by the bitmask client:</p> sudo apt-get install ruby-dev libxslt-dev libxml2-dev libvirt-dev # install the required plugins -vagrant plugin install vagrant-libvirt fog fog-libvirt sahara +vagrant plugin install vagrant-libvirt sahara </code></pre> <p>Log out and then log back in.</p> @@ -585,8 +585,6 @@ virsh pool-autostart vagrant <li><code>Call to virConnectOpen failed: internal error: Unable to locate libvirtd daemon in /usr/sbin (to override, set $LIBVIRTD_PATH to the name of the libvirtd binary)</code> - you don’t have the libvirtd daemon running or installed, be sure you installed the ‘libvirt-bin’ package and it is running</li> <li><code>Call to virConnectOpen failed: Failed to connect socket to '/var/run/libvirt/libvirt-sock': Permission denied</code> - you need to be in the libvirt group to access the socket, do ‘sudo adduser <user> libvirtd’ and then re-login to your session.</li> <li>if each call to vagrant ends up with a segfault, it may be because you still have virtualbox around. if so, remove virtualbox to keep only libvirt + KVM. according to <a href="https://github.com/pradels/vagrant-libvirt/issues/75">https://github.com/pradels/vagrant-libvirt/issues/75</a> having two virtualization engines installed simultaneously can lead to such weird issues.</li> -<li>see the <a href="https://github.com/pradels/vagrant-libvirt/issues">vagrant-libvirt issue list on github</a></li> -<li>be sure to use vagrant-libvirt >= 0.0.11 and sahara >= 0.0.16 (which are the latest stable gems you would get with <code>vagrant plugin install [vagrant-libvirt|sahara]</code>) for proper libvirt support,</li> </ul> diff --git a/docs/en/tutorials/vagrant/index.html b/docs/en/tutorials/vagrant/index.html index 95bd6b71..181a3ccf 100644 --- a/docs/en/tutorials/vagrant/index.html +++ b/docs/en/tutorials/vagrant/index.html @@ -437,12 +437,12 @@ $ leap local save web1 <p>Clone the platform with</p> -<pre><code>git clone --recursive -b develop https://github.com/leapcode/leap_platform.git +<pre><code>git clone https://leap.se/git/leap_platform </code></pre> <p>Start the vagrant box with</p> -<pre><code>cd leap_platform +<pre><code>cd leap_platform/tests/example-provider vagrant up </code></pre> @@ -531,7 +531,7 @@ started by the bitmask client:</p> sudo apt-get install ruby-dev libxslt-dev libxml2-dev libvirt-dev # install the required plugins -vagrant plugin install vagrant-libvirt fog fog-libvirt sahara +vagrant plugin install vagrant-libvirt sahara </code></pre> <p>Log out and then log back in.</p> @@ -585,8 +585,6 @@ virsh pool-autostart vagrant <li><code>Call to virConnectOpen failed: internal error: Unable to locate libvirtd daemon in /usr/sbin (to override, set $LIBVIRTD_PATH to the name of the libvirtd binary)</code> - you don’t have the libvirtd daemon running or installed, be sure you installed the ‘libvirt-bin’ package and it is running</li> <li><code>Call to virConnectOpen failed: Failed to connect socket to '/var/run/libvirt/libvirt-sock': Permission denied</code> - you need to be in the libvirt group to access the socket, do ‘sudo adduser <user> libvirtd’ and then re-login to your session.</li> <li>if each call to vagrant ends up with a segfault, it may be because you still have virtualbox around. if so, remove virtualbox to keep only libvirt + KVM. according to <a href="https://github.com/pradels/vagrant-libvirt/issues/75">https://github.com/pradels/vagrant-libvirt/issues/75</a> having two virtualization engines installed simultaneously can lead to such weird issues.</li> -<li>see the <a href="https://github.com/pradels/vagrant-libvirt/issues">vagrant-libvirt issue list on github</a></li> -<li>be sure to use vagrant-libvirt >= 0.0.11 and sahara >= 0.0.16 (which are the latest stable gems you would get with <code>vagrant plugin install [vagrant-libvirt|sahara]</code>) for proper libvirt support,</li> </ul> |