https://github.com/hisea/dockerex

https://github.com/hisea/dockerex

Last synced: about 1 month ago
JSON representation

• Host: GitHub
• URL: https://github.com/hisea/dockerex
• Owner: hisea
• Created: 2016-07-30T02:22:29.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-08-07T14:59:17.000Z (over 7 years ago)
• Last Synced: 2024-10-07T11:13:05.231Z (2 months ago)
• Language: Elixir
• Size: 11.7 KB
• Stars: 19
• Watchers: 3
• Forks: 10
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Lightweight Docker Remote API Client with SSL/TLS login/connection support. (Third Party APIs)
• fucking-awesome-elixir - dockerex - Lightweight Docker Remote API Client with SSL/TLS login/connection support. (Third Party APIs)
• awesome-elixir - dockerex - Lightweight Docker Remote API Client with SSL/TLS login/connection support. (Third Party APIs)

README

        
# Dockerex

Dockerex is a lightweight Docker Remote API Client for Elixir that supports SSL connection to a Docker Host or a Docker Swarm manager.

 Dockerex is tested against latest [Docker Remote API v1.24](https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/).

 

## Installation

The package can be installed as:

  1. Add `dockerex` to your list of dependencies in `mix.exs`:

  ```elixir

  def deps do

    [{:dockerex, "~> 0.1.0"}]

  end

  ```

  2. Ensure `dockerex` is started before your application:

  ```elixir

  def application do

    [applications: [:dockerex]]

  end

  ```

  

  3. Config your docker host in `config.exs`

  

  ```elixir

  config :dockerex,

  host: "https://10.10.10.1:2376/",

  options: [

    ssl:  [

      {:certfile, "/path/to/your/cert.pem"},

      {:keyfile, "/path/to/your/key.pem"}

    ]

  ]

  ```

  

You may also establish a connection to the docker engine over a unix socket. To

do this, set the host variable in your config to `"http+unix://PATH/"`. Note

that `PATH` has to be URI-encoded, i.e. the default socket path would be

`%2Fvar%2Frun%2Fdocker.sock`.

## Usage

 Dockerex is a lightweight client, which means you need to specify the endpoint and original docker params in a map format.

Before making any requests, you have to start the HTTP client by calling

`HTTPoison.start`.

 Some examples:

  ```elixir

  result = Dockerex.Client.post("containers/create", %{"Image": "nginx",

                                                       "Tty": true,

                                                       "HostConfig": %{"RestartPolicy": %{ "Name": "always"}},

                                                       "Cmd": ["start.sh"]})

  cid = result["Id"]

  Dockerex.Client.post("containers/#{cid}/start")

    

  Dockerex.Client.post("containers/#{cid}/stop")

    

  Dockerex.Client.get("containers/#{cid}/logs?stderr=1&stdout=1&timestamps=0&since=#{DateTime.to_unix(DateTime.utc_now) - 5}")

    

  Dockerex.Client.delete("containers/#{cid}")

```