kytoonlabs/laravel-helm

Laravel wrapper for HELM v3

1.0.2 2024-03-01 00:51 UTC

Requires

• php: ^8.2|^8.3
• illuminate/support: *
• symfony/process: ^6.2

Requires (Dev)

• orchestra/testbench: ^8.2
• phpunit/phpunit: ^9.6

Apache-2.0

• Enrique Ponce de Leon

README

This package provides a wrapper to invoke HELM commands using PHP code.

Installing

Installing can be done through a variety of methods, although Composer is recommended.

Composer (recommended)

Include the following snipped into the composer.json file.

"require": {
  "kytoonlabs/laravel-helm": "^1.0"
}

or by using the composer require command:

composer require kytoonlabs/laravel-helm

Github

Releases are available on Github.

Configuration

In order to use the Laravel Helm package, is required to setup the right path where the HELM binary is located on the server.

Laravel Helm uses the path /usr/local/bin/helm by default, but it can be configured using an environment variable defined into the .env

HELM_BINARY_PATH=/path/to/helm/bynary

Other configurations

# Set the internal `Process` timeout, default=3600
HELM_PROCESS_TIMEOUT=3600

How to use

The current version of the package implements the following commands:

• helm version
• helm install
• helm upgrade
• helm delete

Also implements a method rawCommand where any other command can be executed.

Helm::version

use Kytoonlabs\LaravelHelm\Helm;
...
$helm = Helm::version();
$helm->run();
// Prints the command response for the command 'helm version'
$version = $helm->getOutput();
...

Helm::install($name, $chart, $options, $envs)

Parameters:

• name: installation name (required)
• chart: helm chart (required)
• options: options array (optional)
• envs: environment variables array (optional)

use Kytoonlabs\LaravelHelm\Helm;
...
$helm = Helm::install(
    'releasename',
    'oci://registry-1.docker.io/bitnamicharts/redis',
    [
        "--version" => '16.18.2'
    ]
);
$helm->run();
// To check the command was executed successfully
if ($helm->isSuccessful()) {
    // HELM app installed
    ...
}
...

Helm::upgrade($name, $chart, $options, $envs)

Parameters:

• name: installation name (required)
• chart: helm chart (required)
• options: options array (optional)
• envs: environment variables array (optional)

use Kytoonlabs\LaravelHelm\Helm;
...
$helm = Helm::upgrade(
    'releasename',
    'oci://registry-1.docker.io/bitnamicharts/redis',
    [
        "--version" => '16.18.2',
        '--install'
    ]
);
$helm->run();
// To check the command was executed successfully
if ($helm->isSuccessful()) {
    // HELM app upgraded
    ...
}
...

Helm::delete($name, $options, $envs)

Parameters:

• name: installation name (required)
• options: options array (optional)
• envs: environment variables array (optional)

use Kytoonlabs\LaravelHelm\Helm;
...
$helm = Helm::delete('releasename');
$helm->run();
// To check the command was executed successfully
if ($helm->isSuccessful()) {
    // HELM app uninstalled
    ...
}
...

Helm::rawCommand($command, $options, $envs)

Parameters:

• command: string command to be executed (required)
• options: options array (optional)
• envs: environment variables array (optional)

use Kytoonlabs\LaravelHelm\Helm;
...
// Example using simple commands
$helm = Helm::rawCommand('list');
$helm->run();

// Example using commands with parameters
$helm = Helm::rawCommand('list --all');
$helm->run();

// Example combining with $options
$helm = Helm::rawCommand('list --output json', ['--all']);
$helm->run();
...

Parsing $options array

The most of the methods for the Helm object uses the $options array. This is an example how the option are being parsed:

use Kytoonlabs\LaravelHelm\Helm;
...
// Define options array
$options = [
    '--version' => '1.0.0', // include parameters using --name=value
    '--create-namespace', // include single --parameters
    'app.host' => 'https://10.0.0.1', // values from values.yaml file
    '-n' => 'default', // -name value parameters
    '-A', // single - parameters
    'dry-run' // fix invalid inputs 
];
$helm = Helm::install(
    'myredis',
    'oci://registry-1.docker.io/bitnamicharts/redis',
    $options
);
$helm->run();
// the command parsed will be:
// helm install myredis oci://registry-1.docker.io/bitnamicharts/redis --version=1.0.0 
//   --create-namespace --set app.host=https://10.0.0.1 -n default -A --dry-run
...

Injecting environment variables using $envs

If is required to include environment variables to the helm execution context, this can be done using the $envs array.

use Kytoonlabs\LaravelHelm\Helm;
...
// List all helm applications pointing to a different cluster
$helm = Helm::rawCommand(
    'list --all',
    [],
    [
        'KUBECONFIG' => '/path/to/another/cluster/kubeconfig'
    ]
);
// Executing helm with the KUBECONFIG env vars enabled
$helm->run();
...

Testing

In order to validate that the package is fully functional always we can run:

composer test

License

Laravel Helm package is licensed under the Apache 2.0. See the LICENSE file for details.

Support

Issues can be opened directly in Github.