Skip to content

Commit

Permalink
Release 0.11
Browse files Browse the repository at this point in the history
  • Loading branch information
fussybeaver committed Jun 20, 2021
1 parent 7342957 commit cbb1bb3
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 26 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "bollard"
description = "An asynchronous Docker daemon API"
version = "0.10.1"
version = "0.11.0"
authors = [ "Bollard contributors" ]
license = "Apache-2.0"
homepage = "https://github.com/fussybeaver/bollard"
Expand Down
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,33 @@ 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 (disabled in 0.10, see below) and
HTTPS support through optional rustls bindings.
The library also features Windows support through Named Pipes and HTTPS support through
optional rustls bindings.

## Install

Add the following to your `Cargo.toml` file

```nocompile
[dependencies]
bollard = "0.9"
bollard = "0.11"
```

## API
### Documentation

[API docs](crate).

Version 0.10 disables Named Pipe Windows support until the upstream Tokio project re-adds
support for Named Pipes. Please follow the [tracking
issue](https://github.com/tokio-rs/tokio/issues/3511) for updates on this.
Version 0.11 re-enables Windows Named Pipe support.

As of version 0.6, this project now generates API stubs from the upstream Docker-maintained
[Swagger OpenAPI specification](https://docs.docker.com/engine/api/v1.40.yaml). The generated
[Swagger OpenAPI specification](https://docs.docker.com/engine/api/v1.41.yaml). 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`. The
The [Docker API](https://docs.docker.com/engine/api/v1.41/) is pegged at version `1.41`. The
library also supports [version
negotiation](https://docs.rs/bollard/latest/bollard/struct.Docker.html#method.negotiate_version),
to allow downgrading to an older API version.
Expand All @@ -49,15 +47,16 @@ to allow downgrading to an older API version.

Connect to the docker server according to your architecture and security remit.

#### Unix socket
#### 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.
The client will connect to the standard unix socket location `/var/run/docker.sock` or windows
named pipe location `//./pipe/docker_engine`. Use the `Docker::connect_with_socket` method API
to parameterise the interface.

```rust
use bollard::Docker;
#[cfg(unix)]
Docker::connect_with_unix_defaults();
Docker::connect_with_socket_defaults();
```

#### Local
Expand Down
25 changes: 12 additions & 13 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -10,35 +10,33 @@
//! [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 (disabled in 0.10, see below) and
//! HTTPS support through optional rustls bindings.
//! The library also features Windows support through Named Pipes and HTTPS support through
//! optional rustls bindings.
//!
//! # Install
//!
//! Add the following to your `Cargo.toml` file
//!
//! ```nocompile
//! [dependencies]
//! bollard = "0.9"
//! bollard = "0.11"
//! ```
//!
//! # API
//! ## Documentation
//!
//! [API docs](crate).
//!
//! Version 0.10 disables Named Pipe Windows support until the upstream Tokio project re-adds
//! support for Named Pipes. Please follow the [tracking
//! issue](https://github.com/tokio-rs/tokio/issues/3511) for updates on this.
//!
//! Version 0.11 re-enables Windows Named Pipe support.
//!
//! As of version 0.6, this project now generates API stubs from the upstream Docker-maintained
//! [Swagger OpenAPI specification](https://docs.docker.com/engine/api/v1.40.yaml). The generated
//! [Swagger OpenAPI specification](https://docs.docker.com/engine/api/v1.41.yaml). 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`. The
//! The [Docker API](https://docs.docker.com/engine/api/v1.41/) is pegged at version `1.41`. The
//! library also supports [version
//! negotiation](https://docs.rs/bollard/latest/bollard/struct.Docker.html#method.negotiate_version),
//! to allow downgrading to an older API version.
Expand All @@ -49,15 +47,16 @@
//!
//! Connect to the docker server according to your architecture and security remit.
//!
//! ### Unix socket
//! ### 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.
//! The client will connect to the standard unix socket location `/var/run/docker.sock` or windows
//! named pipe location `//./pipe/docker_engine`. Use the `Docker::connect_with_socket` method API
//! to parameterise the interface.
//!
//! ```rust
//! use bollard::Docker;
//! #[cfg(unix)]
//! Docker::connect_with_unix_defaults();
//! Docker::connect_with_socket_defaults();
//! ```
//!
//! ### Local
Expand Down

0 comments on commit cbb1bb3

Please sign in to comment.