From d769196098d55f39ba1bdc08c0422c711a2b1bbd Mon Sep 17 00:00:00 2001 From: Somik Behera Date: Mon, 6 Jun 2011 10:34:43 -0700 Subject: [PATCH] Added a basic README file and updated Quantum plugin base class with appropriate exceptions. --- README | 29 +++++++++++++++++++++++++++++ quantum/quantum_plugin_base.py | 2 +- 2 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 README diff --git a/README b/README new file mode 100644 index 000000000..e09f1ab8a --- /dev/null +++ b/README @@ -0,0 +1,29 @@ +# -- Welcome! + + You have come across a cloud computing network fabric controller. It has identified + itself as "Quantum." It aims to tame your (cloud) networking! + +# -- Basics: + +1) Quantum REST API: Quantum supports a REST-ful programmatic interface to manage your + cloud networking fabric. + +2) Quantum Plugins: Quantum sports a plug-able architecture that allows Quantum's REST API + to be backed by various entities that can create a cloud-class virtual networking fabric. + The advantages of this plug-able architecture is two-folds: + + a) Allows for ANY open-source project or commercial vendor to write a Quantum plug-in. + + b) Allows Quantum users to not be tied down to a single Quantum implementation and + enables them to switch out a plug-in by simple editing a config file - plugins.ini + +# -- Configuring Quantum plug-in + +# -- Launching the Quantum Service + +# -- Making requests against the Quantum Service + +# -- CLI tools to program the Quantum-managed network fabric + +# -- Writing your own Quantum plug-in + \ No newline at end of file diff --git a/quantum/quantum_plugin_base.py b/quantum/quantum_plugin_base.py index bf2976ec6..843bc85c5 100644 --- a/quantum/quantum_plugin_base.py +++ b/quantum/quantum_plugin_base.py @@ -37,7 +37,7 @@ class QuantumPluginBase(object): the specified tenant. :returns: - :raises: + :raises: None """ pass -- 2.45.2