An asynchronous Rust client library for the Hashicorp Consul API
The following features are currently supported:
Additionally, all optional API features such as consistency modes, blocking, etc. are also supported.
Add consulrs as a dependency to your cargo.toml:
[dependencies]
consulrs = "0.1.0"
The client is used to configure the connection to Consul and is required to be passed to all API calls for execution. Behind the scenes it uses an asynchronous client from Reqwest for communicating to Consul.
use consulrs::client::{ConsulClient, ConsulClientSettingsBuilder};
// Create a client
let client = ConsulClient::new(
ConsulClientSettingsBuilder::default()
.address("https://127.0.0.1:8200")
.build()
.unwrap()
).unwrap();The client supports all features required to interact with a production Consul service including the option to specify ACL tokens as well as client and CA certificates.
use std::convert::TryInto;
use consulrs::kv;
// Set `mykey` to "myvalue"
kv::set(&client, "mykey", b"myvalue", None).await;
// Read `mykey`
let mut res = kv::read(&client, "mykey", None).await.unwrap();
// All responses are base64 encoded by default. The below attempts to coerce
// the response back into a UTF-8 encoded string.
let mykey: String = res.response.pop().unwrap().value.unwrap().try_into().unwrap();
// In most cases, it's easier to just read the raw value
let mykey = std::str::from_utf8(&kv::read_raw(&client, "mykey", None).unwrap()).unwrap()
assert_eq!(mykey, "myvalue".to_string());use consulrs::api::check::common::AgentServiceCheckBuilder;
use consulrs::api::service::requests::RegisterServiceRequest
use consulrs::service;
// Create a service named "my_service" with a health check that queries the
// service via HTTP every 10 seconds.
service::register(
&client,
"my_service",
Some(
RegisterServiceRequest::builder()
.address("http://myservice.lab.com")
.port(1234)
.check(
AgentServiceCheckBuilder::default()
.name("health_check")
.interval("10s")
.http("http://myservice.lab.com/health")
.status("passing")
.build()
.unwrap(),
),
),
)
.await;See the examples directory for additional examples.
All errors generated by this crate are wrapped in the ClientError enum
provided by the crate. API errors are captured and returned as their own
variant including the response code and error message from the server.
Connection related errors from rustify are wrapped and returned as a single
variant.
All top level API operations are instrumented with tracing's #[instrument]
attribute.
See the the tests directory for tests. Run tests with cargo test.
Note: All tests rely on bringing up a local Consul development server using Docker. In order to run tests Docker must be running locally (Docker Desktop works).
Check out the issues for items needing attention or submit your own and then:
- Fork the repo (https://github.com/jmgilman/consulrs/fork)
- Create your feature branch (git checkout -b feature/fooBar)
- Commit your changes (git commit -am 'Add some fooBar')
- Push to the branch (git push origin feature/fooBar)
- Create a new Pull Request
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent