Browse Source

Convert README.md to ReStructuredTest format

Change-Id: Ie41074fd87256c376c46a53b039285bfafecab7d
story: 2002163
task: 22259
Denis Poisson 10 months ago
parent
commit
92b33a17ea
3 changed files with 120 additions and 88 deletions
  1. 0
    87
      README.md
  2. 119
    0
      README.rst
  3. 1
    1
      setup.cfg

+ 0
- 87
README.md View File

@@ -1,87 +0,0 @@
1
-Team and repository tags
2
-========================
3
-
4
-[![Team and repository tags](https://governance.openstack.org/badges/monasca-transform.svg)](https://governance.openstack.org/reference/tags/index.html)
5
-
6
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
7
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
8
-
9
-
10
-- [Monasca Transform](#monasca-transform)
11
-  - [Use Cases handled by Monasca Transform](#use-cases-handled-by-monasca-transform)
12
-  - [Operation](#operation)
13
-  - [Architecture](#architecture)
14
-  - [To set up the development environment](#to-set-up-the-development-environment)
15
-  - [Generic aggregation components](#generic-aggregation-components)
16
-  - [Create a new aggregation pipeline example](#create-a-new-aggregation-pipeline-example)
17
-  - [Original proposal and blueprint](#original-proposal-and-blueprint)
18
-
19
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
20
-
21
-# Monasca Transform
22
-
23
-monasca-transform is a data driven aggregation engine which collects, groups and aggregates existing
24
-individual Monasca metrics according to business requirements and publishes new transformed
25
-(derived) metrics to the Monasca Kafka queue.
26
-
27
-  * Since the new transformed metrics are published as any other metric in Monasca, alarms can be
28
-    set and triggered on the transformed metric.
29
-
30
-  * Monasca Transform uses [Apache Spark](http://spark.apache.org) to aggregate data. [Apache
31
-    Spark](http://spark.apache.org) is a highly scalable, fast, in-memory, fault tolerant and
32
-    parallel data processing framework. All monasca-transform components are implemented in Python
33
-    and use Spark's [PySpark Python API](http://spark.apache.org/docs/latest/api/python/index.html)
34
-    to interact with Spark.
35
-
36
-  * Monasca Transform does transformation and aggregation of incoming metrics in two phases.
37
-
38
-    * In the first phase spark streaming application is set to retrieve in data from kafka at a
39
-      configurable *stream interval* (default *stream_inteval* is 10 minutes) and write the data
40
-      aggregated for *stream interval* to *pre_hourly_metrics* topic in kafka.
41
-
42
-    * In the second phase, which is kicked off every hour, all metrics in *metrics_pre_hourly* topic
43
-      in Kafka are aggregated again, this time over a larger interval of an hour. These hourly
44
-      aggregated metrics published to *metrics* topic in kafka.
45
-
46
-## Use Cases handled by Monasca Transform ##
47
-Please refer to **Problem Description** section on the [Monasca/Transform
48
-wiki](https://wiki.openstack.org/wiki/Monasca/Transform)
49
-
50
-## Operation ##
51
-Please refer to **How Monasca Transform Operates** section on the [Monasca/Transform
52
-wiki](https://wiki.openstack.org/wiki/Monasca/Transform)
53
-
54
-## Architecture ##
55
-Please refer to **Architecture** and **Logical processing data flow** sections on the
56
-[Monasca/Transform wiki](https://wiki.openstack.org/wiki/Monasca/Transform)
57
-
58
-## To set up the development environment ##
59
-The monasca-transform uses [DevStack](https://docs.openstack.org/devstack/latest/) as a common dev
60
-environment. See the [README.md](devstack/README.md) in the devstack directory for details on how
61
-to include monasca-transform in a DevStack deployment.
62
-
63
-## Generic aggregation components ##
64
-
65
-Monasca Transform uses a set of generic aggregation components which can be assembled in to an
66
-aggregation pipeline.
67
-
68
-Please refer to [generic aggregation components](docs/generic-aggregation-components.md) document for
69
-information on list of generic aggregation components available.
70
-
71
-## Create a new aggregation pipeline example ##
72
-
73
-Generic aggregation components make it easy to build new aggregation pipelines for different Monasca
74
-metrics.
75
-
76
-This create a [new aggregation pipeline](docs/create-new-aggregation-pipeline.md) example shows how to
77
-create *pre_transform_specs* and *transform_specs* to create an aggregation pipeline for a new set
78
-of Monasca metrics, while leveraging existing set of generic aggregation components.
79
-
80
-
81
-## Original proposal and blueprint ##
82
-
83
-Original proposal:
84
-[Monasca/Transform-proposal](https://wiki.openstack.org/wiki/Monasca/Transform-proposal)
85
-
86
-Blueprint: [monasca-transform
87
-blueprint](https://blueprints.launchpad.net/monasca/+spec/monasca-transform)

+ 119
- 0
README.rst View File

@@ -0,0 +1,119 @@
1
+Team and repository tags
2
+========================
3
+
4
+.. image:: https://governance.openstack.org/badges/monasca-analytics.svg
5
+    :target: https://governance.openstack.org/reference/tags/index.html
6
+
7
+-  `Monasca Transform`_
8
+
9
+   -  `Use Cases handled by Monasca Transform`_
10
+   -  `Operation`_
11
+   -  `Architecture`_
12
+   -  `To set up the development environment`_
13
+   -  `Generic aggregation components`_
14
+   -  `Create a new aggregation pipeline example`_
15
+   -  `Original proposal and blueprint`_
16
+
17
+Monasca Transform
18
+=================
19
+
20
+monasca-transform is a data driven aggregation engine which collects,
21
+groups and aggregates existing individual Monasca metrics according to
22
+business requirements and publishes new transformed (derived) metrics to
23
+the Monasca Kafka queue.
24
+
25
+-  Since the new transformed metrics are published as any other metric
26
+   in Monasca, alarms can be set and triggered on the transformed
27
+   metric.
28
+
29
+-  Monasca Transform uses `Apache Spark`_ to aggregate data. `Apache
30
+   Spark`_ is a highly scalable, fast, in-memory, fault tolerant and
31
+   parallel data processing framework. All monasca-transform components
32
+   are implemented in Python and use Spark’s `PySpark Python API`_ to
33
+   interact with Spark.
34
+
35
+-  Monasca Transform does transformation and aggregation of incoming
36
+   metrics in two phases.
37
+
38
+   -  In the first phase spark streaming application is set to retrieve
39
+      in data from kafka at a configurable *stream interval* (default
40
+      *stream_inteval* is 10 minutes) and write the data aggregated for
41
+      *stream interval* to *pre_hourly_metrics* topic in kafka.
42
+
43
+   -  In the second phase, which is kicked off every hour, all metrics
44
+      in *metrics_pre_hourly* topic in Kafka are aggregated again, this
45
+      time over a larger interval of an hour. These hourly aggregated
46
+      metrics published to *metrics* topic in kafka.
47
+
48
+Use Cases handled by Monasca Transform
49
+--------------------------------------
50
+
51
+Please refer to **Problem Description** section on the
52
+`Monasca/Transform wiki`_
53
+
54
+Operation
55
+---------
56
+
57
+Please refer to **How Monasca Transform Operates** section on the
58
+`Monasca/Transform wiki`_
59
+
60
+Architecture
61
+------------
62
+
63
+Please refer to **Architecture** and **Logical processing data flow**
64
+sections on the `Monasca/Transform wiki`_
65
+
66
+To set up the development environment
67
+-------------------------------------
68
+
69
+The monasca-transform uses `DevStack`_ as a common dev environment. See
70
+the `README.md`_ in the devstack directory for details on how to include
71
+monasca-transform in a DevStack deployment.
72
+
73
+Generic aggregation components
74
+------------------------------
75
+
76
+Monasca Transform uses a set of generic aggregation components which can
77
+be assembled in to an aggregation pipeline.
78
+
79
+Please refer to the
80
+`generic-aggregation-components`_
81
+document for information on list of generic aggregation components
82
+available.
83
+
84
+Create a new aggregation pipeline example
85
+-----------------------------------------
86
+
87
+Generic aggregation components make it easy to build new aggregation
88
+pipelines for different Monasca metrics.
89
+
90
+This create a `new aggregation pipeline`_ example shows how to create
91
+*pre_transform_specs* and *transform_specs* to create an aggregation
92
+pipeline for a new set of Monasca metrics, while leveraging existing set
93
+of generic aggregation components.
94
+
95
+Original proposal and blueprint
96
+-------------------------------
97
+
98
+Original proposal: `Monasca/Transform-proposal`_
99
+
100
+Blueprint: `monasca-transform blueprint`_
101
+
102
+.. _Team and repository tags: https://governance.openstack.org/reference/tags/index.html
103
+.. _Monasca Transform: #monasca-transform
104
+.. _Use Cases handled by Monasca Transform: #use-cases-handled-by-monasca-transform
105
+.. _Operation: #operation
106
+.. _Architecture: #architecture
107
+.. _To set up the development environment: #to-set-up-the-development-environment
108
+.. _Generic aggregation components: #generic-aggregation-components
109
+.. _Create a new aggregation pipeline example: #create-a-new-aggregation-pipeline-example
110
+.. _Original proposal and blueprint: #original-proposal-and-blueprint
111
+.. _Apache Spark: http://spark.apache.org
112
+.. _generic-aggregation-components: docs/generic-aggregation-components.md
113
+.. _PySpark Python API: http://spark.apache.org/docs/latest/api/python/index.html
114
+.. _Monasca/Transform wiki: https://wiki.openstack.org/wiki/Monasca/Transform
115
+.. _DevStack: https://docs.openstack.org/devstack/latest/
116
+.. _README.md: devstack/README.md
117
+.. _new aggregation pipeline: docs/create-new-aggregation-pipeline.md
118
+.. _Monasca/Transform-proposal: https://wiki.openstack.org/wiki/Monasca/Transform-proposal
119
+.. _monasca-transform blueprint: https://blueprints.launchpad.net/monasca/+spec/monasca-transform

+ 1
- 1
setup.cfg View File

@@ -1,7 +1,7 @@
1 1
 [metadata]
2 2
 name=monasca_transform
3 3
 summary=Data Aggregation and Transformation component for Monasca
4
-description-file = README.md
4
+description-file = README.rst
5 5
 author= OpenStack
6 6
 author-email = openstack-dev@lists.openstack.org
7 7
 home-page=https://wiki.openstack.org/wiki/Monasca/Transform

Loading…
Cancel
Save