From: Tim Van Steenburgh <tvansteenburgh@gmail.com>
Date: Tue, 13 Dec 2016 17:56:39 +0000 (-0500)
Subject: Relation docs
X-Git-Tag: 0.1.0~13
X-Git-Url: https://osm.etsi.org/gitweb/?p=osm%2FN2VC.git;a=commitdiff_plain;h=63a8dfb2e67f469614dc4856405f5969d56b57e8

Relation docs
---

diff --git a/docs/narrative/application.rst b/docs/narrative/application.rst
index c255a37..630ce85 100644
--- a/docs/narrative/application.rst
+++ b/docs/narrative/application.rst
@@ -70,3 +70,46 @@ application. The `mysql_app` object is an instance of
   constraints = await mysql_app.get_constraints()
 
   assert(constraints['mem'] == 512 * MB)
+
+
+Adding and Removing Relations
+-----------------------------
+The :meth:`juju.application.Application.add_relation` method returns a
+:class:`juju.relation.Relation` instance.
+
+.. code:: python
+
+  from juju.model import Model
+
+  model = Model()
+  await model.connect_current()
+
+  # Deploy mysql-master application
+  mysql_master = await model.deploy(
+      'cs:mysql-55',
+      application_name='mysql-master',
+      series='trusty',
+      channel='stable',
+  )
+
+  # Deploy mysql-slave application
+  mysql_slave = await model.deploy(
+      'cs:mysql-55',
+      application_name='mysql-slave',
+      series='trusty',
+      channel='stable',
+  )
+
+  # Add the master-slave relation
+  relation = await mysql_master.add_relation(
+      # Name of the relation on the local (mysql-master) side
+      'master',
+      # Name of the app:relation on the remote side
+      'mysql-slave:slave',
+  )
+
+  # Remove the relation
+  await mysql_master.remove_relation(
+      'master',
+      'mysql-slave:slave',
+  )
diff --git a/juju/relation.py b/juju/relation.py
index 571cd01..e52affa 100644
--- a/juju/relation.py
+++ b/juju/relation.py
@@ -6,4 +6,6 @@ log = logging.getLogger(__name__)
 
 
 class Relation(model.ModelEntity):
-    pass
+    async def destroy(self):
+        pass
+        # TODO: destroy a relation