This package is not installable via Composer 1.x, please make sure you upgrade to Composer 2+. Read more about our Composer 1.x deprecation policy.

OPSCode Chef API library

2.3.1 2021-04-26 18:40 UTC

This package is auto-updated.

Last update: 2021-04-26 18:41:28 UTC


README

The Chef Server API is used to provide access to objects on the Chef Server, including nodes, environments, roles, cookbooks (and cookbook versions), and to manage an API client list and the associated RSA public key-pairs.

This is a generic library and has additional support for the Laravel framework.

Installation

Add andreseko/chef as a requirement to composer.json:

{
    "require": {
        "andreseko/chef": "^v1.0.0"
    }
}

Update your packages with composer update or install with composer install.

Usage

Create a chef object like this:

// composer
require_once 'vendor/autoload.php';
use Andreseko\Chef\Chef;

// create chef object
$chef = new Chef($server, $client, $key, $version);

// API request
$response = $chef->api($endpoint, $method, $data);

See http://docs.opscode.com/api_chef_server.html for all available endpoints.

Examples

Get nodes:

$nodes = $chef->get('/nodes');

Create a data bag:

$bag = new stdClass;
$bag->name = "test";

$resp = $chef->post('/data', $bag);

Update a node:

$node = $chef->get('/nodes/webserver1');
$node->attributes->type = "webserver";

$chef->put('/nodes/webserver1', $node);

Delete a data bag:

$chef->delete('/data/test/item');

Laravel

Register the Chef package with Laravel in app/config/app.php, add the following provider:

'Andreseko\Chef\ChefServiceProvider',

And this alias:

'Chef'            => 'Andreseko\Chef\Facades\Chef'

Create a copy of the configuration file using Artisan:

php artisan config:publish Andreseko/chef

Edit the created configuration file in app/config/packages/andreseko/chef/config.php to match your environment:

'server'  = the URL for the Chef Server
'client'  = the name used when authenticating to a Chef Server
'key'     = the location of the file which contains the client key
'version' = the version of the Chef Server API that is being used