Skip to content

Commit 2b79b54

Browse files
committed
Adding basic catalog documentation
1 parent f5adfab commit 2b79b54

File tree

1 file changed

+96
-1
lines changed

1 file changed

+96
-1
lines changed

docs/CATALOG.md

Lines changed: 96 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,99 @@ $catalog = $client->Catalog();
1313

1414
## Actions
1515

16-
###
16+
### Register Node, Service, or Check
17+
18+
For this endpoint, you must first create a [CatalogRegistration](./src/Catalog/CatalogRegistration.php)
19+
object. Below is a quick example on how to do this with a Service:
20+
21+
```php
22+
$catalogRegistration = new \DCarbone\PHPConsulAPI\Catalog\CatalogRegistration(
23+
array(
24+
'Node' => 'name of node',
25+
'Address' => 'address of node',
26+
'Service' => new \DCarbone\PHPConsulAPI\Agent\AgentService(
27+
array(
28+
'Service' => 'dan-no-space-test',
29+
)
30+
)
31+
)
32+
);
33+
34+
list($wm, $err) = $client->Catalog()->register($catalogRegistration);
35+
if (null !== $err)
36+
die($err);
37+
38+
var_dump($wm);
39+
```
40+
41+
### Deregister Node, Service, or Check
42+
43+
For this endpoint, you must first create a [CatalogDeregistration](./src/Catalog/CatalogDeregistration.php)
44+
object. Below is an example of how to deregister the service created above:
45+
46+
```php
47+
48+
$catalogDeregistration = new \DCarbone\PHPConsulAPI\Catalog\CatalogDeregistration(
49+
array(
50+
'Node' => 'name of node',
51+
'Address' => 'address of node',
52+
'ServiceID' => 'dan-no-space-test'
53+
)
54+
);
55+
56+
list($wm, $err) = $client->Catalog()->deregister($catalogDeregistration);
57+
if (null !== $err)
58+
die($err);
59+
60+
var_dump($wm);
61+
```
62+
63+
### List Datacenters
64+
65+
```php
66+
list ($datacenters, $err) = $client->Catalog()->datacenters();
67+
if (null !== $err)
68+
die($err);
69+
70+
var_dump($datacenters);
71+
```
72+
73+
### List Nodes
74+
75+
```php
76+
list($nodes, $qm, $err) = $client->Catalog()->nodes();
77+
if (null !== $err)
78+
die($err);
79+
80+
var_dump($nodes, $qm);
81+
```
82+
83+
### List Services
84+
85+
```php
86+
list($services, $qm, $err) = $client->Catalog()->services();
87+
if (null !== $err)
88+
die($err);
89+
90+
var_dump($services, $qm);
91+
```
92+
93+
### Get Specific Service
94+
95+
```php
96+
list($service, $qm, $err) = $client->Catalog()->service('servicename');
97+
if (null !== $err)
98+
die($err);
99+
100+
var_dump($service, $qm);
101+
```
102+
103+
### Get Specific Node
104+
105+
```php
106+
list($node, $qm, $err) = $client->Catalog()->node('nodename');
107+
if (null !== $err)
108+
die($err);
109+
110+
var_dump($err);
111+
```

0 commit comments

Comments
 (0)