Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/baldurrensch/consul-php
PHP library to interact with consul.io
https://github.com/baldurrensch/consul-php
Last synced: about 1 month ago
JSON representation
PHP library to interact with consul.io
- Host: GitHub
- URL: https://github.com/baldurrensch/consul-php
- Owner: baldurrensch
- License: mit
- Created: 2014-05-07T03:32:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-10-10T20:27:28.000Z (about 10 years ago)
- Last Synced: 2024-08-03T02:06:32.194Z (4 months ago)
- Language: PHP
- Size: 260 KB
- Stars: 23
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-consul - baldurrensch/consul-php
README
Consul.io PHP library
=====================
[](https://travis-ci.org/baldurrensch/consul-php)
[](https://scrutinizer-ci.com/g/baldurrensch/consul-php/)
[](https://scrutinizer-ci.com/g/baldurrensch/consul-php/)
[](https://insight.sensiolabs.com/projects/3efd8a1d-4411-48b6-98e7-c7f685a19b6a)
This is a PHP library for the [consul.io] application. Note that this is in development right now. Feel free to open PRs.
Installation
------------
1. Require the package via composer
```bash
$ composer require "br/consul-php"
```
2. Instantiate the library:
Depending on which part of the library you want to use, instantiate the correct Client:
```php
$client = new \BR\Consul\Agent('http://localhost:8500'); // to issue commands to the local agent
$client = new \BR\Consul\KeyValueStore('http://localhost:8500'); // to access the Key Value Store
```
Usage
-----
### 1. Key/Value Store
Use the `getValue()`, `setValue()` and `deleteValue()` functions of the client. Example:
```php
$client->setValue('myKey', 'myValue');
$client->setValue('myKey', 'myValue', 'datacenter-east'); // Set the value in the datacenter-east datacenter
$client->getValue('myKey');
$client->getValue('myKey', 'datacenter-east'); // Get the value from the datacenter-east datacenter
$client->deleteValue('myKey');
$client->deleteValue('myKey', 'datacenter-east'); // Delete the value from the datacenter-east datacenter
```
### 2. Agent
#### 2.1 Registering a service with the agent
In order to register a service, you have to create a `BR\Consul\Model\Service` object, and pass it to the
`Client::registerService()` function. Example:
```php
$service = new \BR\Consul\Model\Service();
$service->setName('postgres');
$service->setId('postgres-1');
$service->setTags(['master']);
$service->setPort(5432);
$success = $client->registerService($service);
```
#### 2.2 Retrieving a list of all services registered with the agent
You can retrieve a list of services that are registered with the agent. Example:
```php
$services = $service->getServices();
var_dump(count($services));
/** $srv \BR\Consul\Model\Service */
foreach ($services as $srv) {
echo $srv->getName()
}
```
#### 2.3 Removing a service from the agent
```php
$client->deregisterService('postgres-1');
// alternatively
$client->removeService($service);
```
### 3. Catalog
#### 3.1. Get a list of datacenters
```php
$datacenters = $client->getDatacenters();
var_dump(count($datacenters));
/** $datacenter \BR\Consul\Model\Datacenter */
foreach ($datacenters as $datacenter) {
echo $datacenter->getName();
}
```
Tests
-----
Run the unit and functional tests by running `phpunit` in the root of the repository.
[consul.io]: http://www.consul.io/
To run consul, use:
```bash
$ ./consul agent -data-dir . --bootstrap -server
```