1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
//! [](https://crates.io/crates/bollard) //! [](https://opensource.org/licenses/Apache-2.0) //! [](https://circleci.com/gh/fussybeaver/bollard/tree/master) //! [](https://ci.appveyor.com/project/fussybeaver/boondock) //! [](https://docs.rs/bollard/) //! //! # Bollard: an asynchronous rust client library for the docker API //! //! Bollard leverages the latest [Hyper](https://github.com/hyperium/hyper) and //! [Tokio](https://github.com/tokio-rs/tokio) improvements for an asynchronous API containing //! futures, streams and the async/await paradigm. //! //! The library also features Windows support through Named Pipes and HTTPS support through //! optional SSL bindings or a native TLS implementation. //! //! # Install //! //! Add the following to your `Cargo.toml` file //! //! ```nocompile //! [dependencies] //! bollard = "0.7" //! ``` //! //! # API //! ## Documentation //! //! [API docs](https://docs.rs/bollard/). //! //! As of version 0.6, this project now generates API stubs from the upstream Docker-maintained //! Swagger OpenAPI specification. The generated models are committed to this repository, but //! packaged in a separate crate [bollard-stubs](https://crates.io/crates/bollard-stubs). //! //! ## Version //! //! The [Docker API](https://docs.docker.com/engine/api/v1.40/) is pegged at version `1.40` //! //! # Usage //! //! ## Connecting with the docker daemon //! //! Connect to the docker server according to your architecture and security remit. //! //! ### Unix socket //! //! The client will connect to the standard unix socket location `/var/run/docker.sock`. Use the //! `Docker::connect_with_unix` method API to parameterise the //! interface. //! //! ```rust //! use bollard::Docker; //! #[cfg(unix)] //! Docker::connect_with_unix_defaults(); //! ``` //! //! ### Windows named pipe //! //! The client will connect to the standard windows pipe location `\\.\pipe\docker_engine`. Use the //! `Docker::connect_with_name_pipe` method API //! to parameterise the interface. //! //! ```rust //! use bollard::Docker; //! #[cfg(windows)] //! Docker::connect_with_named_pipe_defaults(); //! ``` //! //! ### Local //! //! The client will connect to the OS specific handler it is compiled for. //! This is a convenience for localhost environment that should run on multiple //! operating systems. //! Use the `Docker::connect_with_local` method API to parameterise the interface. //! ```rust //! use bollard::Docker; //! Docker::connect_with_local_defaults(); //! ``` //! //! ### HTTP //! //! The client will connect to the location pointed to by `DOCKER_HOST` environment variable, or //! `localhost:2375` if missing. Use the //! `Docker::connect_with_http` method API to //! parameterise the interface. //! //! ```rust //! use bollard::Docker; //! Docker::connect_with_http_defaults(); //! ``` //! //! ### SSL via openssl //! //! Openssl is switched off by default, and can be enabled through the `ssl` cargo feature. //! //! The client will connect to the location pointed to by `DOCKER_HOST` environment variable, or //! `localhost:2375` if missing. //! //! The location pointed to by the `DOCKER_CERT_PATH` environment variable is searched for //! certificates - `key.pem` for the private key, `cert.pem` for the server certificate and //! `ca.pem` for the certificate authority chain. //! //! Use the `Docker::connect_with_ssl` method API //! to parameterise the interface. //! //! ```rust //! use bollard::Docker; //! #[cfg(feature = "ssl")] //! Docker::connect_with_ssl_defaults(); //! ``` //! //! ### TLS //! //! Native TLS allows you to avoid the SSL bindings. //! //! The client will connect to the location pointed to by `DOCKER_HOST` environment variable, or //! `localhost:2375` if missing. //! //! The location pointed to by the `DOCKER_CERT_PATH` environment variable is searched for //! certificates - `identity.pfx` for the PKCS #12 archive and `ca.pem` for the certificate //! authority chain. //! //! Use the `Docker::connect_with_ssl` method API //! to parameterise the interface. //! //! ```rust //! use bollard::Docker; //! #[cfg(feature = "tls")] //! Docker::connect_with_tls_defaults(); //! ``` //! //! ## Examples //! //! Note: all these examples need a [Tokio //! Runtime](https://tokio.rs/docs/getting-started/runtime/). A small example about how to use //! Tokio is further below. //! //! ### Version //! //! First, check that the API is working with your server: //! //! ```rust, no_run //! use bollard::Docker; //! //! use futures_util::future::FutureExt; //! //! // Use a connection function described above //! // let docker = Docker::connect_...; //! # let docker = Docker::connect_with_local_defaults().unwrap(); //! //! async move { //! let version = docker.version().await.unwrap(); //! println!("{:?}", version); //! }; //! ``` //! //! ### Listing images //! //! To list docker images available on the Docker server: //! //! ```rust,no_run //! use bollard::Docker; //! use bollard::image::ListImagesOptions; //! //! use futures_util::future::FutureExt; //! //! use std::default::Default; //! //! // Use a connection function described above //! // let docker = Docker::connect_...; //! # let docker = Docker::connect_with_local_defaults().unwrap(); //! //! async move { //! let images = &docker.list_images(Some(ListImagesOptions::<String> { //! all: true, //! ..Default::default() //! })).await.unwrap(); //! //! for image in images { //! println!("-> {:?}", image); //! } //! }; //! ``` //! //! ## Streaming Stats //! //! To receive a stream of stats for a running container. //! //! ```rust,no_run //! use bollard::Docker; //! use bollard::container::StatsOptions; //! //! use futures_util::stream::TryStreamExt; //! //! use std::default::Default; //! //! // Use a connection function described above //! // let docker = Docker::connect_...; //! # let docker = Docker::connect_with_local_defaults().unwrap(); //! //! async move { //! let stats = &docker.stats("postgres", Some(StatsOptions { //! stream: true, //! ..Default::default() //! })).try_collect::<Vec<_>>().await.unwrap(); //! //! for stat in stats { //! println!("{} - mem total: {:?} | mem usage: {:?}", //! stat.name, //! stat.memory_stats.max_usage, //! stat.memory_stats.usage); //! } //! }; //! ``` //! //! # Examples //! //! Further examples are available in the examples folder, or the integration/unit tests. //! //! ## A Primer on the Tokio Runtime //! //! In order to use the API effectively, you will need to be familiar with the [Tokio //! Runtime](https://tokio.rs/docs/getting-started/runtime/). //! //! Create a Tokio Runtime: //! //! ```rust //! use tokio::runtime::Runtime; //! //! let rt = Runtime::new().unwrap(); //! ``` //! //! Subsequently, use the docker API: //! //! ```rust,no_run //! # use bollard::Docker; //! # use bollard::image::ListImagesOptions; //! # use futures_util::future::FutureExt; //! // Use a connection function described above //! // let docker = Docker::connect_...; //! # let docker = Docker::connect_with_local_defaults().unwrap(); //! let future = async move { //! &docker.list_images(None::<ListImagesOptions<String>>).await; //! }; //! ``` //! //! Execute the future aynchronously: //! //! ```rust,no_run //! # use bollard::Docker; //! # use bollard::image::ListImagesOptions; //! # use tokio::runtime::Runtime; //! # use futures_util::future::FutureExt; //! # let mut rt = Runtime::new().unwrap(); //! # let docker = Docker::connect_with_local_defaults().unwrap(); //! # let future = async move { //! # docker.list_images(None::<ListImagesOptions<String>>).map(|_| ()); //! # }; //! rt.spawn(future); //! ``` //! //! Or, to execute and receive the result: //! //! ```rust,no_run //! # use bollard::Docker; //! # use bollard::image::ListImagesOptions; //! # use tokio::runtime::Runtime; //! # use futures_util::future::FutureExt; //! # let mut rt = Runtime::new().unwrap(); //! # let docker = Docker::connect_with_local_defaults().unwrap(); //! # let future = docker.list_images(None::<ListImagesOptions<String>>); //! let result = rt.block_on(future); //! ``` //! //! # Building the stubs //! //! Serialization stubs are generated through the [Swagger //! library](https://github.com/swagger-api/swagger-codegen/). To generate these files, use the //! following in the `codegen` folder: //! //! ```bash //! mvn -D org.slf4j.simpleLogger.defaultLogLevel=debug clean compiler:compile generate-resources //! ``` //! //! # History //! //! This library stems from the [boondock rust library](https://github.com/faradayio/boondock), //! which in turn originates from the [rust-docker library](https://github.com/ghmlee/rust-docker), but //! most parts were rewritten to adobt the new functionality provided by tokio. Many thanks to the //! original authors for the initial code and inspiration. //! //! # Integration tests //! //! Running the integration tests by default requires a running docker registry, with images tagged //! and pushed there. To disable this behaviour, set the `DISABLE_REGISTRY` environment variable. //! //! ```bash //! docker run -d --restart always --name registry -p 5000:5000 registry:2 //! docker pull hello-world:linux //! docker pull fussybeaver/uhttpd //! docker pull alpine //! docker tag hello-world:linux localhost:5000/hello-world:linux //! docker tag fussybeaver/uhttpd localhost:5000/fussybeaver/uhttpd //! docker tag alpine localhost:5000/alpine //! docker push localhost:5000/hello-world:linux //! docker push localhost:5000/fussybeaver/uhttpd //! docker push localhost:5000/alpine //! docker swarm init //! REGISTRY_HTTP_ADDR=localhost:5000 cargo test -- --test-threads 1 //! ``` #![deny( missing_docs, missing_debug_implementations, missing_copy_implementations, trivial_casts, trivial_numeric_casts, unstable_features, unused_import_braces, unused_qualifications )] #![warn(rust_2018_idioms)] #[macro_use] extern crate failure; #[macro_use] extern crate serde_derive; #[macro_use] extern crate log; // declare modules pub mod auth; pub mod container; mod docker; pub mod errors; pub mod exec; pub mod image; mod named_pipe; pub mod network; mod read; pub mod service; pub mod system; mod uri; pub mod volume; // publicly re-export pub use crate::docker::{ClientVersion, Docker, API_DEFAULT_VERSION}; pub use bollard_stubs::models;