README

这是一个用于 consul.io 应用的 PHP 库。请注意，目前正在开发中。欢迎提交 PR。

安装

1. 通过 composer 安装包

$ composer require "br/consul-php"

1. 实例化库

根据您想使用的库的哪个部分，实例化正确的 Client

$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

用法

1. 键/值存储

使用客户端的 getValue()、setValue() 和 deleteValue() 函数。示例

$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. 代理

2.1 使用代理注册服务

为了注册服务，您必须创建一个 BR\Consul\Model\Service 对象，并将其传递给 Client::registerService() 函数。示例

$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 获取代理中注册的所有服务的列表

您可以获取已注册的服务列表。示例

$services = $service->getServices();
var_dump(count($services));

/** $srv \BR\Consul\Model\Service */
foreach ($services as $srv) {
    echo $srv->getName()
}

2.3 从代理中删除服务

$client->deregisterService('postgres-1');
// alternatively
$client->removeService($service);

3. 目录

3.1 获取数据中心列表

$datacenters = $client->getDatacenters();
var_dump(count($datacenters));

/** $datacenter \BR\Consul\Model\Datacenter */
foreach ($datacenters as $datacenter) {
    echo $datacenter->getName();
}

测试

通过在存储库根目录中运行 phpunit 来运行单元测试和功能测试。

要运行 consul，请使用

$ ./consul agent -data-dir . --bootstrap -server