Consul

EasySwoole提供了一个协程安全的consul协程版本客户端，方便用户做分布式的微服务开发。

安装

composer require easyswoole/consul

使用方式

  • 使用下面的接口方式，都需要先给Consul注入Config配置。
  • 接口只展示用法，具体的命名空间需要开发者自己引入
  2. use EasySwoole\Consul\Config;
  3. use EasySwoole\Consul\Consul;
  5. // config默认  127.0.0.1:8500/v1
  6. $config = new Config([
  7.     'IP'       => '127.0.0.1',
  8.     'port'     => '8500',
  9.     'version'  => 'v1',
  10. ]);
  11. $consul = new Consul($config);
  13. // 两种写法，结果相同
  14. $config = new Config();
  15. $config->setIP('127.0.0.1');
  16. $config->setPort('8500');
  17. $config->setVersion('v1');    
  19. $consul = new Consul($config);

ACLs

  1. // Bootstrap ACLs
  2. $bootstrap = new Bootstrap();
  3. $this->consul->acl()->bootstrap($bootstrap);
  5. // Check ACL Replication
  6. $replication = new Replication();
  7. $this->consul->acl()->replication($replication);
  9. // Translate Rules
  10. // Translate a Legacy Token's Rules
  11. $translate = new Translate([
  12.     'accessor_id' => $accessor_id
  13. ]);
  14. $this->consul->acl()->translate($translate);
  16. // Login to Auth Method
  17. $login = new Login([
  18.     "authMethod" => $authMethod,
  19.     "bearerToken" => $bearerToken
  20. ]);
  21. $this->consul->acl()->login($login);
  23. // Logout from Auth Method
  24. $logout = new Logout([
  25.     'token' => $header['token']
  26. ]);
  27. $this->consul->acl()->logout($logout);

Tokens

  1. // Create a Token
  2. $token = new Token([
  3.     "description" => "Agent token for 'node1'",
  4.     "Policies" => [
  5.         ["ID" => "165d4317-e379-f732-ce70-86278c4558f7"],
  6.         ["Name" => "node-read"],
  7.     ],
  8.     "Local" => false,
  9. ]);
  10. $this->consul->acl()->token($token);
  12. // Read a Token
  13. $token = new Token([
  14.     "AccessorID" => "6a1253d2-1785-24fd-91c2-f8e78c745511"
  15. ]);
  16. $this->consul->acl()->readToken($token);
  18. // Read Self Token
  19. $self = new Token\GetSelf([
  20.     'token' => "6a1253d2-1785-24fd-91c2-f8e78c745511"
  21. ]);
  22. $this->consul->acl()->self($self);
  24. // Update a Token
  25. $update = new Token([
  26.     'accessorID' => '6a1253d2-1785-24fd-91c2-f8e78c745511',
  27.     "Description" => "Agent token for 'node1'",
  28.     "Policies" => [],
  29.     "local" => false
  30. ]);
  31. $this->consul->acl()->updateToken($update);
  33. // Clone a Token
  34. $clone = new Token\CloneToken([
  35.     'accessorID' => '8f246b77-f3e1-ff88-5b48-8ec93abf3e05',
  36.     "description" => "Clone of Agent token for 'node1'",
  37. ]);
  38. $this->consul->acl()->cloneToken($clone);
  40. // Delete a Token
  41. $delete = new Token([
  42.     'AccessorID' => '8f246b77-f3e1-ff88-5b48-8ec93abf3e05'
  43. ]);
  44. $this->consul->acl()->delete($delete);
  46. // List Tokens
  47. $token = new Tokens();
  48. $this->consul->acl()->tokens($token);

Legacy Tokens

  1. // Create ACL Token
  2. $create = new Create([
  3.     "Name" => "my-app-token",
  4.     "Type" => "client",
  5.     "rules" => "a"
  6. ]);
  7. $this->consul->acl()->create($create);
  9. // Update ACL Token
  10. $update = new Update([
  11.     "id" => "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
  12.     "Name" => "my-app-token-updated",
  13.     "Type" => "client",
  14.     "Rules" => "# New Rules",
  15. ]);
  16. $this->consul->acl()->update($update);
  18. // Delete ACL Token
  19. $delete = new Destroy([
  20.     'uuid' => '8f246b77-f3e1-ff88-5b48-8ec93abf3e05'
  21. ]);
  22. $this->consul->acl()->destroy($delete);
  24. // Read ACL Token
  25. $info = new Info([
  26.     'uuid' => '8f246b77-f3e1-ff88-5b48-8ec93abf3e05'
  27. ]);
  28. $this->consul->acl()->info($info);
  30. // Clone ACL Token
  31. $cloneAclToken = new CloneACLToken([
  32.     'uuid' => '8f246b77-f3e1-ff88-5b48-8ec93abf3e05'
  33. ]);
  34. $this->consul->acl()->cloneAclToken($cloneAclToken);
  36. // List ACLs
  37. $getList = new Lists();
  38. $this->consul->acl()->getList($getList);
  39. $this->assertEquals('x','x');

Policies

  1. // Create a Policy
  2. $policy = new Policy([
  3.     "Name" => "node-read",
  4.     "Description" => "Grants read access to all node information",
  5.     "Rules" => "node_prefix \"\" { policy = \"read\"}",
  6.     "datacenters" => ["dc1"]
  7. ]);
  8. $this->consul->acl()->policy($policy);
  10. // Read a Policy
  11. $policy = new Policy([
  12.     'id' => 'c01a1f82-44be-41b0-a686-685fb6e0f485',
  13. ]);
  14. $this->consul->acl()->readPolicy($policy);
  16. // Update a Policy
  17. $policy = new Policy([
  18.     "ID" => "c01a1f82-44be-41b0-a686-685fb6e0f485",
  19.     "Name" => "register-app-service",
  20.     "Description" => "Grants write permissions necessary to register the 'app' service",
  21.     "Rules" => "service \"app\" { policy = \"write\"}",
  22. ]);
  23. $this->consul->acl()->updatePolicy($policy);
  25. // Delete a Policy
  26. $policy = new Policy([
  27.     'id' => 'c01a1f82-44be-41b0-a686-685fb6e0f485'
  28. ]);
  29. $this->consul->acl()->deletePolicy($policy);
  31. // List Policies
  32. $policies = new Policies();
  33. $this->consul->acl()->policies($policies);

Roles

  1. // Create a Role
  2. $role = new Role([
  3.     "name" => "example-role",
  4.     "description" => "Showcases all input parameters",
  5. ]);
  6. $this->consul->acl()->role($role);
  8. // Read a Role
  9. $role = new Role([
  10.     'id' => 'aa770e5b-8b0b-7fcf-e5a1-8535fcc388b4'
  11. ]);
  12. $this->consul->acl()->readRole($role);
  14. // Read a Role by Name
  15. $name = new Role([
  16.     'name' => 'example-role'
  17. ]);
  18. $this->consul->acl()->readRoleByName($name);
  20. // Update a Role
  21. $role = new Role([
  22.     'id' => 'aa770e5b-8b0b-7fcf-e5a1-8535fcc388b4',
  23.     "name" => "example-two",
  24. ]);
  25. $this->consul->acl()->updateRole($role);
  27. // Delete a Role
  28. $role = new Role([
  29.     'id' => 'aa770e5b-8b0b-7fcf-e5a1-8535fcc388b4'
  30. ]);
  31. $this->consul->acl()->deleteRole($role);
  33. // List Roles
  34. $roles = new Roles();
  35. $this->consul->acl()->roles($roles);

Auth Method

  1. // Create an Auth Method
  2. $method = new AuthMethod([
  3.     "Name" => "minikube",
  4.     "Type" => "kubernetes",
  5.     "Description" => "dev minikube cluster",
  6.     "Config" => [
  7.         "Host" => "https://192.0.2.42:8443",
  8.         "CACert" => "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----\n",
  9.         "ServiceAccountJWT" => "eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9..."
  10.     ]
  11. ]);
  12. $this->consul->acl()->authMethod($method);
  14. // Read an Auth Method
  15. $method = new AuthMethod([
  16.     'name' => 'minikube',
  17. ]);
  18. $this->consul->acl()->readAuthMethod($method);
  20. // Update an Auth Method
  21. $method = new AuthMethod([
  22.     "Name" => "minikube",
  23.     "Type" => "kubernetes",
  24.     "Description" => "dev minikube cluster",
  25.     "Config" => [
  26.         "Host" => "https://192.0.2.42:8443",
  27.         "CACert" => "-----BEGIN CERTIFICATE-----\n...-----END CERTIFICATE-----\n",
  28.         "ServiceAccountJWT" => "eyJhbGciOiJSUzI1NiIsImtpZCI6IiJ9..."
  29.     ]
  30. ]);
  31. $this->consul->acl()->updateAuthMethod($method);
  33. // Delete an Auth Method
  34. $method = new AuthMethod([
  35.     "Name" => "minikube",
  36. ]);
  37. $this->consul->acl()->deleteAuthMethod($method);
  39. // List Auth Methods
  40. $method = new AuthMethods();
  41. $this->consul->acl()->authMethods($method);

Binding Rules

  1. // Create a Binding Rule
  2. $bindingRule = new BindingRule([
  3.     "description" => "example rule",
  4.     "authMethod" => "minikube",
  5.     "Selector" => "serviceaccount.namespace==default",
  6.     "BindType" => "service",
  7.     "BindName" => "{{ serviceaccount.name }}"
  8. ]);
  9. $this->consul->acl()->bindingRule($bindingRule);
  11. // Read a Binding Rule
  12. $bindingRule = new BindingRule([
  13.     'id' => '000ed53c-e2d3-e7e6-31a5-c19bc3518a3d',
  14. ]);
  15. $this->consul->acl()->readBindingRule($bindingRule);
  17. // Update a Binding Rule
  18. $bindingRule = new BindingRule([
  19.     'id' => '000ed53c-e2d3-e7e6-31a5-c19bc3518a3d',
  20.     "Description" => "updated rule",
  21.     "authMethod" => "minikube",
  22.     "Selector" => "serviceaccount.namespace=dev",
  23.     "BindType" => "role",
  24.     "BindName" => "{{ serviceaccount.name }}",
  25. ]);
  26. $this->consul->acl()->updateBindingRule($bindingRule);
  28. // Delete a Binding Rule
  29. $bindingRule = new BindingRule([
  30.     'id' => '000ed53c-e2d3-e7e6-31a5-c19bc3518a3d',
  31. ]);
  32. $this->consul->acl()->deleteBindingRule($bindingRule);
  34. // List Binding Rules
  35. $bindingRules = new BindingRules();
  36. $this->consul->acl()->bindingRules($bindingRules);

Agent

  1. // List Members
  2. $this->consul->agent()->members(new Members([
  3.     'wan' => 'a',
  4.     'segment' => 'b',
  5. ]));
  7. // Read Configuration
  8. $self = new SelfParams();
  9. $this->consul->agent()->self($self);
  11. // Reload Agent
  12. $reload = new Reload();
  13. $this->consul->agent()->reload($reload);
  15. // Enable Maintenance Mode
  16. $maintenance = new Maintenance([
  17.     'enable' => true,
  18.     'reason' => 'whatever',
  19. ]);
  20. $this->consul->agent()->maintenance($maintenance);
  22. // View Metrics
  23. $metrics = new Metrics([
  24.     'format' => 'prometheus',
  25. ]);
  26. $this->consul->agent()->metrics($metrics);
  28. // Stream Logs
  29. $monitor = new Monitor([
  30.     'loglevel' => 'info',
  31. ]);
  32. $this->consul->agent()->monitor($monitor);
  34. // Join Agent
  35. $join = new Join([
  36.     'address' => '1.2.3.4',
  37.     'wan' => false
  38. ]);
  39. $this->consul->agent()->join($join);
  41. // Graceful Leave and Shutdown
  42. $leave = new Leave();
  43. $this->consul->agent()->leave($leave);
  45. // Force Leave and Shutdown
  46. $forceLeave = new ForceLeave([
  47.     'node' => 'consul'
  48. ]);
  49. $this->consul->agent()->forceLeave($forceLeave);
  51. // Update ACL Tokens
  52. $token = new Token([
  53.     'action' => 'acl_agent_token',
  54.     'token' => 'token'
  55. ]);
  56. $this->consul->agent()->token($token);

Checks

  1. // List Checks
  2. $checks = new Checks([
  3.     'filter' => '',
  4. ]);
  5. $this->consul->agent()->checks($checks);
  7. // Register Check
  8. $register = new Register([
  9.     'name' => 'Memory_utilization', // 不可以出现空格或者其他url中不允许出现的特殊字符，否则取消注册的check_id会报400 error
  10.     "notes" => "Ensure we don't oversubscribe memory",
  11.     "DeregisterCriticalServiceAfter" => "90m",
  12.     "Args" => ["/usr/local/bin/check_mem.py"],
  13.     "DockerContainerID" => "f972c95ebf0e",
  14.     "Shell" => "/bin/bash",
  15.     "HTTP" => "https://example.com",
  16.     "Method" => "POST",
  17.     "Header" => ["x-foo" => ["bar", "baz"]],
  18.     "TCP" => "example.com:22",
  19.     "Interval" => "10s",
  20.     "TTL" => "15s",
  21.     "TLSSkipVerify" => true,
  22. ]);
  23. $this->consul->agent()->register($register);
  25. // Deregister Check
  26. $deRegister = new DeRegister([
  27.     'check_id' => 'Memory_utilization'
  28. ]);
  29. $this->consul->agent()->deRegister($deRegister);
  31. // TTL Check Pass
  32. $pass = new Pass([
  33.     'check_id' => 'Memory_utilization',
  34.     'note' => 'consul',
  35. ]);
  36. $this->consul->agent()->pass($pass);
  38. // TTL Check Warn
  39. $warn = new Warn([
  40.     'check_id' => 'Memory_utilization',
  41.     'note' => 'consul',
  42. ]);
  43. $this->consul->agent()->warn($warn);
  45. // TTL Check Fail
  46. $fail = new Fail([
  47.     'check_id' => 'Memory_utilization',
  48.     'note' => 'consul',
  49. ]);
  50. $this->consul->agent()->fail($fail);
  52. // TTL Check Update
  53. $update = new Update([
  54.     'check_id' => 'Memory_utilization',
  55.     'Status' => 'passing',
  56.     'Output' => 'update success'
  57. ]);
  58. $this->consul->agent()->update($update);

Services

  1. // List Services
  2. $services = new Services([
  3.     'filter' => '',
  4. ]);
  5. $this->consul->agent()->services($services);
  7. // Get Service Configuration
  8.  $service = new Service([
  9.     'service_id' => "consul"
  10. ]);
  11. $this->consul->agent()->service($service);
  13. // Get local service health
  14. $name = new Name([
  15.     'service_name' => 'consul',
  16.     'format' => 'text',
  17. ]);
  18. $this->consul->agent()->name($name);
  20. // Get local service health by its ID
  21. $id = new ID([
  22.     'service_id' => 'consul',
  23.     'format' => 'text',
  24. ]);
  25. $this->consul->agent()->id($id);
  27. // Register Service
  28.  $register = new Service\Register([
  29.     "ID" => "redis1",
  30.     "name" => "redis",
  31.     "Tags" => [
  32.         "primary",
  33.         "v1"
  34.     ],
  35.     "Address" => "127.0.0.1",
  36.     "Port" => 8000,
  37.     "meta" => [
  38.         "redis_version" => "4.0",
  39.     ],
  40.     "EnableTagOverride" => false,
  41.     "Check" => [
  42.         "DeregisterCriticalServiceAfter" => "90m",
  43.     "Args" => ["/usr/local/bin/check_redis.py"],
  44.     "HTTP" => "http://localhost:5000/health",
  45.     "Interval" => "10s",
  46.     "TTL" => "15s"
  47.     ],
  48.     "weights" => [
  49.         "Passing" => 10,
  50.     "Warning" => 1
  51.     ]
  52. ]);
  53. $this->consul->agent()->serviceRegister($register);
  55. // Deregister Service
  56. $deregister = new Service\DeRegister([
  57.     'service_id' => 'consul',
  58. ]);
  59. $this->consul->agent()->serviceDeregister($deregister);
  61. // Enable Maintenance Mode
  62. $maintenance= new Service\Maintenance([
  63.     'service_id' => 'consul',
  64.     'enable' => true,
  65.     'reason' => ''
  66. ]);
  67. $this->consul->agent()->serviceMaintenance($maintenance);

Connect

  1. // Authorize
  2. $authorize = new Authorize([
  3.     "target" => "db",
  4.     "clientCertURI" => "spiffe://dc1-7e567ac2-551d-463f-8497-f78972856fc1.consul/ns/default/dc/dc1/svc/web",
  5.     "clientCertSerial" => "04:00:00:00:00:01:15:4b:5a:c3:94"
  6. ]);
  7. $this->consul->agent()->authorize($authorize);
  9. // Certificate Authority (CA) Roots
  10. $roots = new Roots();
  11. $this->consul->agent()->roots($roots);
  13. // Service Leaf Certificate
  14. $leaf = new Leaf([
  15.     'service' => 'consul'
  16. ]);
  17. $this->consul->agent()->leaf($leaf);

Catalog

  1. // Register Entity
  2. $register = new Register([
  3.     "datacenter" => "dc1",
  4.     "id" => "40e4a748-2192-161a-0510-9bf59fe950b5",
  5.     "node" => "foobar",
  6.     "Address" => "192.168.10.10",
  7.     "TaggedAddresses" => [
  8.         "lan" => "192.168.10.10",
  9.     "wan" => "10.0.10.10"
  10.     ],
  11.     "NodeMeta" => [
  12.         "somekey" => "somevalue"
  13.     ],
  14.     "Service" => [
  15.         "ID" => "redis1",
  16.     "Service" => "redis",
  17.     "Tags" => [
  18.             "primary",
  19.             "v1"
  20.         ],
  21.     "Address" => "127.0.0.1",
  22.     "TaggedAddresses" => [
  23.             "lan" => [
  24.                 "address" => "127.0.0.1",
  25.         "port" => 8000,
  26.       ],
  27.       "wan" => [
  28.                 "address" => "198.18.0.1",
  29.         "port" => 80
  30.       ]
  31.     ],
  32.     "Meta" => [
  33.             "redis_version" => "4.0"
  34.     ],
  35.     "Port" => 8000
  36.     ],
  37.     "Check" => [
  38.         "Node" => "foobar",
  39.     "CheckID" => "service:redis1",
  40.     "Name" => "Redis health check",
  41.     "Notes" => "Script based health check",
  42.     "Status" => "passing",
  43.     "ServiceID" => "redis1",
  44.     "Definition" => [
  45.             "TCP" => "localhost:8888",
  46.       "Interval" => "5s",
  47.       "Timeout" => "1s",
  48.       "DeregisterCriticalServiceAfter" => "30s"
  49.     ]
  50.     ],
  51.     "SkipNodeUpdate" => false
  52. ]);
  53. $this->consul->catalog()->register($register);
  55. // Deregister Entity
  56. $deregister = new Deregister([
  57.     "datacenter" => "dc1",
  58.     "node" => "foobar",
  59.     "CheckID" => "service:redis1",
  60. ]);
  61. $this->consul->catalog()->deRegister($deregister);
  63. // List Datacenters
  64. $datacenters = new Datacenters();
  65. $this->consul->catalog()->dataCenters($datacenters);
  67. // List Nodes
  68. $nodes = new Nodes([
  69.     'dc' => 'dc1',
  70.     'node-meta' => '',
  71.     'near' => '',
  72.     'filter' => '',
  73. ]);
  74. $this->consul->catalog()->nodes($nodes);
  76. // List Services
  77. $nodes = new Nodes([
  78. $services = new Services([
  79.     'dc' => 'dc1',
  80.     'node-meta' => '',
  81. ]);
  82. $this->consul->catalog()->services($services);
  83. ]);
  84. $this->consul->catalog()->nodes($nodes);
  86. // List Nodes for Service
  87. $services = new Services([
  88.     'dc' => 'a',
  89.     'node-meta' => 'b',
  90. ]);
  91. $this->consul->catalog()->services($services);
  93. // List Nodes for Connect-capable Service
  94. $service = new Service([
  95.     'service' => 'consul',
  96.     'dc' => 'dc1',
  97.     'tag' => '',
  98.     'near' => '',
  99.     'node-meta' => '',
  100.     'filter' => '',
  101. ]);
  102. $this->consul->catalog()->service($service);
  104. // List Services for Node
  105. $connect = new Connect([
  106.     'service' => 'consul',
  107.     'dc' => 'dc1',
  108.     'tag' => '',
  109.     'near' => '',
  110.     'node-meta' => '',
  111.     'filter' => '',
  112. ]);
  113. $this->consul->catalog()->connect($connect);
  115. // List Services for Node
  116. $node = new Node([
  117.     'node' => '2eb87046a6fe',
  118.     'dc' => 'dc1',
  119.     'filter' => '',
  120. ]);
  121. $this->consul->catalog()->node($node);

Config

  1. // Apply Configuration
  2. $config = new \EasySwoole\Consul\Request\Config([
  3.     'Kind' => 'service-defaults',
  4.     'Name' => 'web',
  5.     'Protocol' => 'Http'
  6. ]);
  7. $this->consul->config()->config($config);
  9. // Get Configuration
  10. $config = new \EasySwoole\Consul\Request\Config([
  11.     'Kind' => 'service-defaults',
  12.     'name' => 'web',
  13. ]);
  14. $this->consul->config()->getConfig($config);
  16. // List Configurations
  17. $config = new \EasySwoole\Consul\Request\Config([
  18.     'Kind' => 'service-defaults'
  19. ]);
  20. $this->consul->config()->listConfig($config);
  22. // Delete Configuration
  23. $config = new \EasySwoole\Consul\Request\Config([
  24.     'Kind' => 'service-defaults',
  25.     'name' => 'web',
  26. ]);
  27. $this->consul->config()->deleteConfig($config);

Connect

Certificate Authority (CA)

  1. // List CA Root Certificates
  2. $roots = new Roots();
  3. $this->consul->connect()->roots($roots);
  5. // Get CA Configuration
  6. $configuration = new Configuration();
  7. $this->consul->connect()->configuration($configuration);
  9. // Update CA Configuration
  10. $configuration = new Configuration([
  11.     'Provider' => 'consul',
  12.     'Config' => [
  13.         'LeafCertTTL' => '72h'
  14.     ]
  15. ]);
  16. $this->consul->connect()->updateConfiguration($configuration);

Intentions

  1. // Create Intention
  2. $intentions = new Intentions([
  3.     'SourceName' => 'web',
  4.     'DestinationName' => 'db',
  5.     'SourceType' => 'consul',
  6.     'action' => 'allow'
  7. ]);
  8. $this->consul->connect()->intentions($intentions);
  10. // Read Specific Intention
  11. $intentions = new Intentions([
  12.     'uuid' => 'e9ebc19f-d481-42b1-4871-4d298d3acd5c',
  13. ]);
  14. $this->consul->connect()->readIntention($intentions);
  16. // List Intentions
  17. $intentions = new Intentions();
  18. $this->consul->connect()->listIntention($intentions);
  20. // Update Intention
  21. $intentions = new Intentions([
  22.     'uuid' => 'b40faaf3-34aa-349f-3cf2-f5d720240662',
  23.     'description' => 'just a test description',
  24.     'SourceName' => '',
  25.     'DestinationName' => '',
  26.     'Action' => 'allow'
  27. ]);
  28. $this->consul->connect()->updateIntention($intentions);
  30. // Delete Intention
  31. $intentions = new Intentions([
  32.     'uuid' => 'b40faaf3-34aa-349f-3cf2-f5d720240662',
  33. ]);
  34. $this->consul->connect()->deleteIntention($intentions);
  36. // Check Intention Result
  37. $intentions = new Intentions\Check([
  38.     'source' => 'web',
  39.     'destination' => 'db',
  40. ]);
  41. $this->consul->connect()->check($intentions);
  43. // List Matching Intentions
  44. $intentions = new Intentions\Match([
  45.     'by' => 'source',
  46.     'name' => 'web',
  47. ]);
  48. $this->consul->connect()->match($intentions);

Coordinate

  1. // Read WAN Coordinates
  2. $datacenters = new Datacenters();
  3. $this->consul->coordinates()->datacenters($datacenters);
  5. // Read LAN Coordinates for all nodes
  6. $nodes = new Nodes([]);
  7. $this->consul->coordinates()->nodes($nodes);
  9. // Read LAN Coordinates for a node
  10. $node = new Node([
  11.     'node' => '2456c2850382',
  12. ]);
  13. $this->consul->coordinates()->node($node);
  15. // Update LAN Coordinates for a node
  16. $update = new Update([
  17.     'dc' => 'dc1',
  18.     'node' => '2456c2850382',
  19.     'Segment' => 'update',
  20.     "Coord" => [
  21.         "Adjustment" => 0,
  22.         "Error" => 1.5,
  23.         "Height" => 0,
  24.         "Vec" => [0, 0, 0, 0, 0, 0, 0, 0]
  25.     ]
  26. ]);
  27. $this->consul->coordinates()->update($update);

Events

  1. // Fire Event
  2. $fire = new Fire([
  3.     'name' => 'consul',
  4.     'dc' => 'dc1',
  5. ]);
  6. $this->consul->event()->fire($fire);
  8. // List Events
  9. $listEvent = new ListEvent([
  10.     'name' => 'consul',
  11. ]);
  12. $this->consul->event()->listEvent($listEvent);

Health

  1. // List Checks for Node
  2. $node = new Node([
  3.     'node' => '2456c2850382',
  4.     'dc' => 'dc1',
  5. ]);
  6. $this->consul->health()->node($node);
  8. // List Checks for Service
  9. $checks = new Checks([
  10.    'service' => 'consul',
  11.    'node_meta' => 'node-meta',
  12. ]);
  13. $this->consul->health()->checks($checks);
  15. // List Nodes for Service
  16. $service = new Service([
  17.     'service' => 'consul',
  18.     'dc' => 'dc1',
  19. ]);
  20. $this->consul->health()->service($service);
  22. // List Nodes for Connect-capable Service
  23. $connect = new Connect([
  24.     'service' => 'consul'
  25. ]);
  26. $this->consul->health()->connect($connect);
  28. // List Checks in State
  29. $state = new State([
  30.     'state' => 'passing'
  31. ]);
  32. $this->consul->health()->state($state);

KV Store

  1. // Read Key
  2. $kv = new Kv([
  3.     'key' => 'my-key',
  4.     'dc' => 'dc1',
  5. ]);
  6. $this->consul->kvStore()->kv($kv);
  8. // Create Key
  9. $create = new kv([
  10.     'key' => 'my-key',
  11.     'dc' => 'dc1',
  12. ]);
  13. $this->consul->kvStore()->create($create);
  15. // Update Key
  16. $update = new kv([
  17.     'key' => 'my-key',
  18.     'dc' => 'dc1',
  19. ]);
  20. $this->consul->kvStore()->update($update);
  22. // Delete Key
  23. $delete = new Kv([
  24.     'key' => 'my-key',
  25.     'recurse' => false,
  26. ]);
  27. $this->consul->kvStore()->delete($delete);

Operator

Area

  1. // Create Network Area
  2. $area = new Area([
  3.     'PeerDatacenter' => 'dc1',
  4.     "RetryJoin" => [ "10.1.2.3", "10.1.2.4", "10.1.2.5" ],
  5.     "UseTLS" => false
  6. ]);
  7. $this->consul->operator()->area($area);
  9. // List Network Areas
  10. $area = new Area([
  11.     'dc' => 'dc1',
  12.     'uuid' => '10275a2e-aa8f-2cf3-0adf-ff03d8950902',
  13. ]);
  14. $this->consul->operator()->areaList($area);
  16. // List Specific Network Area
  17. $area = new Area([
  18.     'dc' => 'dc1',
  19.     'uuid' => '10275a2e-aa8f-2cf3-0adf-ff03d8950902',
  20. ]);
  21. $this->consul->operator()->areaList($area);
  23. // Update Network Area
  24. $area = new Area([
  25.     'uuid' => '10275a2e-aa8f-2cf3-0adf-ff03d8950902',
  26.     'UseTLS' => true,
  27.     'dc' => 'dc1',
  28. ]);
  29. $this->consul->operator()->updateArea($area);
  31. // Delete Network Area
  32. $area = new Area([
  33.     'uuid' => '10275a2e-aa8f-2cf3-0adf-ff03d8950902',
  34. ]);
  35. $this->consul->operator()->deleteArea($area);
  37. // Join Network Area
  38. $area = new Area([
  39.     'uuid' => '10275a2e-aa8f-2cf3-0adf-ff03d8950902',
  40. ]);
  41. $this->consul->operator()->joinArea($area);
  43. // List Network Area Members
  44. $area = new Area([
  45.     'uuid' => '10275a2e-aa8f-2cf3-0adf-ff03d8950902'
  46. ]);
  47. $this->consul->operator()->membersArea($area);

Autopilot

  1. // Read Configuration
  2. $configuration = new Configuration([
  3.     'dc' => 'dc1',
  4.     'stale' => true,
  5. ]);
  6. $this->consul->operator()->getConfiguration($configuration);
  8. // Update Configuration
  9. $configuration = new Configuration([
  10.     'dc' => 'dc1',
  11.     'stale' => true,
  12.     "cleanupDeadServers" => true,
  13.     "lastContactThreshold" => "200ms",
  14.     "MaxTrailingLogs" => 250,
  15.     "ServerStabilizationTime" => "10s",
  16.     "RedundancyZoneTag" => "",
  17.     "DisableUpgradeMigration" => false,
  18.     "UpgradeVersionTag" => "",
  20. ]);
  21. $this->consul->operator()->updateConfiguration($configuration);
  23. // Read Health
  24. $health = new Health([
  25.     'dc' => 'dc1',
  26. ]);
  27. $this->consul->operator()->health($health);

Keyring

  1. // List Gossip Encryption Keys
  2. $keyring = new Keyring();
  3. $keyring->setRelayFactor(0);
  4. $keyring->setLocalOnly(false);
  5. $this->consul->operator()->getKeyring($keyring);
  7. // Add New Gossip Encryption Key
  8. $keyring = new Keyring([
  9.     "Key" => "3lg9DxVfKNzI8O+IQ5Ek+Q==",
  10.     'relayFactor' => 1,
  11. ]);
  12. $this->consul->operator()->addKeyring($keyring);
  14. // Change Primary Gossip Encryption Key
  15. $keyring = new Keyring([
  16.     "Key" => "3lg9DxVfKNzI8O+IQ5Ek+Q==",
  17. ]);
  18. $this->consul->operator()->changeKeyring($keyring);
  20. // Delete Gossip Encryption Key
  21. $keyring = new Keyring([
  22.     "Key" => "3lg9DxVfKNzI8O+IQ5Ek+Q==",
  23.     "relayFactor" => 1
  24. ]);
  25. $this->consul->operator()->deleteKeyring($keyring);

License

  1. // Getting the Consul License
  2. $license = new License([
  3.     'dc' => 'dc1',
  4. ]);
  5. $this->consul->operator()->getLicense($license);
  7. // Updating the Consul License
  8. $license = new License([
  9.     'dc' => 'dc1'
  10. ]);
  11. $this->consul->operator()->updateLicense($license);
  13. // Resetting the Consul License
  14. $license = new License([
  15.     'dc' => 'dc1'
  16. ]);
  17. $this->consul->operator()->resetLicense($license);

Raft

  1. // Read Configuration
  2. $raft = new \EasySwoole\Consul\Request\Operator\Raft\Configuration();
  3. $this->consul->operator()->getRaftConfiguration($raft);
  5. // Delete Raft Peer
  6. $peer = new Peer([
  7.     'address' => '172.17.0.18:8301',
  8.     'dc' => 'dc1',
  9. ]);
  10. $this->consul->operator()->peer($peer);

Segment

  1. // List Network Segments
  2. $segment = new Segment();
  3. $this->consul->operator()->segment($segment);

Prepared Query

  1. // Create Prepared Query
  2. $query = new Query([
  3.     "name" => "my-query",
  4.     "Session" => "adf4238a-882b-9ddc-4a9d-5b6758e4159e",
  5.     "Token" => "11",
  6.     "Service" => [
  7.         "Service" => "redis",
  8.         "Failover" => [
  9.             "NearestN" => 3,
  10.             "Datacenters" => ["dc1", "dc2"]
  11.          ],
  12.         "Near" => "node1",
  13.         "OnlyPassing" => false,
  14.         "Tags" => ["primary", "!experimental"],
  15.         "NodeMeta" => ["instance_type" => "m3.large"],
  16.         "ServiceMeta" => ["environment" => "production"]
  17.     ],
  18.     "DNS" => [
  19.         "TTL" => "10s"
  20.     ],
  21. ]);
  22. $this->consul->query()->query($query);
  24. // Read Prepared Query
  25. $query = new Query([
  26.     'dc' => 'dc1'
  27. ]);
  28. $this->consul->query()->readQuery($query);
  30. // Update Prepared Query
  31. $query = new Query([
  32.     'uuid' => '90dce5ca-5697-ae2f-09ae-51e9542ea58c',
  33.     'dc' => 'dc1',
  34. ]);
  35. $this->consul->query()->updateQuery($query);;
  37. // Read Prepared Query
  38. $query = new Query([
  39.     'dc' => 'dc1'
  40. ]);
  41. $this->consul->query()->readQuery($query);
  43. // Delete Prepared Query
  44. $query = new Query([
  45.     'uuid' => '90dce5ca-5697-ae2f-09ae-51e9542ea58c'
  46. ]);
  47. $this->consul->query()->deleteQuery($query);;
  49. // Execute Prepared Query
  50. $execute = new Query\Execute([
  51.     'uuid' => '90dce5ca-5697-ae2f-09ae-51e9542ea58c',
  52.     'dc' => 'dc1',
  53. ]);
  54. $this->consul->query()->execute($execute);
  56. // Explain Prepared Query
  57. $execute = new Query\Explain([
  58.     'uuid' => '90dce5ca-5697-ae2f-09ae-51e9542ea58c',
  59.     'dc' => 'dc1',
  60. ]);
  61. $this->consul->query()->explain($execute);

Sessions

  1. // Create Session
  2. $create = new Create([
  3.     'dc' => 'dc1',
  4.     "LockDelay" => "15s",
  5.     "Name" => "my-service-lock",
  6.     "Node" => "foobar",
  7.     "Checks" => ["a", "b", "c"],
  8.     "Behavior" => "release",
  9.     "TTL" => "30s",
  10. ]);
  11. $this->consul->session()->create($create);
  13. // Delete Session
  14. $destroy = new Destroy([
  15.     'uuid' => 'f32a15b3-1baa-c047-bde9-bec3015ea013',
  16.     'dc' => 'dc1',
  17. ]);
  18. $this->consul->session()->destroy($destroy);
  20. // Read Session
  21. $info = new Info([
  22.     'uuid' => 'f32a15b3-1baa-c047-bde9-bec3015ea013',
  23.     'dc' => 'dc1',
  24. ]);
  25. $this->consul->session()->info($info);
  27. // List Sessions for Node
  28. $node = new Node([
  29.     'node' => '2456c2850382',
  30.     'dc' => 'dc1',
  31. ]);
  32. $this->consul->session()->node($node);
  34. // List Sessions
  35. $sessionList = new SessionList([
  36.     'dc' => 'dc1'
  37. ]);
  38. $this->consul->session()->sessionList($sessionList);
  40. // Renew Session
  41. $renew = new Renew([
  42.     'uuid' => '4f6d1cf6-b60a-c929-eeb8-12f4d7eaff62',
  43.     'dc' => 'dc1'
  44. ]);
  45. $this->consul->session()->renew($renew);

Snapshots

  1. // Generate Snapshot
  2. $generate = new Snapshot([
  3.     'dc' => 'dc1',
  4.     'stale' => 'true',
  5. ]);
  6. $this->consul->snapshot()->generate($generate);
  8. // Restore Snapshot
  9. $restore = new Snapshot();
  10. $this->consul->snapshot()->restore($restore);

Status

  1. // Get Raft Leader
  2. $leader = new Leader();
  3. $this->consul->status()->leader($leader);
  5. // List Raft Peers
  6. $peers = new Peers([
  7.     'dc' => 'dc1',
  8. ]);
  9. $this->consul->status()->peers($peers);

Transactions

  1. // Create Transaction
  2. $transaction = new Txn([]);
  3. $this->consul->transaction()->create($transaction);
  1. $node = new Node([
  2.     'node' => '44e4656a94cd',
  3.     'dc' => 'dc1',
  4.     'filter' => '',
  5. ]);
  6. $consul->catalog()->node($node);