From 75c1c815a485c14794b986fcefdeae7ac57d6615 Mon Sep 17 00:00:00 2001 From: Onur Filiz Date: Fri, 24 Jun 2016 14:44:02 -0700 Subject: [PATCH] Added Code of Conduct to README --- README.md | 27 ++++++++++++--------------- 1 file changed, 12 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 7a7cdc7e6..9223e6e54 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,19 @@ # Overview -Aqua sets up networking for containers running in Azure VMs. -The current implementation does the following
-1. Implements the interface published by docker's libnetwork. +Aqua is a libnetwork plugin that allows you to take advantage of the power of the Microsoft Azure SDN capabilities for your containers running in Azure. -# Usage +## Usage aqua [net] [ipam] -# Examples -To start the remote network plugin for docker: aqua net
-To start the remote ipam plugin for docker: aqua ipam
+## Examples +Create a network with aqua:
+```bash +docker network create --driver=aquanet --ipam-driver=aquaipam azure +``` -To create a docker network called "azure", use the following
-docker network create --driver=aqua --ipam-driver=nullipam azure - -Once the above network is created, you can have container join the above network as follows
+Connect containers to your network by specifying the network name when starting them:
+```bash docker run --net=azure -it ubuntu:latest /bin/bash +``` -#Requirements -Aqua currently relies on the fact that the interfaces in the VM are provisioned with multiple ip-addresses (called CAs in azure). In the current version of Aqua, multiple ip-addresses need to be manually configured on the interface. These ip-addresses need to be provisioned via Azure ARM APIs before they can be used inside VMs. - -For help, send an email to +## Code of Conduct +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.