├── .github └── workflows │ └── rust.yml ├── .gitignore ├── Cargo.toml ├── LICENSE ├── README.md ├── api ├── Cargo.toml └── src │ ├── apps │ ├── mod.rs │ └── v1beta2.rs │ ├── core │ ├── mod.rs │ └── v1.rs │ ├── intstr.rs │ ├── lib.rs │ ├── meta │ ├── mod.rs │ └── v1.rs │ └── unstructured.rs ├── client ├── Cargo.toml └── src │ └── lib.rs ├── examples ├── client-watch.rs └── client.rs ├── holding ├── Cargo.toml └── src │ ├── client │ ├── config │ │ ├── api.rs │ │ └── mod.rs │ ├── mod.rs │ └── resplit.rs │ ├── lib.rs │ └── serde_base64.rs ├── proxy ├── Cargo.toml └── src │ └── lib.rs ├── renovate.json └── src └── lib.rs /.github/workflows/rust.yml: -------------------------------------------------------------------------------- 1 | name: Rust 2 | 3 | on: 4 | push: 5 | branches: [ master, 'renovate/**' ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | env: 10 | CARGO_TERM_COLOR: always 11 | 12 | jobs: 13 | build: 14 | 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3 19 | - name: Run Rustfmt 20 | run: cargo fmt -- --check 21 | - name: Build 22 | run: cargo build --verbose 23 | - name: Run tests 24 | run: cargo test --verbose 25 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | target 2 | Cargo.lock 3 | -------------------------------------------------------------------------------- /Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "kubernetes" 3 | version = "0.2.0" 4 | authors = ["Angus Lees "] 5 | description = "A Kubernetes client library for Rust" 6 | repository = "https://github.com/anguslees/kubernetes-rs" 7 | readme = "README.md" 8 | keywords = ["kubernetes"] 9 | categories = ["api-bindings"] 10 | license = "Apache-2.0" 11 | 12 | [badges] 13 | maintenance = {status = "actively-developed,experimental"} 14 | 15 | [workspace] 16 | members = [ 17 | "client", 18 | "api", 19 | "proxy", 20 | "holding", 21 | ] 22 | 23 | 24 | [dependencies] 25 | kubernetes_api = { path = "api" } 26 | kubernetes_client = { path = "client" } 27 | kubernetes_holding = { path = "holding" } 28 | kubernetes_proxy = { path = "proxy" } 29 | 30 | [dev-dependencies] 31 | failure = "0.1" 32 | futures = "0.1.21" 33 | hyper = "0.12" 34 | hyper-tls = "0.3" 35 | log = "0.4" 36 | pretty_env_logger = "0.4" 37 | serde_json = "1.0" 38 | tokio = "0.1.7" 39 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # A Kubernetes API client library for Rust 2 | 3 | [crates.io]: https://crates.io/crates/kubernetes 4 | 5 | ## Status 6 | 7 | *Experimental.* 8 | 9 | - Get, put, list, and watch are implemented, using tokio 10 | futures/streams. 11 | - Client obeys `~/.kube/config` (or `$KUBECONFIG`) by default, as per 12 | golang client. TLS is supported. Client certificates are the only 13 | currently supported method of client authentication. 14 | - API objects are currently manually defined and incomplete. 15 | Additional 3rd-party object types can be defined via traits. 16 | - API resources do not yet have a representation in Rust. 17 | - API error handling is very naive. 18 | 19 | --- 20 | 21 | Example of listing all the pods in `kube-system` namespace. 22 | Results are streamed, limited to 20 results per page. 23 | 24 | ```rust 25 | extern crate kubernetes; 26 | extern crate tokio_core; 27 | 28 | use std::default::Default; 29 | use tokio_core::reactor::Core; 30 | 31 | use kubernetes::api; 32 | use kubernetes::client::{Client,ListOptions}; 33 | use kubernetes::api::core::v1::{Pod,PodList}; 34 | 35 | fn main() { 36 | let mut core = Core::new().unwrap(); 37 | let client = Client::new(2, &core.handle()).unwrap(); 38 | 39 | let pods = api::core::v1::GROUP_VERSION.with_resource("pods"); 40 | let namespace = Some("kube-system"); 41 | 42 | let opts = ListOptions{ limit: 20, ..Default::default() }; 43 | let work = client.iter::(&pods, namespace, opts) 44 | .for_each(|pod| { 45 | println!("pod is {}", pod.metadata.name.unwrap_or_default()); 46 | Ok(()) 47 | }); 48 | 49 | core.run(work).unwrap() 50 | } 51 | ``` 52 | -------------------------------------------------------------------------------- /api/Cargo.toml: -------------------------------------------------------------------------------- 1 | [package] 2 | name = "kubernetes_api" 3 | version = "0.2.0" 4 | authors = ["Angus Lees "] 5 | description = "A Kubernetes API encoding for Rust" 6 | repository = "https://github.com/anguslees/kubernetes-rs" 7 | readme = "README.md" 8 | keywords = ["kubernetes"] 9 | categories = ["api-bindings"] 10 | license = "Apache-2.0" 11 | 12 | [badges] 13 | maintenance = {status = "actively-developed,experimental"} 14 | 15 | [dependencies] 16 | failure = "0.1.8" 17 | serde = "1.0" 18 | serde_derive = "1.0" 19 | serde_json = "1.0" 20 | base64 = "0.9" 21 | 22 | [dev-dependencies] 23 | serde_test = "1.0" 24 | serde_yaml = "0.8" 25 | -------------------------------------------------------------------------------- /api/src/apps/mod.rs: -------------------------------------------------------------------------------- 1 | pub mod v1beta2; 2 | -------------------------------------------------------------------------------- /api/src/apps/v1beta2.rs: -------------------------------------------------------------------------------- 1 | use super::super::core::v1::{ConditionStatus, PodTemplateSpec}; 2 | use super::super::meta::v1::{LabelSelector, ObjectMeta}; 3 | use super::super::{IntOrString, Integer, Time}; 4 | 5 | #[derive(Serialize, Deserialize, Debug, Clone)] 6 | #[serde(rename_all = "camelCase")] 7 | pub struct Deployment { 8 | pub metadata: ObjectMeta, 9 | pub spec: DeploymentSpec, 10 | pub status: DeploymentStatus, 11 | } 12 | 13 | fn int1() -> Integer { 14 | 1 15 | } 16 | fn int10() -> Integer { 17 | 10 18 | } 19 | fn int600() -> Integer { 20 | 600 21 | } 22 | 23 | #[derive(Serialize, Deserialize, Debug, Clone)] 24 | #[serde(rename_all = "camelCase")] 25 | pub struct DeploymentSpec { 26 | #[serde(default)] 27 | pub min_ready_seconds: Integer, 28 | pub paused: bool, 29 | #[serde(default = "int600")] 30 | pub progress_deadline_seconds: Integer, 31 | #[serde(default = "int1")] 32 | pub replicas: Integer, 33 | #[serde(default = "int10")] 34 | pub revision_history_limit: Integer, 35 | pub selector: LabelSelector, 36 | pub strategy: DeploymentStrategy, 37 | pub template: PodTemplateSpec, 38 | } 39 | 40 | // TODO: This should be an enum, with a redundant adjacent/external tag 41 | #[derive(Serialize, Deserialize, Debug, Clone)] 42 | #[serde(rename_all = "camelCase")] 43 | pub struct DeploymentStrategy { 44 | #[serde(rename = "type")] 45 | pub typ: DeploymentStrategyType, 46 | pub rolling_update: Option, 47 | } 48 | 49 | #[derive(Serialize, Deserialize, Debug, Clone, Copy, PartialEq)] 50 | pub enum DeploymentStrategyType { 51 | Recreate, 52 | RollingUpdate, 53 | } 54 | 55 | #[derive(Serialize, Deserialize, Debug, Clone)] 56 | #[serde(rename_all = "camelCase")] 57 | pub struct RollingUpdateDeployment { 58 | pub max_surge: Option, 59 | pub max_unavailable: Option, 60 | } 61 | 62 | #[derive(Serialize, Deserialize, Debug, Clone)] 63 | #[serde(rename_all = "camelCase")] 64 | pub struct DeploymentStatus { 65 | pub available_replicas: Integer, 66 | pub collision_count: Integer, 67 | #[serde(default)] 68 | pub conditions: Vec, 69 | pub observed_generation: Integer, 70 | pub ready_replicas: Integer, 71 | pub replicas: Integer, 72 | pub unavailable_replicas: Integer, 73 | pub updated_replicas: Integer, 74 | } 75 | 76 | #[derive(Serialize, Deserialize, Debug, Clone)] 77 | #[serde(rename_all = "camelCase")] 78 | pub struct DeploymentCondition { 79 | #[serde(rename = "type")] 80 | pub typ: DeploymentConditionType, 81 | pub status: ConditionStatus, 82 | pub last_update_time: Option