From 87896a7d79ecfe06d2538e719061d6e75e1d7952 Mon Sep 17 00:00:00 2001 From: Micah Anderson Date: Tue, 21 Nov 2017 10:05:14 -0500 Subject: Docs: Update docs to prepare for 0.10.0 release Fixes: #8427, #8812 --- docs/en/tutorials/quick-start.html | 58 ++++++++++++++++++++--- docs/en/tutorials/quick-start/guide/commands.html | 0 docs/en/tutorials/quick-start/index.html | 58 ++++++++++++++++++++--- docs/en/tutorials/quick-start/platform.html | 0 docs/en/tutorials/single-node-email.html | 4 +- docs/en/tutorials/single-node-email/index.html | 4 +- docs/en/tutorials/vagrant.html | 8 ++-- docs/en/tutorials/vagrant/index.html | 8 ++-- 8 files changed, 114 insertions(+), 26 deletions(-) create mode 100644 docs/en/tutorials/quick-start/guide/commands.html create mode 100644 docs/en/tutorials/quick-start/platform.html (limited to 'docs/en/tutorials') 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 @@ -122,6 +122,9 @@ Quick Start Tutorial - LEAP Platform Documentation
  • Install pre-requisites
    • +
  • + The platform recipes +
  • Install the LEAP command-line utility
    • @@ -139,6 +142,9 @@ Quick Start Tutorial - LEAP Platform Documentation
  • Option B: Add a local node
    • +
  • + Option C: Add a virtual machine in the cloud +
  • @@ -197,7 +203,7 @@ Quick Start Tutorial - LEAP Platform Documentation
    1. A local Vagrant virtual machine: a Vagrant machine can only be useful for testing.
      2. -
    2. 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.
      3. +
    3. 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 when changing the resolver
    • @@ -214,15 +220,20 @@ Quick Start Tutorial - LEAP Platform Documentation

    Prepare your workstation

    -

    In order to be able to manage your servers, you need to install the leap command on your workstation:

    +

    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 leap command, and your provider instance. We will go over these step-by-step below, you can find more details in the platform introduction.

    Install pre-requisites

    Install core prerequisites on your workstation.

    -

    Debian & Ubuntu

    +

    Debian Unstable (sid)

    + +
    workstation$ sudo apt-get install git rsync openssh-client openssl zlib1g-dev
+
    + +

    Other Debian & Ubuntu

    -
    workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2
+
    workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2 zlib1g-dev
 
    
 
 
    Mac OS
    
@@ -231,9 +242,38 @@ Quick Start Tutorial - LEAP Platform Documentation
 workstation$ ruby-install ruby
    +

    The platform recipes

    + +

    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.

    + +

    To obtain the platform recipes, simply clone the git repository, and then check out the most recent stable release branch:

    + +
    workstation$ git clone -b version/0.9.x https://leap.se/git/leap_platform
+
    + +

    If you want to get the latest development branch (Beware: it could be unstable !) you could simply use the master branch instead by:

    + +
    workstation$ git clone https://leap.se/git/leap_platform
+
    +

    Install the LEAP command-line utility

    -

    Install the leap command system-wide:

    +

    The leap command line tool is what you use to manage everything about your provider.

    + +

    Keep these rules in mind:

    + + + + +

    If on Debian Unstable (sid), simply do this:

    + +
    workstation$ sudo apt install leap-cli
+
    + +

    Otherwise, you will need to do this:

    workstation$ sudo gem install leap_cli
    @@ -340,14 +380,18 @@ workstation$ leap cert csr

    Option B: Add a local node

    -

    Create a node, with the services “webapp” and “couchdb”, and then start the local virtual machine:

    +

    Create a node, with the services “webapp”, “soledad” and “couchdb”, and then start the local virtual machine:

    -
    workstation$ leap node add --local wildebeest services:webapp,couchdb
+
    workstation$ leap node add --local wildebeest services:webapp,couchdb,soledad
 workstation$ leap local start wildebeest
 
    
 
 
    It will take a while to download the Virtualbox base box and create the virtual machine.
    
 
+
    Option C: Add a virtual machine in the cloud
    
+
+
    In order to create a provider using the cloud, please follow this instructions.
    
+
 
    Deploy your provider
    
 
 
    Initialize the node
    
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
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
@@ -122,6 +122,9 @@ Quick Start Tutorial - LEAP Platform Documentation
       
  • 
         Install pre-requisites
       
    • 
+      
  • 
+        The platform recipes
+      
    • 
       
  • 
         Install the LEAP command-line utility
       
    • 
@@ -139,6 +142,9 @@ Quick Start Tutorial - LEAP Platform Documentation
       
  • 
         Option B: Add a local node
       
    • 
+      
  • 
+        Option C: Add a virtual machine in the cloud
+      
    • 
     
   
   
  • 
@@ -197,7 +203,7 @@ Quick Start Tutorial - LEAP Platform Documentation
 
 
      
 
    1. A local Vagrant virtual machine: a Vagrant machine can only be useful for testing.
      2. 
-
    2. 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.
      3. 
+
    3. 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 when changing the resolver
      4. 
 
    
 
    • 
 
@@ -214,15 +220,20 @@ Quick Start Tutorial - LEAP Platform Documentation
 
 
    Prepare your workstation
    
 
-
    In order to be able to manage your servers, you need to install the leap command on your workstation:
    
+
    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 leap command, and your provider instance. We will go over these step-by-step below, you can find more details in the platform introduction.
    
 
 
    Install pre-requisites
    
 
 
    Install core prerequisites on your workstation.
    
 
-
    Debian & Ubuntu
    
+
    Debian Unstable (sid)
    
+
+
    workstation$ sudo apt-get install git rsync openssh-client openssl zlib1g-dev
+
    
+
+
    Other Debian & Ubuntu
    
 
-
    workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2
+
    workstation$ sudo apt-get install git ruby ruby-dev rsync openssh-client openssl rake make bzip2 zlib1g-dev
 
    
 
 
    Mac OS
    
@@ -231,9 +242,38 @@ Quick Start Tutorial - LEAP Platform Documentation
 workstation$ ruby-install ruby
 
    
 
+
    The platform recipes
    
+
+
    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.
    
+
+
    To obtain the platform recipes, simply clone the git repository, and then check out the most recent stable release branch:
    
+
+
    workstation$ git clone -b version/0.9.x https://leap.se/git/leap_platform
+
    
+
+
    If you want to get the latest development branch (Beware: it could be unstable !) you could simply use the master branch instead by:
    
+
+
    workstation$ git clone https://leap.se/git/leap_platform
+
    
+
 
    Install the LEAP command-line utility
    
 
-
    Install the leap command system-wide:
    
+
    The leap command line tool is what you use to manage everything about your provider.
    
+
+
    Keep these rules in mind:
    
+
+
      
+
    • leap is run on your workstation: The leap command is always run locally on your workstation, never on a server you are deploying to.
      • 
+
    • leap is run from within a provider instance: The leap command requires that the current working directory is a valid provider instance, except when running leap new to create a new provider instance.
      • 
+
    
+
+
+
    If on Debian Unstable (sid), simply do this:
    
+
+
    workstation$ sudo apt install leap-cli
+
    
+
+
    Otherwise, you will need to do this:
    
 
 
    workstation$ sudo gem install leap_cli
 
    
@@ -340,14 +380,18 @@ workstation$ leap cert csr
 
 
    Option B: Add a local node
    
 
-
    Create a node, with the services “webapp” and “couchdb”, and then start the local virtual machine:
    
+
    Create a node, with the services “webapp”, “soledad” and “couchdb”, and then start the local virtual machine:
    
 
-
    workstation$ leap node add --local wildebeest services:webapp,couchdb
+
    workstation$ leap node add --local wildebeest services:webapp,couchdb,soledad
 workstation$ leap local start wildebeest
 
    
 
 
    It will take a while to download the Virtualbox base box and create the virtual machine.
    
 
+
    Option C: Add a virtual machine in the cloud
    
+
+
    In order to create a provider using the cloud, please follow this instructions.
    
+
 
    Deploy your provider
    
 
 
    Initialize the node
    
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
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
 
    In our example, we would edit nodes/wildebeest.json:
    
 
 
    {
-  "ip_address": "1.1.1.1",
+  "ip_address": "XXX.XXX.XXX.XXX",
   "services": ["couchdb", "webapp", "mx", "soledad"]
 }
 
    
 
+
    Where “XXX.XXX.XXX.XXX” should be replaced by your IP provider.
    
+
 
    Here, we added mx and soledad to the node’s services list. Briefly:
    
 
 
      
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
 
      In our example, we would edit nodes/wildebeest.json:
      
 
 
      {
-  "ip_address": "1.1.1.1",
+  "ip_address": "XXX.XXX.XXX.XXX",
   "services": ["couchdb", "webapp", "mx", "soledad"]
 }
 
      
 
+
      Where “XXX.XXX.XXX.XXX” should be replaced by your IP provider.
      
+
 
      Here, we added mx and soledad to the node’s services list. Briefly:
      
 
 
        
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
 
 
        Clone the platform with
        
 
-
        git clone --recursive -b develop https://github.com/leapcode/leap_platform.git
+
        git clone https://leap.se/git/leap_platform
 
        
 
 
        Start the vagrant box with
        
 
-
        cd leap_platform
+
        cd leap_platform/tests/example-provider
 vagrant up
 
        
 
@@ -531,7 +531,7 @@ started by the bitmask client:
        
 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
 
        
 
 
        Log out and then log back in.
        
@@ -585,8 +585,6 @@ virsh pool-autostart vagrant
 
      • 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) - you don’t have the libvirtd daemon running or installed, be sure you installed the ‘libvirt-bin’ package and it is running
        • 
 
      • Call to virConnectOpen failed: Failed to connect socket to '/var/run/libvirt/libvirt-sock': Permission denied - you need to be in the libvirt group to access the socket, do ‘sudo adduser  libvirtd’ and then re-login to your session.
        • 
 
      • 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 https://github.com/pradels/vagrant-libvirt/issues/75 having two virtualization engines installed simultaneously can lead to such weird issues.
        • 
-
      • see the vagrant-libvirt issue list on github
        • 
-
      • be sure to use vagrant-libvirt >= 0.0.11 and sahara >= 0.0.16 (which are the latest stable gems you would get with vagrant plugin install [vagrant-libvirt|sahara]) for proper libvirt support,
        • 
 
      
 
 
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
 
 
      Clone the platform with
      
 
-
      git clone --recursive -b develop https://github.com/leapcode/leap_platform.git
+
      git clone https://leap.se/git/leap_platform
 
      
 
 
      Start the vagrant box with
      
 
-
      cd leap_platform
+
      cd leap_platform/tests/example-provider
 vagrant up
 
      
 
@@ -531,7 +531,7 @@ started by the bitmask client:
      
 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
 
      
 
 
      Log out and then log back in.
      
@@ -585,8 +585,6 @@ virsh pool-autostart vagrant
 
    • 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) - you don’t have the libvirtd daemon running or installed, be sure you installed the ‘libvirt-bin’ package and it is running
      • 
 
    • Call to virConnectOpen failed: Failed to connect socket to '/var/run/libvirt/libvirt-sock': Permission denied - you need to be in the libvirt group to access the socket, do ‘sudo adduser  libvirtd’ and then re-login to your session.
      • 
 
    • 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 https://github.com/pradels/vagrant-libvirt/issues/75 having two virtualization engines installed simultaneously can lead to such weird issues.
      • 
-
    • see the vagrant-libvirt issue list on github
      • 
-
    • be sure to use vagrant-libvirt >= 0.0.11 and sahara >= 0.0.16 (which are the latest stable gems you would get with vagrant plugin install [vagrant-libvirt|sahara]) for proper libvirt support,
      • 
 
    
 
 
-- 
cgit v1.2.3