VIFIB DESCENTRALIZED CLOUD COMPUTING

SlapOS is a decentralized Cloud Computing technology that can automate the deployment and configuration of applications in a heterogeneous environment.

These instructions will help you get your first ERP5 instance using a SlapOS webrunner.

${table_of_content}

What is SlapOS?

SlapOS is an open source grid operating system for cloud orchestration and computing. Almost all ERP5 implementations are hosted through SlapOS as both tools share many similarities in they way they are built. If you are interested, have a look at the community wiki and especially the general introduction and presentation on SlapOS architecture.

There are two ways to getting an ERP5 instance:

  • Requesting an "empty" Webrunner and deploying ERP5 as a software release (Production-Instance)
  • Requesting a Webrunner with ERP5 preinstalled

The main difference between both approaches is the poduction ready ERP5 instance being instantiated through the Webrunner and official software release with the ERP5 site being manually created once everything has set up. The second approach will do all of these steps automatically.

Getting A Webrunner and deploying ERP5 (Production)

The following steps will help you get an empty webrunner to deploy ERP5:

Go to www.vifib.com and on the PAAS column (that's for a SlapOS Webrunner), click the 2€/day button to request a Webrunner.

Requesting a Webrunner with ERP5 - Vifib Homepage

If you don't have a Vifib account yet, you will be redirected to the SlapOS login page to sign up.

Requesting a Webrunner with ERP5 - SlapOS Registration

Once you've signed up you should be forwarded to the page requesting your Webrunner. Getting your runner will require between 10-15 minutes, refresh the page from time to time until you have connection parameters to work with (scroll down a bit).

Requesting a Webrunner with ERP5 - SlapOS page for requesting a Webrunner

Note: If you are creating a new account, this might have to be validated first before anything happens. In this case please contact the Vifib team through the contact section or file a "New Ticket" in your SlapOS My Space overview.

Requesting a Webrunner with ERP5 - SlapOS My Space

Once your account has been validated and your webrunner has setup, you should have a parameter section which looks like the one below followed by a legend (the SlapOS Community Wiki contains more info on what all the parameters are used for).

Requesting a Webrunner with ERP5 - Webrunner Parameters
  1. Backend URL: ipv6 url to directly access your runner.
  2. feed-url-runner-1-pull:
  3. feed-url-runner-1-push:
  4. Git private url: private url for your repositories. You can use it to push
  5. Git public url: public url of your repositories.
  6. Init Password: Initial password to login to your webrunner.
  7. Init User: Initial username to login to your webrunner.
  8. Monitor Base Url: Monitor Base URL that should be used to access monitor files such as logs or custom files report.
  9. Monitor Setup Url: Use this url to configure or reconfigure your monitor instance in your web browser.
  10. Public Url: Url of the public folder of your runner.
  11. SSH command: used to access your runner in ssh when you provided a ssh public key.
  12. Resilient takeover URL and password.
  13. Url: Url to access your runner over IPv4.
  14. Webdav url: url for webdav access of your runner it access the root of your runner. Same users as the one for the runner.

Continue with the URL (12) parameter. Note, that this parameter may take several hours to appear. If accessible you can use the default IPv6 parameter backend-url in the meantime. Login with your Init User (7) and Init Password (6). You should reach the Webrunner default interface.

Requesting a Webrunner with ERP5 - SlapOS Webrunner Interface

To request the ERP5 software release, click on Open a Software Release, then locate ERP5 at slapos > software > erp5 and once selected click "Open Software".

Requesting a Webrunner with ERP5 - SlapOS Webrunner Select Software Release

You will be forwarded to the configuration file. Just click "Save" and then hit the green button top right to start compilation and installation of your ERP5 instance.

Requesting a Webrunner with ERP5 - SlapOS Webrunner Configure Software Release

Compilation from scratch and installation will take a few hours. Once everything is done, both indicators should be showing a green state.

Requesting a Webrunner with ERP5 - SlapOS Webrunner Install Software Release

Note: It is not unlikely for the installation to not complete successfully due to some errors like missing templates. In this case, please hit the green button again - it will only take a few minutes to re-instantiate and see if installation finishes successful.

Once the installation is complete, at least the top indicator should show a green status.

Requesting a Webrunner with ERP5 - SlapOS Webrunner Installed Software Release

Head to the Services tab and locate parameters on the Slappart0 partition. Copy the family-default-v6 parameter (make sure you don't copy the family-default). We will use this to require a custom-front-end url for the erp5 instance.

Requesting a Webrunner with ERP5 - SlapOS Webrunner Services Partition Parameters

Copy the value, head to your SlapOS Service page and add it as value for the Custom Frontend Backend URL to request an IPv4 frontend url for your instance. Also set the Custom Frontend Backend Type to "Zope". Then scroll down and click Update XML.

Requesting a Webrunner with ERP5 - SlapOS Create Custom Front End Url

Note: It may take some time (several hours) until the frontend url is available. Refresh your page from time to time to see whether the parameters section has a new custom-frontend-url and eventually an assigned value, too.

Once you have an URL, you can create your ERP5 site. Access the custom front-end URL and click Zope Management Interface. To login, use the inituser login (usually zope) and password also found inside the SlapOS Webrunner Services tab Connection Information under slappart0.

Requesting a Webrunner with ERP5 - Zope Management Interface

In the Management Interface, select Add ERP5 Site. We'll now be creating the erp5-site.

Requesting a Webrunner with ERP5 - Add an ERP5 Site

You need to provide the database url in the format displayed in the screenshot. You can find it in your SlapOS Services Tab Connection Parameters database-list. It will have a format like: "mysql://user:password@xx.x.xxx.xxx:xxxx/erp5"] which you have to reformat to erp5@xx.x.xxx.xxx:xxxx user password. Enter this string in both the ERP5 Database and CMF Activity Database fields, then click Create a New ERP5 Instance. After a few minutes your instance should be ready.

Requesting a Webrunner with ERP5 - Configuring ERP5 Site

Access your instance at [Custom-frontend-url]/erp5, then proceed to fixing site consistencies. To do this, head to My Favorities > Check Site Consistency. Select all and click Fix Site Consistencies. This will adapt your ERP5 instance to the environment it was installed on and ensure all components are up to date and installed correctly.

Wendelin-ERP5 Fix Consistencies

Fixing consistencies takes a few minutes, so refresh the page from time to time to see when your instance is ready.

Requesting a Webrunner with ERP5 - ERP5 Interface

After that your ERP5 instance is ready to use. You should now continue to adapt your ERP5 instance using the run the configurator.

Getting A webrunner with ERP5 preinstalled

The following steps will help you getting your instance:

  • Go to https://slapos.vifib.com/
  • Create an account.
  • For fast tracking account validation, file a ticket under the "help" section and ask for validation.
  • Once validated, add a new service called "SlapOS Web Runner (latest version)"
  • Enter the following Parameters for ERP5 (found here).
    
    Partition Amount: 15
    Pre-selected Software Release: software/erp5
    Automatically Deploy Software: true
    Automatically Deploy Instances: true
    Automatically Run Sofware/Instance: true
    Deployed Instance Software Type: create-erp5-site
    Custom Frontend Backend URL: <Leave empty, fill after instance creation, see below>
    Custom Frontend Backend Type: zope
  • Once done you should have a number of URLs available describe here.
  • Use the url (12) and Init User (7) and Init Password (6) to login to your Webrunner (initial setup described here). When accessing your Webrunner, your software release should be compiling already. This will take some hours. After the software release is compiled, the erp5 instance will be created. In the Log tab you can see the progress. Request the service by clicking on the green triangle (it will take a few hours). Note that when your account needs to be validated, your Webrunner instance may be generated, but ERP5 may not be built automatically. In this case, once you log into your Webrunner and access the Services tab, the connection information may be empty. Press the green play button to trigger compilation and instantiation manually.
  • Make sure to check "Services" > "Parameters" tab. The value of the field "Software Type of main instance" should be "create-erp5-site". If it is not, change it and then redploy service by clicking the green triangle again.
  • After your instance has been created, check the tab "Services" > "Connection Information". Here you will find a json dictionary parameter with the key family-default-v6 or just family-default. The URL will look something like https://[2001:67c:1254:e:b7::8680]:2151. Copy this url and paste into the Custom Frontend Backend URL Slapos Parameters which you left empty before.
  • When you refresh the web page of you slapos service after some time a new Connection Parameter should appear: custom-frontend-url(if it is empty, wait a bit more). Append "/erp5" to this link to access you new erp5 instance. You will find the initial user name ("zope") and the initial password of your instance in the "Services" > "Connection Information" tab of your webrunner.

Note: Should your instance not setup correctly or start, check the parameter tab in your WebRunner and try adding this parameter (key must be "_"), then re-instantiate by clicking the green triangle.

"_" : {
  "timezone": "UTC",
  "site-id": "erp5",
  "zope-partition-dict": {
    "admin": {
      "family": "admin",
      "thread-amount": 10,
      "port-base": 2210,
      "instance-count": 1
    }
  }
}

Once you are able to access your instance using the custom-frontend-url and the inituser/initpassword provided via the Services tab, too, please login to ERP5 and before you do anything, fix consistencies. To do this, go to My Favorites > Check Site Consistency. Select all and click Fix Site Consistencies. This will adapt your ERP5 instance to the environment it was installed on and ensure all components are up to date and installed correctly.

After that your ERP5 instance is ready to use. You should now continue to fix site consitencies to adapt your ERP5 instance to the environment it was installed on and then run the configurator to configure your instance.

${related_subject_list}