Skip to content

CloudI/CloudI

develop
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
src
 
 
 
 
 
 

CloudI 2.0.5

Build Status Project Status RSS Twitter IRC Email

LICENSE

MIT License

ABOUT

What is CloudI?

(short answer) "A distributed application server that provides efficient messaging for many programming languages within a single service abstraction that is both scalable and fault-tolerant."

(shorter answer) "A rock-solid transaction processing system for flexible software development."

(shortest answer) "A Cloud at the lowest level."

Who would use CloudI?

Software developers that do not want to get locked into corporate vendors or frameworks that push for perpetual commercial support or licenses.

Why should CloudI be used?

CloudI makes software fault-tolerant and scalable, utilizing Erlang, even if the software is legacy source code. CloudI mitigates software development risk (delays or failures) when making software scale in non-Erlang programming languages, or during a conversion of a software system (fully or partially) to the Erlang programming language.

How should CloudI be used?

The CloudI API provides a simple set of functions for Service-Oriented Architecture (SOA) development in any supported language (currently ATS, C/C++, Erlang/Elixir, Go, Haskell, Java, JavaScript, OCaml, Perl, PHP, Python and Ruby):

  • subscribe, unsubscribe, subscribe_count
  • send_async, send_sync, mcast_async (mcast_async == publish)
  • recv_async
  • return, forward

External communication that needs to scale (beyond 10,000 connections) can use an existing internal CloudI service (implemented in Erlang or Elixir) which may do processing for one or more external CloudI services (implemented in ATS, C/C++, Go, Haskell, Java, JavaScript, OCaml, Perl, PHP, Python and/or Ruby)

Even if external communication doesn't need to scale, private cloud computing tasks (number crunching) can gain fault-tolerance and internal system scalability within CloudI.

Where should I find more information?

Please see the FAQ for more details.

INSTALLATION

Requirements

  • Erlang >= 22.0 (erlang /Ubuntu, erlang /Alpine)
  • C/C++ (C++98 compliant, improved error information with C++11 support)
    • GCC >= 4.9 (g++ /Ubuntu, g++ /Alpine) or clang >= 3.3 (clang /Ubuntu, clang /Alpine)
  • boost >= 1.40.0 (libboost-system-dev libboost-thread-dev libboost-dev /Ubuntu, boost-system boost-thread boost-dev /Alpine)

Optional (default="yes"):

  • C
    • Use the "--enable-c-support=no" configure flag to disable
  • C++
    • CloudI::API::backtrace() function
      • backtrace with backward-cpp (Linux)
        • backtrace symbols options:
          • (libdwarf-dev libelf-dev /Ubuntu, libdwarf libdwarf-dev elfutils-dev /Alpine)
          • (binutils-dev /Ubuntu, binutils-dev /Alpine)
          • (libdw-dev /Ubuntu, elfutils-dev /Alpine)
        • backtrace data options:
          • (libunwind-dev /Ubuntu, libunwind-dev /Alpine)
          • compiler unwind.h
          • (libexecinfo-dev /Alpine)
      • backtrace with boost::stacktrace (boost >= 1.71)
        • (libboost-stacktrace-dev /Ubuntu, boost-stacktrace_basic /Alpine)
      • Use the "--with-cxx-backtrace=no" configure flag to disable
    • Use the "--enable-cxx-support=no" configure flag to disable
  • Java >= 1.5 JDK
    • (default-jdk /Ubuntu, openjdk8 /Alpine)
    • Use the "--enable-java-support=no" configure flag to disable
    • Java CloudI API is available as a Maven package
  • JavaScript >= 0.12.18
    • (nodejs /Ubuntu, nodejs /Alpine)
    • Use the "--enable-javascript-support=no" configure flag to disable
    • JavaScript CloudI API is available as a npm package
  • Perl >= 5.10 (with Compress::Zlib)
    • (perl perl-modules /Ubuntu, perl /Alpine)
    • Use the "--enable-perl-support=no" configure flag to disable
  • PHP >= 7.0
    • (php /Ubuntu, php7 /Alpine)
    • Use the "--enable-php-support=no" configure flag to disable
  • Python >= 2.7.0
    • (python3 python3-dev /Ubuntu, python3 python3-dev /Alpine)
    • Use the "--enable-python-support=no" and "--enable-python-c-support=no" configure flag to disable
    • Python and Python/C CloudI API is available as a PyPI package
  • Ruby >= 1.9.0
    • (ruby /Ubuntu, ruby /Alpine)
    • Use the "--enable-ruby-support=no" configure flag to disable
    • Ruby CloudI API is available as a Ruby gem
  • syscall_lock service configuration option
    • syscall_lock with pledge (OpenBSD)
      • libc unistd.h
    • syscall_lock with libseccomp (Linux)
      • (libseccomp-dev /Ubuntu, libseccomp-dev /Alpine)
  • GNU MP library
    • (libgmp-dev /Ubuntu, gmp-dev /Alpine)
    • Used in the hexpi (C++) integration test only ("--with-integration-tests=no" configure flag to disable)

Optional (default="no"):

  • ATS2/Postiats >= 0.3.13
    • (ats2-lang /Ubuntu)
    • Use the "--enable-ats2-support" configure flag to enable
  • Go >= 1.11
    • (golang /Ubuntu, go /Alpine)
    • Use the "--enable-go-support" configure flag to enable
    • Go CloudI API is available as a remote import
  • Haskell (GHC >= 8.6.0)
    • (ghc zlib1g-dev /Ubuntu, ghc zlib-dev /Alpine)
    • Use the "--enable-haskell-support" configure flag to enable
    • Haskell CloudI API is available as a Hackage package for GHC >= 7.10.3
  • OCaml >= 4.03.0
    • (ocaml /Ubuntu, ocaml /Alpine)
    • Use the "--enable-ocaml-support" configure flag to enable
    • OCaml CloudI API is available as an opam package

Building

For configuration options, see FAQ: 3.2 - Installation Options.

cd src
./configure
make
sudo make install

Running

Within the installation directory the cloudi script controls CloudI.

To start CloudI:

sudo cloudi start

To stop CloudI:

sudo cloudi stop

INTEGRATION

See the Quick Start Guide or the API documentation

Integration points:

Dynamic Configuration and Monitoring:

Routing:

Maintained Services Excluded from this Repository:

Unmaintained Services Excluded from this Repository:

The default CloudI configuration will run the included integration tests if all the programming languages enabled by default are detected at configure time and the --with-integration-tests-ran configuration argument is used (to choose the src/cloudi_tests.conf.in configuration file).

If the --with-integration-tests=no configuration argument is used, the more minimal CloudI configuration will be used instead (in the src/cloudi_minimal.conf.in configuration file) to support basic things like the Quick Start Guide, the Dashboard and any tutorials or examples.

CONTACT

Michael Truog (mjtruog at protonmail dot com)