Updates for Kubernetes Deployments

.dockerignore

@@ -0,0 +1,2 @@
+/vendor
+/node_modules

Dockerfile

@@ -0,0 +1,160 @@
+# Create args for PHP extensions and PECL packages we need to install.
+# This makes it easier if we want to install packages,
+# as we have to install them in multiple places.
+# This helps keep ou Dockerfiles DRY -> https://bit.ly/dry-code
+# You can see a list of required extensions for Laravel here: https://laravel.com/docs/8.x/deployment#server-requirements
+ARG PHP_EXTS="bcmath ctype fileinfo mbstring pdo pdo_mysql tokenizer dom pcntl exif"
+ARG PHP_PECL_EXTS="redis"
+
+# We need to build the Composer base to reuse packages we've installed
+FROM composer:2.1 as composer_base
+
+# We need to declare that we want to use the args in this build step
+ARG PHP_EXTS
+ARG PHP_PECL_EXTS
+
+# First, create the application directory, and some auxilary directories for scripts and such
+RUN mkdir -p /opt/apps/laravel-in-kubernetes /opt/apps/laravel-in-kubernetes/bin
+
+# Next, set our working directory
+WORKDIR /opt/apps/laravel-in-kubernetes
+
+# We need to create a composer group and user, and create a home directory for it, so we keep the rest of our image safe,
+# And not accidentally run malicious scripts
+RUN addgroup -S composer \
+    && adduser -S composer -G composer \
+    && chown -R composer /opt/apps/laravel-in-kubernetes \
+    && apk add --virtual build-dependencies --no-cache ${PHPIZE_DEPS} openssl ca-certificates libxml2-dev oniguruma-dev \
+    && docker-php-ext-install -j$(nproc) ${PHP_EXTS} \
+    && pecl install ${PHP_PECL_EXTS} \
+    && docker-php-ext-enable ${PHP_PECL_EXTS} \
+    && apk del build-dependencies
+
+# Next we want to switch over to the composer user before running installs.
+# This is very important, so any extra scripts that composer wants to run,
+# don't have access to the root filesystem.
+# This especially important when installing packages from unverified sources.
+USER composer
+
+# Copy in our dependency files.
+# We want to leave the rest of the code base out for now,
+# so Docker can build a cache of this layer,
+# and only rebuild when the dependencies of our application changes.
+COPY --chown=composer composer.json composer.lock ./
+
+# Install all the dependencies without running any installation scripts.
+# We skip scripts as the code base hasn't been copied in yet and script will likely fail,
+# as `php artisan` available yet.
+# This also helps us to cache previous runs and layers.
+# As long as comoser.json and composer.lock doesn't change the install will be cached.
+RUN composer install --no-dev --no-scripts --no-autoloader --prefer-dist
+
+# Copy in our actual source code so we can run the installation scripts we need
+# At this point all the PHP packages have been installed,
+# and all that is left to do, is to run any installation scripts which depends on the code base
+COPY --chown=composer . .
+
+# Now that the code base and packages are all available,
+# we can run the install again, and let it run any install scripts.
+RUN composer install --no-dev --prefer-dist
+
+# For the frontend, we want to get all the Laravel files,
+# and run a production compile
+FROM node:14 as frontend
+
+# We need to copy in the Laravel files to make everything is available to our frontend compilation
+COPY --from=composer_base /opt/apps/laravel-in-kubernetes /opt/apps/laravel-in-kubernetes
+
+WORKDIR /opt/apps/laravel-in-kubernetes
+
+# We want to install all the NPM packages,
+# and compile the MIX bundle for production
+RUN npm install && \
+    npm run prod
+
+# For running things like migrations, and queue jobs,
+# we need a CLI container.
+# It contains all the Composer packages,
+# and just the basic CLI "stuff" in order for us to run commands,
+# be that queues, migrations, tinker etc.
+FROM php:8.0-alpine as cli
+
+# We need to declare that we want to use the args in this build step
+ARG PHP_EXTS
+ARG PHP_PECL_EXTS
+
+WORKDIR /opt/apps/laravel-in-kubernetes
+
+# We need to install some requirements into our image,
+# used to compile our PHP extensions, as well as install all the extensions themselves.
+# You can see a list of required extensions for Laravel here: https://laravel.com/docs/8.x/deployment#server-requirements
+RUN apk add --virtual build-dependencies --no-cache ${PHPIZE_DEPS} openssl ca-certificates libxml2-dev oniguruma-dev && \
+    docker-php-ext-install -j$(nproc) ${PHP_EXTS} && \
+    pecl install ${PHP_PECL_EXTS} && \
+    docker-php-ext-enable ${PHP_PECL_EXTS} && \
+    apk del build-dependencies
+
+# Next we have to copy in our code base from our initial build which we installed in the previous stage
+COPY --from=composer_base /opt/apps/laravel-in-kubernetes /opt/apps/laravel-in-kubernetes
+COPY --from=frontend /opt/apps/laravel-in-kubernetes/public /opt/apps/laravel-in-kubernetes/public
+
+# We need a stage which contains FPM to actually run and process requests to our PHP application.
+FROM php:8.0-fpm-alpine as fpm_server
+
+# We need to declare that we want to use the args in this build step
+ARG PHP_EXTS
+ARG PHP_PECL_EXTS
+
+WORKDIR /opt/apps/laravel-in-kubernetes
+
+RUN apk add --virtual build-dependencies --no-cache ${PHPIZE_DEPS} openssl ca-certificates libxml2-dev oniguruma-dev && \
+    docker-php-ext-install -j$(nproc) ${PHP_EXTS} && \
+    pecl install ${PHP_PECL_EXTS} && \
+    docker-php-ext-enable ${PHP_PECL_EXTS} && \
+    apk del build-dependencies
+
+# We have to copy in our code base from our initial build which we installed in the previous stage
+COPY --from=composer_base --chown=www-data /opt/apps/laravel-in-kubernetes /opt/apps/laravel-in-kubernetes
+COPY --from=frontend --chown=www-data /opt/apps/laravel-in-kubernetes/public /opt/apps/laravel-in-kubernetes/public
+
+# We want to cache the event, routes, and views so we don't try to write them when we are in Kubernetes.
+# Docker builds should be as immutable as possible, and this removes a lot of the writing of the live application.
+RUN php artisan event:cache && \
+    php artisan route:cache && \
+    php artisan view:cache
+
+# As FPM uses the www-data user when running our application,
+# we need to make sure that we also use that user when starting up,
+# so our user "owns" the application when running
+USER  www-data
+
+# We need an nginx container which can pass requests to our FPM container,
+# as well as serve any static content.
+FROM nginx:1.20-alpine as web_server
+
+WORKDIR /opt/apps/laravel-in-kubernetes
+
+# We need to add our NGINX template to the container for startup,
+# and configuration.
+COPY docker/nginx.conf.template /etc/nginx/templates/default.conf.template
+
+# Copy in ONLY the public directory of our project.
+# This is where all the static assets will live, which nginx will serve for us.
+COPY --from=frontend /opt/apps/laravel-in-kubernetes/public /opt/apps/laravel-in-kubernetes/public
+
+# We need a CRON container to the Laravel Scheduler.
+# We'll start with the CLI container as our base,
+# as we only need to override the CMD which the container starts with to point at cron
+FROM cli as cron
+
+WORKDIR /opt/apps/laravel-in-kubernetes
+
+# We want to create a laravel.cron file with Laravel cron settings, which we can import into crontab,
+# and run crond as the primary command in the forground
+RUN touch laravel.cron && \
+    echo "* * * * * cd /opt/apps/laravel-in-kubernetes && php artisan schedule:run" >> laravel.cron && \
+    crontab laravel.cron
+
+CMD ["crond", "-l", "2", "-f"]
+
+FROM cli

Makefile

@@ -0,0 +1,26 @@
+# VERSION defines the version for the docker containers.
+# To build a specific set of containers with a version,
+# you can use the VERSION as an arg of the docker build command (e.g make docker VERSION=0.0.2)
+VERSION ?= v0.0.1
+
+# REGISTRY defines the registry where we store our images.
+# To push to a specific registry,
+# you can use the REGISTRY as an arg of the docker build command (e.g make docker REGISTRY=my_registry.com/username)
+# You may also change the default value if you are using a different registry as a default
+REGISTRY ?= registry.gitlab.com/laravel-in-kubernetes/laravel-app/laravel.io
+
+
+# Commands
+docker: docker-build docker-push
+
+docker-build:
+	docker build . --target cli -t ${REGISTRY}/cli:${VERSION}
+	docker build . --target cron -t ${REGISTRY}/cron:${VERSION}
+	docker build . --target fpm_server -t ${REGISTRY}/fpm_server:${VERSION}
+	docker build . --target web_server -t ${REGISTRY}/web_server:${VERSION}
+
+docker-push:
+	docker push ${REGISTRY}/cli:${VERSION}
+	docker push ${REGISTRY}/cron:${VERSION}
+	docker push ${REGISTRY}/fpm_server:${VERSION}
+	docker push ${REGISTRY}/web_server:${VERSION}

app/Providers/AppServiceProvider.php

@@ -7,13 +7,37 @@
 use App\Models\Thread;
 use App\Models\User;
 use Illuminate\Database\Eloquent\Relations\Relation;
+use Illuminate\Database\Events\MigrationsEnded;
+use Illuminate\Database\Events\MigrationsStarted;
+use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Event;
+use Illuminate\Support\Facades\URL;
 use Illuminate\Support\ServiceProvider;
 use Laravel\Horizon\Horizon;
 
 class AppServiceProvider extends ServiceProvider
 {
+    /**
+     * Register any application services.
+     *
+     * @return void
+     */
+    public function register()
+    {
+        // https://github.com/laravel/framework/issues/33238#issuecomment-897063577
+        Event::listen(MigrationsStarted::class, function () {
+            DB::statement('SET SESSION sql_require_primary_key=0');
+        });
+        Event::listen(MigrationsEnded::class, function () {
+            DB::statement('SET SESSION sql_require_primary_key=1');
+        });
+    }
+
     public function boot()
     {
+        if($this->app->environment('production')) {
+            URL::forceScheme('https');
+        }
         $this->bootEloquentMorphs();
         $this->bootMacros();
         $this->bootHorizon();

config/logging.php

@@ -41,6 +41,16 @@
             'ignore_exceptions' => false,
         ],
 
+        'stdout' => [
+            'driver' => 'monolog',
+            'level' => env('LOG_LEVEL', 'debug'),
+            'handler' => StreamHandler::class,
+            'formatter' => env('LOG_STDOUT_FORMATTER'),
+            'with' => [
+                'stream' => 'php://stdout',
+            ],
+        ],
+
         'single' => [
             'driver' => 'single',
             'path' => storage_path('logs/laravel.log'),