Wallogit.com
2017 © Pedro Peláez
Zero-Dependency PHP Client Library for Consul
, (*1)
PHP client for the Consul HTTP API, (*2)
This library is loosely based upon the official GO client., (*3)
| PHPConsulAPI Version | Consul Version |
|---|---|
| 0.3.x | 0.6.4 |
| 0.6.x | 0.7-0.8 |
| v1.x | 0.9-current |
| v2.x | 0.9-current |
| dev-main | current |
Newer versions of the api lib will probably work in a limited capacity with older versions of Consul, but no guarantee is made and backwards compatibility issues will not be addressed., (*4)
This lib is designed to be used with Composer, (*5)
Require Entry:, (*6)
{
"require": {
"dcarbone/php-consul-api": "^v2.0"
}
}
First, construct a Config. This class is modeled quite closely after the Config Struct present in the Consul API Subpackage., (*7)
If you have defined some of the Consul Environment Variables on your hosts then it would probably be easiest to simply execute the following:, (*8)
$config = \DCarbone\PHPConsulAPI\Config::newDefaultConfig();
You may alternatively define values yourself:, (*9)
$config = new \DCarbone\PHPConsulAPI\Config([
'HttpClient' => $client, // [required] Client conforming to GuzzleHttp\ClientInterface
'Address' => 'address of server', // [required]
'Scheme' => 'http or https', // [optional] defaults to "http"
'Datacenter' => 'name of datacenter', // [optional]
'HttpAuth' => 'user:pass', // [optional]
'WaitTime' => '0s', // [optional] amount of time to wait on certain blockable endpoints. go time duration string format.
'Token' => 'auth token', // [optional] default auth token to use
'TokenFile' => 'file with auth token', // [optional] file containing auth token string
'InsecureSkipVerify' => false, // [optional] if set to true, ignores all SSL validation
'CAFile' => '', // [optional] path to ca cert file, see http://docs.guzzlephp.org/en/latest/request-options.html#verify
'CertFile' => '', // [optional] path to client public key. if set, requires KeyFile also be set
'KeyFile' => '', // [optional] path to client private key. if set, requires CertFile also be set
'JSONEncodeOpts'=> 0, // [optional] php json encode opt value to use when serializing requests
]);
By default, this client will attempt to locate a series of environment variables to describe much of the above configuration properties. See here for that list, and see here for a list of the env var names., (*10)
For more advanced client configuration, such as proxy configuration, you must construct your own GuzzleHttp client prior to constructing a PHPConsulAPI Config object., (*11)
As an example:, (*12)
$proxyClient = new \GuzzleHttp\Client(['proxy' => 'whatever proxy you want']]);
$config = new \DCarbone\PHPConsulAPI\Config([
'HttpClient' => $proxyClient,
'Address' => 'address of server',
]);
When constructing your client, if you are using the GuzzleHttp\Client object directly or derivative thereof, you may
pass any option listed in the Guzzle Request Options., (*13)
Next, construct a Consul object:, (*14)
$consul = new \DCarbone\PHPConsulAPI\Consul($config);
NOTE: If you do not create your own config object, Consul will create it's own using Config::newDefaultConfig() and attempt to locate a suitable HTTP Client., (*15)
Once constructed, you interact with each Consul API via it's corresponding Client class:, (*16)
$kvResp = $consul->KV->Keys();
if (null !== $kvResp->Err) {
die($kvResp->Err);
}
var_dump($kvResp->Value);
...as an example., (*17)
More will be added as time goes on!, (*18)
The testing suite is still in it's infancy, however it is being tested directly against an actual Consul agent. They will be back-filled as time allows. Future plans are to set up a simple cluster to provide a more real-world testing scenario., (*19)
Zero-Dependency PHP Client Library for Consul
Apache-2.0
consul
Zero-Dependency PHP Client Library for Consul
Apache-2.0
consul