mirror of
https://github.com/moghtech/komodo.git
synced 2026-09-08 16:01:18 +00:00
Maxwell Becker
7a9ad42203
* rust client improvements and docs * sync rust client * version 1.16.4 * UI support YAML / TOML utils, typed Deno namespace * add ResourcesToml to typeshare * add YAML and TOML convenience * make the types available globally * preload container with @std/yaml and @std/toml, clean up genned files * add deno setup to alpine dockerfile
35 lines
1.3 KiB
Markdown
35 lines
1.3 KiB
Markdown
# Komodo
|
|
*A system to build and deploy software across many servers*
|
|
|
|
Full Docs: [https://docs.rs/komodo_client/latest/komodo_client](https://docs.rs/komodo_client/latest/komodo_client).
|
|
|
|
This is a client library for the Komodo Core API.
|
|
It contains:
|
|
- Definitions for the application [api](https://docs.rs/komodo_client/latest/komodo_client/api/index.html)
|
|
and [entities](https://docs.rs/komodo_client/latest/komodo_client/entities/index.html).
|
|
- A [client](https://docs.rs/komodo_client/latest/komodo_client/struct.KomodoClient.html)
|
|
to interact with the Komodo Core API.
|
|
- Information on configuring Komodo
|
|
[Core](https://docs.rs/komodo_client/latest/komodo_client/entities/config/core/index.html) and
|
|
[Periphery](https://docs.rs/komodo_client/latest/komodo_client/entities/config/periphery/index.html).
|
|
|
|
## Client Configuration
|
|
|
|
The client includes a convenenience method to parse the Komodo API url and credentials from the environment:
|
|
- `KOMODO_ADDRESS`
|
|
- `KOMODO_API_KEY`
|
|
- `KOMODO_API_SECRET`
|
|
|
|
## Client Example
|
|
```rust
|
|
dotenvy::dotenv().ok();
|
|
|
|
let client = KomodoClient::new_from_env()?;
|
|
|
|
// Get all the deployments
|
|
let deployments = client.read(ListDeployments::default()).await?;
|
|
|
|
println!("{deployments:#?}");
|
|
|
|
let update = client.execute(RunBuild { build: "test-build".to_string() }).await?:
|
|
``` |