Added Code of Conduct to README

This commit is contained in:
Onur Filiz 2016-06-24 14:44:02 -07:00 коммит произвёл GitHub
Родитель 2771661e61
Коммит 75c1c815a4
1 изменённых файлов: 12 добавлений и 15 удалений

Просмотреть файл

@ -1,22 +1,19 @@
# Overview
Aqua sets up networking for containers running in Azure VMs.
The current implementation does the following<br>
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<br>
To start the remote ipam plugin for docker: aqua ipam<br>
## Examples
Create a network with aqua:<br>
```bash
docker network create --driver=aquanet --ipam-driver=aquaipam azure
```
To create a docker network called "azure", use the following<br>
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<br>
Connect containers to your network by specifying the network name when starting them:<br>
```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.