Merge pull request #275 from luciano-jr/feature/aerospike-cache

Feature/aerospike cache

README.md

@@ -120,6 +120,7 @@ Let's see how easy it is to install `NGINX`, `PHP`, `Composer`, `MySQL` and `Red
 - **Cache Engines:**
 	- Redis
 	- Memcached
+	- Aerospike
 - **PHP Servers:**
 	- NGINX
 	- Apache2
@@ -250,7 +251,7 @@ docker-compose up -d  nginx mysql
 
 You can select your own combination of Containers form the list below:
 
-`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `workspace`, `phpmyadmin`.
+`nginx`, `hhvm`, `php-fpm`, `mysql`, `redis`, `postgres`, `mariadb`, `neo4j`, `mongo`, `apache2`, `caddy`, `memcached`, `beanstalkd`, `beanstalkd-console`, `rabbitmq`, `workspace`, `phpmyadmin`, `aerospike`.
 
 
 **Note**: `workspace` and `php-fpm` will run automatically in most of the cases, so no need to specify them in the `up` command.
@@ -995,7 +996,40 @@ It should be like this:
 
 3 - Re-build the container `docker-compose build workspace`
 
+<br>
+<a name="Install-Aerospike-Extension"></a>
+### Install Aerospike extension
 
+1 - First install `aerospike` in the Workspace and the PHP-FPM Containers:
+<br>
+a) open the `docker-compose.yml` file
+<br>
+b) search for the `INSTALL_AEROSPIKE_EXTENSION` argument under the Workspace Container
+<br>
+c) set it to `true`
+<br>
+d) search for the `INSTALL_AEROSPIKE_EXTENSION` argument under the PHP-FPM Container
+<br>
+e) set it to `true`
+
+It should be like this:
+
+```yml
+    workspace:
+        build:
+            context: ./workspace
+            args:
+                - INSTALL_AEROSPIKE_EXTENSION=true
+    ...
+    php-fpm:
+        build:
+            context: ./php-fpm
+            args:
+                - INSTALL_AEROSPIKE_EXTENSION=true
+    ...
+```
+
+2 - Re-build the containers `docker-compose build workspace php-fpm`
 
 <br>
 <a name="debugging"></a>

aerospike/Dockerfile

@@ -0,0 +1,7 @@
+FROM aerospike:latest
+
+MAINTAINER Luciano Jr <luciano@lucianojr.com.br>
+
+RUN rm /etc/aerospike/aerospike.conf
+
+ADD aerospike.conf /etc/aerospike/aerospike.conf

aerospike/aerospike.conf

@@ -0,0 +1,77 @@
+# Aerospike database configuration file.
+
+# This stanza must come first.
+service {
+	user root
+	group root
+	paxos-single-replica-limit 1 # Number of nodes where the replica count is automatically reduced to 1.
+	pidfile /var/run/aerospike/asd.pid
+	service-threads 4
+	transaction-queues 4
+	transaction-threads-per-queue 4
+	proto-fd-max 15000
+}
+
+logging {
+
+	# Log file must be an absolute path.
+	file /var/log/aerospike/aerospike.log {
+		context any info
+	}
+
+	# Send log messages to stdout
+	console {
+		context any critical
+	}
+}
+
+network {
+	service {
+		address any
+		port 3000
+
+		# Uncomment the following to set the `access-address` parameter to the
+		# IP address of the Docker host. This will the allow the server to correctly
+		# publish the address which applications and other nodes in the cluster to
+		# use when addressing this node.
+		# access-address <IPADDR>
+	}
+
+	heartbeat {
+
+		# mesh is used for environments that do not support multicast
+		mode mesh
+		port 3002
+
+		# use asinfo -v 'tip:host=<ADDR>;port=3002' to inform cluster of
+		# other mesh nodes
+		mesh-port 3002
+
+		interval 150
+		timeout 10
+	}
+
+	fabric {
+		port 3001
+	}
+
+	info {
+		port 3003
+	}
+}
+
+namespace test {
+	replication-factor 2
+	memory-size 1G
+	default-ttl 5d # 5 days, use 0 to never expire/evict.
+
+	#	storage-engine memory
+
+	# To use file storage backing, comment out the line above and use the
+	# following lines instead.
+	storage-engine device {
+		file /opt/aerospike/data/test.dat
+		filesize 4G
+		data-in-memory true # Store data in memory in addition to file.
+	}
+}

docker-compose.yml

@@ -12,6 +12,7 @@ services:
                 - INSTALL_MONGO=false
                 - INSTALL_NODE=false
                 - INSTALL_DRUSH=false
+                - INSTALL_AEROSPIKE_EXTENSION=false
                 - COMPOSER_GLOBAL_INSTALL=false
                 - INSTALL_WORKSPACE_SSH=false
                 - PUID=1000
@@ -37,6 +38,7 @@ services:
                 - INSTALL_ZIP_ARCHIVE=false
                 - INSTALL_MEMCACHED=false
                 - INSTALL_OPCACHE=false
+                - INSTALL_AEROSPIKE_EXTENSION=false
             dockerfile: Dockerfile-70
         volumes_from:
             - volumes_source
@@ -47,6 +49,8 @@ services:
         extra_hosts:
             # IMPORTANT: Replace with your Docker Host IP (will be appended to /etc/hosts)
             - "dockerhost:10.0.75.1"
+        ports:
+            - "22:22"
         environment:
             # IMPORTANT: Set the Remote Interpreter entry matching name to `laravel`
             - PHP_IDE_CONFIG="serverName=laravel"
@@ -167,6 +171,20 @@ services:
         ports:
             - "6379:6379"
 
+### Aerospike c Container #########################################
+
+    aerospike:
+        build: ./aerospike
+        volumes_from:
+            - workspace
+            - volumes_data
+        ports:
+            - "3000:3000"
+            - "3001:3001"
+            - "3002:3002"
+            - "3003:3003"
+            
+
 ### Memcached Container #####################################
 
     memcached:
@@ -268,6 +286,7 @@ services:
             - ./data/redis:/data
             - ./data/neo4j:/var/lib/neo4j/data
             - ./data/mongo:/data/db
+            - ./data/aerospike:/opt/aerospike/data
             - ./data/sessions:/sessions
 
 ### Add more Containers below ###############################

php-fpm/Dockerfile-70

@@ -94,6 +94,28 @@ RUN if [ ${INSTALL_MEMCACHED} = true ]; then \
     && docker-php-ext-enable memcached \
 ;fi
 
+#####################################
+# PHP Aerospike:
+#####################################
+
+ARG INSTALL_AEROSPIKE_EXTENSION=true
+ENV INSTALL_AEROSPIKE_EXTENSION ${INSTALL_AEROSPIKE_EXTENSION}
+# Copy aerospike configration for remote debugging
+COPY ./aerospike.ini /usr/local/etc/php/conf.d/aerospike.ini
+RUN if [ ${INSTALL_AEROSPIKE_EXTENSION} = true ]; then \
+    # Install the php aerospike extension
+    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/luciano-jr/aerospike-client-php/archive/master.tar.gz" \
+    && mkdir -p aerospike-client-php \
+    && tar -C aerospike-client-php -zxvf /tmp/aerospike-client-php.tar.gz --strip 1 \
+    && ( \
+        cd aerospike-client-php/src/aerospike \
+        && phpize \
+        && ./build.sh \
+        && make install \
+    ) \
+    && rm /tmp/aerospike-client-php.tar.gz \
+;fi
+
 #####################################
 # Opcache:
 #####################################
@@ -122,4 +144,4 @@ WORKDIR /var/www/laravel
 
 CMD ["php-fpm"]
 
-EXPOSE 9000
+EXPOSE 9000

php-fpm/aerospike.ini

@@ -0,0 +1,3 @@
+extension=aerospike.so
+aerospike.udf.lua_system_path=/usr/local/aerospike/lua
+aerospike.udf.lua_user_path=/usr/local/aerospike/usr-lua

workspace/Dockerfile

@@ -49,6 +49,7 @@ ARG INSTALL_XDEBUG=true
 ENV INSTALL_XDEBUG ${INSTALL_XDEBUG}
 RUN if [ ${INSTALL_XDEBUG} = true ]; then \
     # Load the xdebug extension only with phpunit commands
+    apt-get update && \
     apt-get install -y --force-yes php7.0-xdebug && \
     sed -i 's/^/;/g' /etc/php/7.0/cli/conf.d/20-xdebug.ini && \
     echo "alias phpunit='php -dzend_extension=xdebug.so /var/www/laravel/vendor/bin/phpunit'" >> ~/.bashrc \
@@ -164,6 +165,28 @@ RUN if [ ${INSTALL_NODE} = true ]; then \
     echo '[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"  # This loads nvm' >> ~/.bashrc \
 ;fi
 
+#####################################
+# PHP Aerospike:
+#####################################
+USER root
+ARG INSTALL_AEROSPIKE_EXTENSION=true
+ENV INSTALL_AEROSPIKE_EXTENSION ${INSTALL_AEROSPIKE_EXTENSION}
+# Copy aerospike configration for remote debugging
+COPY ./aerospike.ini /etc/php/7.0/cli/conf.d/aerospike.ini
+RUN if [ ${INSTALL_AEROSPIKE_EXTENSION} = true ]; then \
+    # Install the php aerospike extension
+    curl -L -o /tmp/aerospike-client-php.tar.gz "https://github.com/luciano-jr/aerospike-client-php/archive/master.tar.gz" \
+    && mkdir -p aerospike-client-php \
+    && tar -C aerospike-client-php -zxvf /tmp/aerospike-client-php.tar.gz --strip 1 \
+    && ( \
+        cd aerospike-client-php/src/aerospike \
+        && phpize \
+        && ./build.sh \
+        && make install \
+    ) \
+    && rm /tmp/aerospike-client-php.tar.gz \
+;fi
+
 #
 #--------------------------------------------------------------------------
 # Final Touch

workspace/aerospike.ini

@@ -0,0 +1,3 @@
+extension=aerospike.so
+aerospike.udf.lua_system_path=/usr/local/aerospike/lua
+aerospike.udf.lua_user_path=/usr/local/aerospike/usr-lua

xdebugPhpFpm

@@ -6,12 +6,21 @@
 # Grab full name of php-fpm container
 PHP_FPM_CONTAINER=$(docker-compose ps | grep php-fpm | cut -d" " -f 1)
 
+
+# Grab OS type
+if [[ "$(uname)" == "Darwin" ]]; then
+    OS_TYPE="OSX"
+else
+    OS_TYPE=$(expr substr $(uname -s) 1 5)
+fi
+
+
 xdebug_status ()
 {
     echo 'xDebug status'
 
     # If running on Windows, need to prepend with winpty :(
-    if [[ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]]; then
+    if [[ $OS_TYPE == "MINGW" ]]; then
         winpty docker exec -it $PHP_FPM_CONTAINER bash -c 'php -v'
 
     else
@@ -20,6 +29,7 @@ xdebug_status ()
 
 }
 
+
 xdebug_start ()
 {
     echo 'Start xDebug'
@@ -30,7 +40,7 @@ xdebug_start ()
 
 
     # If running on Windows, need to prepend with winpty :(
-    if [[ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]]; then
+    if [[ $OS_TYPE == "MINGW" ]]; then
         winpty docker exec -it $PHP_FPM_CONTAINER bash -c "${ON_CMD}"
         docker restart $PHP_FPM_CONTAINER
         winpty docker exec -it $PHP_FPM_CONTAINER bash -c 'php -v'
@@ -40,9 +50,9 @@ xdebug_start ()
         docker restart $PHP_FPM_CONTAINER
         docker exec -it $PHP_FPM_CONTAINER bash -c 'php -v'
     fi
-
 }
 
+
 xdebug_stop ()
 {
     echo 'Stop xDebug'
@@ -52,7 +62,7 @@ xdebug_stop ()
 
 
     # If running on Windows, need to prepend with winpty :(
-    if [[ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]]; then
+    if [[ $OS_TYPE == "MINGW" ]]; then
         # This is the equivalent of:
         # winpty docker exec -it laradock_php-fpm_1 bash -c 'bla bla bla'
         # Thanks to @michaelarnauts at https://github.com/docker/compose/issues/593