Skip to content
/ kloud Public
forked from kiboko-labs/kloud

Build and manage your development Docker stack for @orocommerce, OroCRM, OroPlatform and MArello applications

License

Notifications You must be signed in to change notification settings

diglin/kloud

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Docker images and stacks for Oro and Marello development

This project aims at building your Docker stack for OroCommerce, OroCRM, OroPlatform and Marello development.

⚠️ Nota: Those stacks are not suited for production hosting, but to provide an environment based on Docker as identical as possible to OroCloud on a personal computer.

Requirements:

  • PHP 7.4

Installation

Installing system-wide the kloud command

While installing system-wide, you will need administrator privilleges to install the command inside /usr/local/bin/ directory.

sudo curl -L -o /usr/local/bin/kloud https://github.com/kiboko-labs/docker-images/releases/latest/download/kloud.phar
sudo curl -L -o /usr/local/bin/kloud.pubkey https://github.com/kiboko-labs/docker-images/releases/latest/download/kloud.phar.pubkey
sudo chmod +x /usr/local/bin/kloud

Installing the Phar package in your project

While installing in your project, no administrator privilege is required, the phar package will be available in the bin/ directory.

curl -L -o bin/kloud.phar https://github.com/kiboko-labs/docker-images/releases/latest/download/kloud.phar
curl -L -o bin/kloud.phar.pubkey https://github.com/kiboko-labs/docker-images/releases/latest/download/kloud.phar.pubkey
chmod +x bin/kloud.phar

We also recommend to add both files to your .gitignore file.

If you want to use the pre-packaged docker image

If you do not want to install the command on your machine, a Docker image is ready for one-shot usages and can be executed this way:

docker run --rm -ti -v /var/run/docker.sock:/var/run/docker.sock \
    -v $HOME/.docker:/opt/docker/.docker \
    -v $PWD:/app \
    kiboko/kloud <command>

Usage

Initialize your stack

In a new project, after cloning the original application repository, you can initialize the Docker stack configuration you will need. You can invoke the following command that will guess what you need and a wizard will ask you a few questions about your preferences:

kloud stack:init

Available command line options

  • Database engine selection

    • --mysql: Set up the application to use MySQL.
    • --postgresql: Set up the application to use PostgreSQL.
  • Xdebug a debugger for PHP

    • --with-xdebug: Set up the application to use Xdebug.
    • --without-xdebug: Set up the application without Xdebug.
  • Blackfire an APM for PHP performance optimizations

    • --with-blackfire: Set up the application to use Blackfire.
    • --without-blackfire: Set up the application without Blackfire.
  • Dejavu, An ElasticSearch UI

    • --with-dejavu: Set up the application to use Dejavu UI.
    • --without-dejavu: Set up the application without Dejavu UI.
  • Elastic Stack for application logging

    • --with-elastic-stack: Set up the application to use Elastic Stack logging.
    • --without-elastic-stack: Set up the application without Elastic Stack logging.
  • Mac OS optimizations on data volumes

    • --with-macos-optimizations: Set up the application to use Docker for Mac optimizations.
    • --without-macos-optimizations: Set up the application without Docker for Mac optimizations.

Update your stack

In an existing project, you can upgrade the docker stack configuration. automagically. You can invoke the following command that will guess what services needs to be updated and in case of differences, a wizard will ask you what you wish to keep or delete:

kloud stack:update

Build the required images

If you need to build the images you need in a stack, you can execute the following command:

kloud image:build

To enable experimental images, you will need to add option --with-experimental.

Test the required images

If you need to test if the images you are using are following every constraint you would expect:

kloud image:test

Supported versions and flavours

OroPlatform

Community Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.8 πŸŒ…οΈ ❌ ❌ ❌ ❌️ ❌
^1.10 πŸŒ…οΈ ❌ ❌ ❌ ❌️ ❌
^2.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^3.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^4.1 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

Enterprise Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.12 πŸŒ…οΈ ❌ ❌ ❌ ❌️ ❌
^2.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^3.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^4.1 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

OroCRM

Community Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^2.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^3.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^4.1 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

Enterprise Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^2.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^3.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^4.1 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

OroCommerce

Community Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^3.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^4.1 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

Enterprise Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^3.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^4.1 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

Marello

Community Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.5 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^1.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^2.0 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^2.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^2.2 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^3.0 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

Enterprise Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.5 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^1.6 πŸŒ…οΈ πŸŒ…οΈ ❌ ❌ ❌️ ❌
^2.0 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^2.1 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^2.2 ❌ βœ… βœ… ⚠️ ⚠️ ⚠️
^3.0 ❌ ❌ ❌ βœ…οΈ βœ…οΈ ⚠️

Middleware

Community Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.0 ❌ ❌ ❌ ❌️ βœ…οΈ ⚠️

Enterprise Edition

  • βœ… available
  • ❌ no support
  • πŸŒ…οΈ discontinued
  • ⚠️ experimental
Version PHP 5.6 PHP 7.1 PHP 7.2 PHP 7.3 PHP 7.4 PHP 8.0
^1.0 ❌ ❌ ❌ ❌️ βœ…οΈ ⚠️

About

Build and manage your development Docker stack for @orocommerce, OroCRM, OroPlatform and MArello applications

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 77.8%
  • Dockerfile 17.2%
  • Makefile 4.9%
  • Shell 0.1%