diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index e9ac672..05b7c16 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -28,4 +28,11 @@ Glossary api Web API central - The Central service that does CRUD operations and more in BS. \ No newline at end of file + The Central service that does CRUD operations and more in BS. + customer + An entity underneath :term:`merchant` that holds different data that + resembles a Customer in an external system like a Tenant, Project etc. + merchant + An entity that holds one or more users, can configure integration with + third party services like OpenStack ceilometer, configure api + credentials for API access etc. \ No newline at end of file diff --git a/doc/source/index.rst b/doc/source/index.rst index 4048e3b..8225239 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -15,6 +15,7 @@ Contents: api glossary install/index + resources/index Indices and tables diff --git a/doc/source/resources/index.rst b/doc/source/resources/index.rst new file mode 100644 index 0000000..cc50083 --- /dev/null +++ b/doc/source/resources/index.rst @@ -0,0 +1,25 @@ +.. + Copyright 2013 Endre Karlson + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +.. _install: + +========================= +Resources in Billingstack +========================= + +.. toctree:: + :maxdepth: 2 + + subscriptions \ No newline at end of file diff --git a/doc/source/resources/subscriptions.rst b/doc/source/resources/subscriptions.rst new file mode 100644 index 0000000..1524c6b --- /dev/null +++ b/doc/source/resources/subscriptions.rst @@ -0,0 +1,41 @@ +.. + Copyright 2013 Endre Karlson + + Licensed under the Apache License, Version 2.0 (the "License"); you may + not use this file except in compliance with the License. You may obtain + a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, WITHOUT + WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the + License for the specific language governing permissions and limitations + under the License. + +.. _subscription: + + +============ +Subscription +============ + +.. index:: + double: subscription; brief + +Process ++++++++ + +.. note:: Try to outline a sample subscription creation process. + +* Prerequisites: Registered Merchant with API credentials configured for a Service. + +1. The :term:`merchant` configures a API access key for others services. +2. Have an external service to create a new subscription against + BillingStack when a new :term:`resource` is created in a system. + +3. Subscription is either created towards an existing:term:`customer` or + if the :term:`merchant` has a setting configured to allow :term:`customer` + created if the given customer doesn't exist it will be created along with + subscription. +4. When a subscription is created we're ready to receive events from a system. \ No newline at end of file