sadok-f/docker-secrets

Simple PHP library to read docker secrets.

1.0.0 2017-10-20 15:35 UTC

This package is auto-updated.

Last update: 2021-09-11 12:46:49 UTC


README

Build Status Code Climate

Docker Secrets

A simple PHP library to read docker secrets from a Swarm cluster.

Installation

 composer require sadok-f/docker-secrets

Usage

Read All

$dockerSecrets = new DockerSecrets\Reader\SecretsReader();
$allSecrets = $dockerSecrets->readAll();

return:

Array
(
    [my_secret_data_1] => testSecretDataContent1
    [my_secret_data_2] => testSecretDataContent2
)

Read a single secret

$dockerSecrets = new DockerSecrets\Reader\SecretsReader();
$dockerSecrets->read('my_secret');

Custom Location

The default location for secrets folder is to /run/secrets/ in Linux containers. if you're using Docker 17.06 and higher with custom location you can use the library like this example:

$dockerSecrets = new DockerSecrets\Reader\SecretsReader('/var/myCustomLocation');
$dockerSecrets->read('my_secret');

Read secrets in Windows containers

$dockerSecrets = new DockerSecrets\Reader\SecretsReader('C:\ProgramData\Docker\secrets');
$dockerSecrets->read('my_secret');

PHPUnit

./vendor/bin/phpunit