Dealroadshow K8S Bundle

This bundle integrates Dealroadshow K8S framework with Symfony 5.

Installation

Use Composer to install this bundle into your Symfony application:

composer require dealroadshow/k8s-bundle

Basic usage

Start by generating your project:

bin/console dealroadshow_k8s:generate:project example

This will create src/K8S/Example directory and App\K8S\Example\ExampleProject PHP class.

Now you may generate your first Kubernetes App (you may think of App like of Helm chart):

bin/console dealroadshow_k8s:generate:app example main

This command will create src/K8S/Example/Apps/Main directory and App\K8S\Example\Apps\Main\MainApp PHP class.

App is an abstraction, which exists in order to group together some Kubernetes manifests, like Deployments, CronJobs or ConfigMaps.

Now that we have a project and an app, we can start to define our Kubernetes manifests. Let's start by creating a deployment:

bin/console dealroadshow_k8s:generate:deployment example main nginx

After executing this command you'll see a new class App\K8S\Example\Apps\Main\Nginx\NginxDeployment.

This new class may look like follows:

<?php

namespace App\K8S\Example\Apps\Main\Nginx;

use Dealroadshow\K8S\Framework\Core\Deployment\AbstractDeployment;
use Dealroadshow\K8S\Framework\Core\LabelSelector\LabelSelectorConfigurator;
use Dealroadshow\K8S\Framework\Core\MetadataConfigurator;
use Dealroadshow\K8S\Framework\Core\Pod\Containers\PodContainers;

class NginxDeployment extends AbstractDeployment
{
    public function labelSelector(LabelSelectorConfigurator $selector): void
    {
    }

    public static function name(): string
    {
        return 'nginx';
    }

    public function fileNameWithoutExtension(): string
    {
        return 'nginx.deployment';
    }

    public function configureMeta(MetadataConfigurator $meta): void
    {
    }

    public function containers(PodContainers $containers): void
    {
    }
}

Let's start by implementing some of existing methods and some others, from basic class:

<?php

namespace App\K8S\Example\Apps\Main\Nginx;

use Dealroadshow\K8S\Framework\Core\Container\AbstractContainer;
use Dealroadshow\K8S\Framework\Core\Container\Env\EnvConfigurator;
use Dealroadshow\K8S\Framework\Core\Container\Image\Image;
use Dealroadshow\K8S\Framework\Core\Deployment\AbstractDeployment;
use Dealroadshow\K8S\Framework\Core\Container\Resources\CPU;
use Dealroadshow\K8S\Framework\Core\Container\Resources\Memory;
use Dealroadshow\K8S\Framework\Core\Container\Resources\ResourcesConfigurator;
use Dealroadshow\K8S\Framework\Core\LabelSelector\LabelSelectorConfigurator;
use Dealroadshow\K8S\Framework\Core\MetadataConfigurator;
use Dealroadshow\K8S\Framework\Core\Pod\Containers\PodContainers;

class NginxDeployment extends AbstractDeployment
{
    public function labelSelector(LabelSelectorConfigurator $selector): void
    {
        $selector
            ->addLabel('app', 'example-app')
            ->addLabel('component', 'my-first-deployment')
        ;
    }

    public static function name(): string
    {
        return 'nginx';
    }

    public function fileNameWithoutExtension(): string
    {
        return 'nginx.deployment';
    }

    public function configureMeta(MetadataConfigurator $meta): void
    {
    }

    public function containers(PodContainers $containers): void
    {
        $container = new class extends AbstractContainer {
            public function name(): string
            {
                return 'nginx';
            }

            public function image(): Image
            {
                return Image::fromName('nginx');
            }
            
            public function resources(ResourcesConfigurator $resources): void
            {
                $resources
                    ->requestCPU(CPU::millicores(500))
                    ->limitCPU(CPU::cores(2))
                    ->requestMemory(Memory::mebibytes(128))
                    ->limitMemory(Memory::mebibytes(256))
                ;
            }

            public function env(EnvConfigurator $env): void
            {
                $env
                    ->var('APP_NAME', 'nginx-example-app')
                ;
            }
        };
        
        $containers->add($container);
    }
}

We've defined a basic deployment, and we can generate Yaml manifest from it:

bin/console dealroadshow_k8s:dump:project example-project

Now you can see your Yaml manifest in Resources/k8s-manifests directory inside your project. Nice!