package-consul's Introduction

Ballerina Consul Connector

The Consul Connector allows you to register services and checks, deregister services and checks, create, read and delete keys, list the details of the services, list the details of the check by state such as passing, warning, or critical etc.

Compatibility

Ballerina Language Version	Consul API version
0.970.0	v1

The following sections provide you with information on how to use the Ballerina Consul Connector.

Contribute To Develop
Working with Consul Connector actions
Example

Contribute To develop

Clone the repository by running the following command

    git clone https://github.com/wso2-ballerina/package-consul.git

Working with Consul Connector actions

All the actions return valid response or ConsulError. If the action is a success, then the requested resource will be returned. Else ConsulError object will be returned.

In order for you to use the Consul Connector, first you need to create a Consul Client endpoint.

    endpoint Client consulClient {
         uri:"http://localhost:8500",
         aclToken:"",
         clientConfig:{}
    };

Example

import ballerina/io;
import wso2/consul;

public function main(string[] args) {
    endpoint Client consulClient {
        uri:"http://localhost:8500",
        aclToken:""
    };
    
    json jsonPayload = {"ID":"redis", "Name":"redis1", "Address":"localhost", "port":8000, "EnableTagOverride":false};
    var serviceRegister = consulClient -> registerService(jsonPayload);
        match serviceRegister {
             boolean response => {
                 test:assertEquals(response, true, msg = "Failed to call registerService()");
             }
             ConsulError err => {
                 io:println(err.message);
                 test:assertFail(msg = err.message);
             }
        }
}

Recommend Projects