diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..342ab3a --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,22 @@ +name: CI + +on: + push: + branches: [ main ] + pull_request: + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + profile: minimal + override: true + - uses: Swatinem/rust-cache@v2 + - name: Run tests + run: cargo test + - name: Build example container + run: docker build -t kuberhealthy-example . diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..a29c300 --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,34 @@ +name: Release + +on: + release: + types: [published] + +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + steps: + - uses: actions/checkout@v4 + - uses: actions-rs/toolchain@v1 + with: + toolchain: stable + profile: minimal + override: true + - uses: Swatinem/rust-cache@v2 + - name: Publish crate + run: cargo publish --manifest-path kuberhealthy-client/Cargo.toml --token ${{ secrets.CRATES_IO_TOKEN }} + - name: Log in to GHCR + uses: docker/login-action@v3 + with: + registry: ghcr.io + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + - name: Build and push container + uses: docker/build-push-action@v5 + with: + push: true + tags: ghcr.io/${{ github.repository }}/kuberhealthy-example:${{ github.ref_name }} + file: Dockerfile diff --git a/Cargo.lock b/Cargo.lock index 13ee602..0b1582a 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1,6 +1,6 @@ # This file is automatically @generated by Cargo. # It is not intended for manual editing. -version = 3 +version = 4 [[package]] name = "addr2line" @@ -454,13 +454,20 @@ dependencies = [ ] [[package]] -name = "kuberhealthy-example" +name = "kuberhealthy-client" version = "0.1.0" dependencies = [ "reqwest", "serde", ] +[[package]] +name = "kuberhealthy-example" +version = "0.1.0" +dependencies = [ + "kuberhealthy-client", +] + [[package]] name = "libc" version = "0.2.175" diff --git a/Cargo.toml b/Cargo.toml index bc016a6..141c9e5 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,5 +4,4 @@ version = "0.1.0" edition = "2021" [dependencies] -reqwest = { version = "=0.11.22", default-features = false, features = ["blocking", "json", "rustls-tls"] } -serde = { version = "1", features = ["derive"] } +kuberhealthy-client = { path = "kuberhealthy-client" } diff --git a/Dockerfile b/Dockerfile index be64042..a4d46f2 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM rust:1.75 as builder +FROM rust:1.82 AS builder WORKDIR /src COPY . . RUN cargo build --release diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md index 69a8a5b..25cc323 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,39 @@ -# Rust Kuberhealthy Client Example +# Rust Kuberhealthy Client and Example -This directory contains a minimal Rust application that reports the result of a check back to [Kuberhealthy](https://github.com/kuberhealthy/kuberhealthy). -The program reads the `KH_REPORTING_URL` and `KH_RUN_UUID` environment variables provided to every check pod and posts a JSON -report with the header `kh-run-uuid`. +This repository provides a minimal library and example check for reporting results back to [Kuberhealthy](https://github.com/kuberhealthy/kuberhealthy). +The reusable client library now lives in the [`kuberhealthy-client`](./kuberhealthy-client) subcrate and can be imported into your own Rust programs. The repository root contains the `kuberhealthy-example` binary, which demonstrates how to use the client in a check container. + +## Using the client library + +Add the crate to your `Cargo.toml`: + +```toml +[dependencies] +kuberhealthy-client = "0.1" +``` + +Example usage: + +```rust +use kuberhealthy_client::KuberhealthyClient; + +fn main() -> Result<(), Box> { + let client = KuberhealthyClient::from_env()?; + // Perform check logic here... + client.report_success()?; + Ok(()) +} +``` + +The client reads the `KH_REPORTING_URL` and `KH_RUN_UUID` environment variables provided to every check pod and posts a JSON report with the `kh-run-uuid` header. + +## Example check Run without arguments to report success or with `--fail` to report a failure. ```bash -KH_REPORTING_URL="http://localhost" KH_RUN_UUID="test" cargo run -KH_REPORTING_URL="http://localhost" KH_RUN_UUID="test" cargo run -- --fail +KH_REPORTING_URL="http://localhost" KH_RUN_UUID="test" cargo run --bin kuberhealthy-example +KH_REPORTING_URL="http://localhost" KH_RUN_UUID="test" cargo run --bin kuberhealthy-example -- --fail ``` ## Build and push @@ -45,3 +70,8 @@ Apply the resource to any cluster where Kuberhealthy is running: ```bash kubectl apply -f khcheck.yaml ``` + +## Continuous integration and releases + +A GitHub Actions workflow builds the example container on every change. When a release is published, another workflow publishes the `kuberhealthy-client` crate from the subdirectory and pushes the example container image to the GitHub Container Registry. + diff --git a/kuberhealthy-client/Cargo.toml b/kuberhealthy-client/Cargo.toml new file mode 100644 index 0000000..4fdf18a --- /dev/null +++ b/kuberhealthy-client/Cargo.toml @@ -0,0 +1,14 @@ +[package] +name = "kuberhealthy-client" +version = "0.1.0" +edition = "2021" +description = "Rust client for reporting Kuberhealthy check results" +license = "Apache-2.0" + +[lib] +name = "kuberhealthy_client" +path = "src/lib.rs" + +[dependencies] +reqwest = { version = "=0.11.22", default-features = false, features = ["blocking", "json", "rustls-tls"] } +serde = { version = "1", features = ["derive"] } diff --git a/kuberhealthy-client/src/lib.rs b/kuberhealthy-client/src/lib.rs new file mode 100644 index 0000000..78c96b7 --- /dev/null +++ b/kuberhealthy-client/src/lib.rs @@ -0,0 +1,55 @@ +use reqwest::blocking::Client; +use serde::Serialize; +use std::{env, error::Error}; + +/// Client for reporting check results back to Kuberhealthy. +pub struct KuberhealthyClient { + reporting_url: String, + run_uuid: String, + http: Client, +} + +#[derive(Serialize)] +struct Report { + #[serde(rename = "Errors")] + errors: Vec, + #[serde(rename = "OK")] + ok: bool, +} + +impl KuberhealthyClient { + /// Create a client from the `KH_REPORTING_URL` and `KH_RUN_UUID` environment variables. + pub fn from_env() -> Result> { + Ok(KuberhealthyClient { + reporting_url: env::var("KH_REPORTING_URL")?, + run_uuid: env::var("KH_RUN_UUID")?, + http: Client::new(), + }) + } + + /// Report a successful check to Kuberhealthy. + pub fn report_success(&self) -> Result<(), reqwest::Error> { + self.send(Report { + errors: vec![], + ok: true, + }) + } + + /// Report a failed check to Kuberhealthy with the given error messages. + pub fn report_failure>(&self, errors: Vec) -> Result<(), reqwest::Error> { + self.send(Report { + errors: errors.into_iter().map(Into::into).collect(), + ok: false, + }) + } + + fn send(&self, report: Report) -> Result<(), reqwest::Error> { + self.http + .post(&self.reporting_url) + .header("kh-run-uuid", &self.run_uuid) + .json(&report) + .send()? + .error_for_status()?; + Ok(()) + } +} diff --git a/src/main.rs b/src/main.rs index 4d24abb..a36e7bb 100644 --- a/src/main.rs +++ b/src/main.rs @@ -1,42 +1,19 @@ -use reqwest::blocking::Client; -use serde::Serialize; use std::{env, error::Error}; -#[derive(Serialize)] -struct Report { - #[serde(rename = "Errors")] - errors: Vec, - #[serde(rename = "OK")] - ok: bool, -} +use kuberhealthy_client::KuberhealthyClient; fn main() -> Result<(), Box> { - // Fetch environment variables injected by Kuberhealthy. - let reporting_url = env::var("KH_REPORTING_URL").expect("KH_REPORTING_URL must be set"); - let run_uuid = env::var("KH_RUN_UUID").expect("KH_RUN_UUID must be set"); + let client = KuberhealthyClient::from_env()?; // Placeholder for your own check logic. // Pass --fail to simulate a failure. let ok = env::args().find(|a| a == "--fail").is_none(); - let report = if ok { - Report { - errors: vec![], - ok: true, - } + if ok { + client.report_success()?; } else { - Report { - errors: vec!["example failure".into()], - ok: false, - } - }; - - Client::new() - .post(&reporting_url) - .header("kh-run-uuid", run_uuid) - .json(&report) - .send()? - .error_for_status()?; + client.report_failure(vec!["example failure"])?; + } Ok(()) }