Browse Source

Initial commit from cookiecutter

Change-Id: I99fac20f40b2ca006d0a95ded27fe8140d795f50
bharath 6 months ago
parent
commit
72ef73e22f

+ 15
- 0
CONTRIBUTING.rst View File

@@ -0,0 +1,15 @@
1
+If you would like to contribute to the development of OpenStack, you must
2
+follow the steps in this page:
3
+
4
+   http://docs.openstack.org/infra/manual/developers.html
5
+
6
+If you already have a good understanding of how the system works and your
7
+OpenStack accounts are set up, you can skip to the development workflow
8
+section of this documentation to learn how changes to OpenStack should be
9
+submitted for review via the Gerrit tool:
10
+
11
+   http://docs.openstack.org/infra/manual/developers.html#development-workflow
12
+
13
+Pull requests submitted through GitHub will be ignored.
14
+
15
+Bugs should be filed on Storyboardhttps://storyboard.openstack.org/#!/project/gyan

+ 4
- 0
HACKING.rst View File

@@ -0,0 +1,4 @@
1
+gyan Style Commandments
2
+===============================================
3
+
4
+Read the OpenStack Style Commandments https://docs.openstack.org/hacking/latest/

+ 176
- 0
LICENSE View File

@@ -0,0 +1,176 @@
1
+
2
+                                 Apache License
3
+                           Version 2.0, January 2004
4
+                        http://www.apache.org/licenses/
5
+
6
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+   1. Definitions.
9
+
10
+      "License" shall mean the terms and conditions for use, reproduction,
11
+      and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+      "Licensor" shall mean the copyright owner or entity authorized by
14
+      the copyright owner that is granting the License.
15
+
16
+      "Legal Entity" shall mean the union of the acting entity and all
17
+      other entities that control, are controlled by, or are under common
18
+      control with that entity. For the purposes of this definition,
19
+      "control" means (i) the power, direct or indirect, to cause the
20
+      direction or management of such entity, whether by contract or
21
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+      outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+      "You" (or "Your") shall mean an individual or Legal Entity
25
+      exercising permissions granted by this License.
26
+
27
+      "Source" form shall mean the preferred form for making modifications,
28
+      including but not limited to software source code, documentation
29
+      source, and configuration files.
30
+
31
+      "Object" form shall mean any form resulting from mechanical
32
+      transformation or translation of a Source form, including but
33
+      not limited to compiled object code, generated documentation,
34
+      and conversions to other media types.
35
+
36
+      "Work" shall mean the work of authorship, whether in Source or
37
+      Object form, made available under the License, as indicated by a
38
+      copyright notice that is included in or attached to the work
39
+      (an example is provided in the Appendix below).
40
+
41
+      "Derivative Works" shall mean any work, whether in Source or Object
42
+      form, that is based on (or derived from) the Work and for which the
43
+      editorial revisions, annotations, elaborations, or other modifications
44
+      represent, as a whole, an original work of authorship. For the purposes
45
+      of this License, Derivative Works shall not include works that remain
46
+      separable from, or merely link (or bind by name) to the interfaces of,
47
+      the Work and Derivative Works thereof.
48
+
49
+      "Contribution" shall mean any work of authorship, including
50
+      the original version of the Work and any modifications or additions
51
+      to that Work or Derivative Works thereof, that is intentionally
52
+      submitted to Licensor for inclusion in the Work by the copyright owner
53
+      or by an individual or Legal Entity authorized to submit on behalf of
54
+      the copyright owner. For the purposes of this definition, "submitted"
55
+      means any form of electronic, verbal, or written communication sent
56
+      to the Licensor or its representatives, including but not limited to
57
+      communication on electronic mailing lists, source code control systems,
58
+      and issue tracking systems that are managed by, or on behalf of, the
59
+      Licensor for the purpose of discussing and improving the Work, but
60
+      excluding communication that is conspicuously marked or otherwise
61
+      designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+      "Contributor" shall mean Licensor and any individual or Legal Entity
64
+      on behalf of whom a Contribution has been received by Licensor and
65
+      subsequently incorporated within the Work.
66
+
67
+   2. Grant of Copyright License. Subject to the terms and conditions of
68
+      this License, each Contributor hereby grants to You a perpetual,
69
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+      copyright license to reproduce, prepare Derivative Works of,
71
+      publicly display, publicly perform, sublicense, and distribute the
72
+      Work and such Derivative Works in Source or Object form.
73
+
74
+   3. Grant of Patent License. Subject to the terms and conditions of
75
+      this License, each Contributor hereby grants to You a perpetual,
76
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+      (except as stated in this section) patent license to make, have made,
78
+      use, offer to sell, sell, import, and otherwise transfer the Work,
79
+      where such license applies only to those patent claims licensable
80
+      by such Contributor that are necessarily infringed by their
81
+      Contribution(s) alone or by combination of their Contribution(s)
82
+      with the Work to which such Contribution(s) was submitted. If You
83
+      institute patent litigation against any entity (including a
84
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+      or a Contribution incorporated within the Work constitutes direct
86
+      or contributory patent infringement, then any patent licenses
87
+      granted to You under this License for that Work shall terminate
88
+      as of the date such litigation is filed.
89
+
90
+   4. Redistribution. You may reproduce and distribute copies of the
91
+      Work or Derivative Works thereof in any medium, with or without
92
+      modifications, and in Source or Object form, provided that You
93
+      meet the following conditions:
94
+
95
+      (a) You must give any other recipients of the Work or
96
+          Derivative Works a copy of this License; and
97
+
98
+      (b) You must cause any modified files to carry prominent notices
99
+          stating that You changed the files; and
100
+
101
+      (c) You must retain, in the Source form of any Derivative Works
102
+          that You distribute, all copyright, patent, trademark, and
103
+          attribution notices from the Source form of the Work,
104
+          excluding those notices that do not pertain to any part of
105
+          the Derivative Works; and
106
+
107
+      (d) If the Work includes a "NOTICE" text file as part of its
108
+          distribution, then any Derivative Works that You distribute must
109
+          include a readable copy of the attribution notices contained
110
+          within such NOTICE file, excluding those notices that do not
111
+          pertain to any part of the Derivative Works, in at least one
112
+          of the following places: within a NOTICE text file distributed
113
+          as part of the Derivative Works; within the Source form or
114
+          documentation, if provided along with the Derivative Works; or,
115
+          within a display generated by the Derivative Works, if and
116
+          wherever such third-party notices normally appear. The contents
117
+          of the NOTICE file are for informational purposes only and
118
+          do not modify the License. You may add Your own attribution
119
+          notices within Derivative Works that You distribute, alongside
120
+          or as an addendum to the NOTICE text from the Work, provided
121
+          that such additional attribution notices cannot be construed
122
+          as modifying the License.
123
+
124
+      You may add Your own copyright statement to Your modifications and
125
+      may provide additional or different license terms and conditions
126
+      for use, reproduction, or distribution of Your modifications, or
127
+      for any such Derivative Works as a whole, provided Your use,
128
+      reproduction, and distribution of the Work otherwise complies with
129
+      the conditions stated in this License.
130
+
131
+   5. Submission of Contributions. Unless You explicitly state otherwise,
132
+      any Contribution intentionally submitted for inclusion in the Work
133
+      by You to the Licensor shall be under the terms and conditions of
134
+      this License, without any additional terms or conditions.
135
+      Notwithstanding the above, nothing herein shall supersede or modify
136
+      the terms of any separate license agreement you may have executed
137
+      with Licensor regarding such Contributions.
138
+
139
+   6. Trademarks. This License does not grant permission to use the trade
140
+      names, trademarks, service marks, or product names of the Licensor,
141
+      except as required for reasonable and customary use in describing the
142
+      origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+   7. Disclaimer of Warranty. Unless required by applicable law or
145
+      agreed to in writing, Licensor provides the Work (and each
146
+      Contributor provides its Contributions) on an "AS IS" BASIS,
147
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+      implied, including, without limitation, any warranties or conditions
149
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+      PARTICULAR PURPOSE. You are solely responsible for determining the
151
+      appropriateness of using or redistributing the Work and assume any
152
+      risks associated with Your exercise of permissions under this License.
153
+
154
+   8. Limitation of Liability. In no event and under no legal theory,
155
+      whether in tort (including negligence), contract, or otherwise,
156
+      unless required by applicable law (such as deliberate and grossly
157
+      negligent acts) or agreed to in writing, shall any Contributor be
158
+      liable to You for damages, including any direct, indirect, special,
159
+      incidental, or consequential damages of any character arising as a
160
+      result of this License or out of the use or inability to use the
161
+      Work (including but not limited to damages for loss of goodwill,
162
+      work stoppage, computer failure or malfunction, or any and all
163
+      other commercial damages or losses), even if such Contributor
164
+      has been advised of the possibility of such damages.
165
+
166
+   9. Accepting Warranty or Additional Liability. While redistributing
167
+      the Work or Derivative Works thereof, You may choose to offer,
168
+      and charge a fee for, acceptance of support, warranty, indemnity,
169
+      or other liability obligations and/or rights consistent with this
170
+      License. However, in accepting such obligations, You may act only
171
+      on Your own behalf and on Your sole responsibility, not on behalf
172
+      of any other Contributor, and only if You agree to indemnify,
173
+      defend, and hold each Contributor harmless for any liability
174
+      incurred by, or claims asserted against, such Contributor by reason
175
+      of your accepting any such warranty or additional liability.
176
+

+ 16
- 0
README.rst View File

@@ -0,0 +1,16 @@
1
+===============================
2
+gyan
3
+===============================
4
+
5
+Machine Learning Infra as a service
6
+
7
+Please fill here a long description which must be at least 3 lines wrapped on
8
+80 cols, so that distribution package maintainers can use it in their packages.
9
+Note that this is a hard requirement.
10
+
11
+* Free software: Apache license
12
+* Documentation: https://docs.openstack.org/gyan/latest
13
+* Source: https://git.openstack.org/cgit/openstack/gyan* Bugs: https://storyboard.openstack.org/#!/project/gyanFeatures
14
+--------
15
+
16
+* TODO

+ 2
- 0
babel.cfg View File

@@ -0,0 +1,2 @@
1
+[python: **.py]
2
+

+ 4
- 0
doc/requirements.txt View File

@@ -0,0 +1,4 @@
1
+sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
2
+openstackdocstheme>=1.18.1  # Apache-2.0
3
+# releasenotes
4
+reno>=2.5.0 # Apache-2.0

+ 5
- 0
doc/source/admin/index.rst View File

@@ -0,0 +1,5 @@
1
+====================
2
+Administrators guide
3
+====================
4
+
5
+Administrators guide of gyan.

+ 5
- 0
doc/source/cli/index.rst View File

@@ -0,0 +1,5 @@
1
+================================
2
+Command line interface reference
3
+================================
4
+
5
+CLI reference of gyan.

+ 82
- 0
doc/source/conf.py View File

@@ -0,0 +1,82 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+import os
16
+import sys
17
+
18
+sys.path.insert(0, os.path.abspath('../..'))
19
+# -- General configuration ----------------------------------------------------
20
+
21
+# Add any Sphinx extension module names here, as strings. They can be
22
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
23
+extensions = [
24
+    'sphinx.ext.autodoc',
25
+    'openstackdocstheme',
26
+    #'sphinx.ext.intersphinx',
27
+]
28
+
29
+# autodoc generation is a bit aggressive and a nuisance when doing heavy
30
+# text edit cycles.
31
+# execute "export SPHINX_DEBUG=1" in your terminal to disable
32
+
33
+# The suffix of source filenames.
34
+source_suffix = '.rst'
35
+
36
+# The master toctree document.
37
+master_doc = 'index'
38
+
39
+# General information about the project.
40
+project = u'gyan'
41
+copyright = u'2017, OpenStack Developers'
42
+
43
+# openstackdocstheme options
44
+repository_name = 'openstack/gyan'
45
+bug_project = 'gyan'
46
+bug_tag = ''
47
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
48
+
49
+# If true, '()' will be appended to :func: etc. cross-reference text.
50
+add_function_parentheses = True
51
+
52
+# If true, the current module name will be prepended to all description
53
+# unit titles (such as .. function::).
54
+add_module_names = True
55
+
56
+# The name of the Pygments (syntax highlighting) style to use.
57
+pygments_style = 'sphinx'
58
+
59
+# -- Options for HTML output --------------------------------------------------
60
+
61
+# The theme to use for HTML and HTML Help pages.  Major themes that come with
62
+# Sphinx are currently 'default' and 'sphinxdoc'.
63
+# html_theme_path = ["."]
64
+# html_theme = '_theme'
65
+# html_static_path = ['static']
66
+html_theme = 'openstackdocs'
67
+
68
+# Output file base name for HTML help builder.
69
+htmlhelp_basename = '%sdoc' % project
70
+
71
+# Grouping the document tree into LaTeX files. List of tuples
72
+# (source start file, target name, title, author, documentclass
73
+# [howto/manual]).
74
+latex_documents = [
75
+    ('index',
76
+     '%s.tex' % project,
77
+     u'%s Documentation' % project,
78
+     u'OpenStack Developers', 'manual'),
79
+]
80
+
81
+# Example configuration for intersphinx: refer to the Python standard library.
82
+#intersphinx_mapping = {'http://docs.python.org/': None}

+ 5
- 0
doc/source/configuration/index.rst View File

@@ -0,0 +1,5 @@
1
+=============
2
+Configuration
3
+=============
4
+
5
+Configuration of gyan.

+ 4
- 0
doc/source/contributor/contributing.rst View File

@@ -0,0 +1,4 @@
1
+============
2
+Contributing
3
+============
4
+.. include:: ../../../CONTRIBUTING.rst

+ 9
- 0
doc/source/contributor/index.rst View File

@@ -0,0 +1,9 @@
1
+===========================
2
+ Contributor Documentation
3
+===========================
4
+
5
+.. toctree::
6
+   :maxdepth: 2
7
+
8
+   contributing
9
+

+ 30
- 0
doc/source/index.rst View File

@@ -0,0 +1,30 @@
1
+.. gyan documentation master file, created by
2
+   sphinx-quickstart on Tue Jul  9 22:26:36 2013.
3
+   You can adapt this file completely to your liking, but it should at least
4
+   contain the root `toctree` directive.
5
+
6
+====================================
7
+Welcome to the documentation of gyan
8
+====================================
9
+
10
+Contents:
11
+
12
+.. toctree::
13
+   :maxdepth: 2
14
+
15
+   readme
16
+   install/index
17
+   library/index
18
+   contributor/index
19
+   configuration/index
20
+   cli/index
21
+   user/index
22
+   admin/index
23
+   reference/index
24
+
25
+Indices and tables
26
+==================
27
+
28
+* :ref:`genindex`
29
+* :ref:`modindex`
30
+* :ref:`search`

+ 10
- 0
doc/source/install/common_configure.rst View File

@@ -0,0 +1,10 @@
1
+2. Edit the ``/etc/gyan/gyan.conf`` file and complete the following
2
+   actions:
3
+
4
+   * In the ``[database]`` section, configure database access:
5
+
6
+     .. code-block:: ini
7
+
8
+        [database]
9
+        ...
10
+        connection = mysql+pymysql://gyan:GYAN_DBPASS@controller/gyan

+ 75
- 0
doc/source/install/common_prerequisites.rst View File

@@ -0,0 +1,75 @@
1
+Prerequisites
2
+-------------
3
+
4
+Before you install and configure the gyan service,
5
+you must create a database, service credentials, and API endpoints.
6
+
7
+#. To create the database, complete these steps:
8
+
9
+   * Use the database access client to connect to the database
10
+     server as the ``root`` user:
11
+
12
+     .. code-block:: console
13
+
14
+        $ mysql -u root -p
15
+
16
+   * Create the ``gyan`` database:
17
+
18
+     .. code-block:: none
19
+
20
+        CREATE DATABASE gyan;
21
+
22
+   * Grant proper access to the ``gyan`` database:
23
+
24
+     .. code-block:: none
25
+
26
+        GRANT ALL PRIVILEGES ON gyan.* TO 'gyan'@'localhost' \
27
+          IDENTIFIED BY 'GYAN_DBPASS';
28
+        GRANT ALL PRIVILEGES ON gyan.* TO 'gyan'@'%' \
29
+          IDENTIFIED BY 'GYAN_DBPASS';
30
+
31
+     Replace ``GYAN_DBPASS`` with a suitable password.
32
+
33
+   * Exit the database access client.
34
+
35
+     .. code-block:: none
36
+
37
+        exit;
38
+
39
+#. Source the ``admin`` credentials to gain access to
40
+   admin-only CLI commands:
41
+
42
+   .. code-block:: console
43
+
44
+      $ . admin-openrc
45
+
46
+#. To create the service credentials, complete these steps:
47
+
48
+   * Create the ``gyan`` user:
49
+
50
+     .. code-block:: console
51
+
52
+        $ openstack user create --domain default --password-prompt gyan
53
+
54
+   * Add the ``admin`` role to the ``gyan`` user:
55
+
56
+     .. code-block:: console
57
+
58
+        $ openstack role add --project service --user gyan admin
59
+
60
+   * Create the gyan service entities:
61
+
62
+     .. code-block:: console
63
+
64
+        $ openstack service create --name gyan --description "gyan" gyan
65
+
66
+#. Create the gyan service API endpoints:
67
+
68
+   .. code-block:: console
69
+
70
+      $ openstack endpoint create --region RegionOne \
71
+        gyan public http://controller:XXXX/vY/%\(tenant_id\)s
72
+      $ openstack endpoint create --region RegionOne \
73
+        gyan internal http://controller:XXXX/vY/%\(tenant_id\)s
74
+      $ openstack endpoint create --region RegionOne \
75
+        gyan admin http://controller:XXXX/vY/%\(tenant_id\)s

+ 9
- 0
doc/source/install/get_started.rst View File

@@ -0,0 +1,9 @@
1
+=====================
2
+gyan service overview
3
+=====================
4
+The gyan service provides...
5
+
6
+The gyan service consists of the following components:
7
+
8
+``gyan-api`` service
9
+  Accepts and responds to end user compute API calls...

+ 17
- 0
doc/source/install/index.rst View File

@@ -0,0 +1,17 @@
1
+===============================
2
+gyan service installation guide
3
+===============================
4
+
5
+.. toctree::
6
+   :maxdepth: 2
7
+
8
+   get_started.rst
9
+   install.rst
10
+   verify.rst
11
+   next-steps.rst
12
+
13
+The gyan service (gyan) provides...
14
+
15
+This chapter assumes a working setup of OpenStack following the
16
+`OpenStack Installation Tutorial
17
+<https://docs.openstack.org/project-install-guide/ocata/>`_.

+ 34
- 0
doc/source/install/install-obs.rst View File

@@ -0,0 +1,34 @@
1
+.. _install-obs:
2
+
3
+
4
+Install and configure for openSUSE and SUSE Linux Enterprise
5
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6
+
7
+This section describes how to install and configure the gyan service
8
+for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1.
9
+
10
+.. include:: common_prerequisites.rst
11
+
12
+Install and configure components
13
+--------------------------------
14
+
15
+#. Install the packages:
16
+
17
+   .. code-block:: console
18
+
19
+      # zypper --quiet --non-interactive install
20
+
21
+.. include:: common_configure.rst
22
+
23
+
24
+Finalize installation
25
+---------------------
26
+
27
+Start the gyan services and configure them to start when
28
+the system boots:
29
+
30
+.. code-block:: console
31
+
32
+   # systemctl enable openstack-gyan-api.service
33
+
34
+   # systemctl start openstack-gyan-api.service

+ 33
- 0
doc/source/install/install-rdo.rst View File

@@ -0,0 +1,33 @@
1
+.. _install-rdo:
2
+
3
+Install and configure for Red Hat Enterprise Linux and CentOS
4
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
+
6
+
7
+This section describes how to install and configure the gyan service
8
+for Red Hat Enterprise Linux 7 and CentOS 7.
9
+
10
+.. include:: common_prerequisites.rst
11
+
12
+Install and configure components
13
+--------------------------------
14
+
15
+#. Install the packages:
16
+
17
+   .. code-block:: console
18
+
19
+      # yum install
20
+
21
+.. include:: common_configure.rst
22
+
23
+Finalize installation
24
+---------------------
25
+
26
+Start the gyan services and configure them to start when
27
+the system boots:
28
+
29
+.. code-block:: console
30
+
31
+   # systemctl enable openstack-gyan-api.service
32
+
33
+   # systemctl start openstack-gyan-api.service

+ 31
- 0
doc/source/install/install-ubuntu.rst View File

@@ -0,0 +1,31 @@
1
+.. _install-ubuntu:
2
+
3
+Install and configure for Ubuntu
4
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5
+
6
+This section describes how to install and configure the gyan
7
+service for Ubuntu 14.04 (LTS).
8
+
9
+.. include:: common_prerequisites.rst
10
+
11
+Install and configure components
12
+--------------------------------
13
+
14
+#. Install the packages:
15
+
16
+   .. code-block:: console
17
+
18
+      # apt-get update
19
+
20
+      # apt-get install
21
+
22
+.. include:: common_configure.rst
23
+
24
+Finalize installation
25
+---------------------
26
+
27
+Restart the gyan services:
28
+
29
+.. code-block:: console
30
+
31
+   # service openstack-gyan-api restart

+ 20
- 0
doc/source/install/install.rst View File

@@ -0,0 +1,20 @@
1
+.. _install:
2
+
3
+Install and configure
4
+~~~~~~~~~~~~~~~~~~~~~
5
+
6
+This section describes how to install and configure the
7
+gyan service, code-named gyan, on the controller node.
8
+
9
+This section assumes that you already have a working OpenStack
10
+environment with at least the following components installed:
11
+.. (add the appropriate services here and further notes)
12
+
13
+Note that installation and configuration vary by distribution.
14
+
15
+.. toctree::
16
+   :maxdepth: 2
17
+
18
+   install-obs.rst
19
+   install-rdo.rst
20
+   install-ubuntu.rst

+ 9
- 0
doc/source/install/next-steps.rst View File

@@ -0,0 +1,9 @@
1
+.. _next-steps:
2
+
3
+Next steps
4
+~~~~~~~~~~
5
+
6
+Your OpenStack environment now includes the gyan service.
7
+
8
+To add additional services, see
9
+https://docs.openstack.org/project-install-guide/ocata/.

+ 24
- 0
doc/source/install/verify.rst View File

@@ -0,0 +1,24 @@
1
+.. _verify:
2
+
3
+Verify operation
4
+~~~~~~~~~~~~~~~~
5
+
6
+Verify operation of the gyan service.
7
+
8
+.. note::
9
+
10
+   Perform these commands on the controller node.
11
+
12
+#. Source the ``admin`` project credentials to gain access to
13
+   admin-only CLI commands:
14
+
15
+   .. code-block:: console
16
+
17
+      $ . admin-openrc
18
+
19
+#. List service components to verify successful launch and registration
20
+   of each process:
21
+
22
+   .. code-block:: console
23
+
24
+      $ openstack gyan service list

+ 7
- 0
doc/source/library/index.rst View File

@@ -0,0 +1,7 @@
1
+========
2
+Usage
3
+========
4
+
5
+To use gyan in a project::
6
+
7
+    import gyan

+ 1
- 0
doc/source/readme.rst View File

@@ -0,0 +1 @@
1
+.. include:: ../../README.rst

+ 5
- 0
doc/source/reference/index.rst View File

@@ -0,0 +1,5 @@
1
+==========
2
+References
3
+==========
4
+
5
+References of gyan.

+ 5
- 0
doc/source/user/index.rst View File

@@ -0,0 +1,5 @@
1
+===========
2
+Users guide
3
+===========
4
+
5
+Users guide of gyan.

+ 19
- 0
gyan/__init__.py View File

@@ -0,0 +1,19 @@
1
+# -*- coding: utf-8 -*-
2
+
3
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
4
+# not use this file except in compliance with the License. You may obtain
5
+# a copy of the License at
6
+#
7
+#      http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12
+# License for the specific language governing permissions and limitations
13
+# under the License.
14
+
15
+import pbr.version
16
+
17
+
18
+__version__ = pbr.version.VersionInfo(
19
+    'gyan').version_string()

+ 0
- 0
gyan/tests/__init__.py View File


+ 23
- 0
gyan/tests/base.py View File

@@ -0,0 +1,23 @@
1
+# -*- coding: utf-8 -*-
2
+
3
+# Copyright 2010-2011 OpenStack Foundation
4
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
5
+#
6
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
7
+# not use this file except in compliance with the License. You may obtain
8
+# a copy of the License at
9
+#
10
+#      http://www.apache.org/licenses/LICENSE-2.0
11
+#
12
+# Unless required by applicable law or agreed to in writing, software
13
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
14
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
15
+# License for the specific language governing permissions and limitations
16
+# under the License.
17
+
18
+from oslotest import base
19
+
20
+
21
+class TestCase(base.BaseTestCase):
22
+
23
+    """Test case base class for all unit tests."""

+ 28
- 0
gyan/tests/test_gyan.py View File

@@ -0,0 +1,28 @@
1
+# -*- coding: utf-8 -*-
2
+
3
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
4
+# not use this file except in compliance with the License. You may obtain
5
+# a copy of the License at
6
+#
7
+#      http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
11
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
12
+# License for the specific language governing permissions and limitations
13
+# under the License.
14
+
15
+"""
16
+test_gyan
17
+----------------------------------
18
+
19
+Tests for `gyan` module.
20
+"""
21
+
22
+from gyan.tests import base
23
+
24
+
25
+class TestGyan(base.TestCase):
26
+
27
+    def test_something(self):
28
+        pass

+ 0
- 0
releasenotes/notes/.placeholder View File


+ 0
- 0
releasenotes/source/_static/.placeholder View File


+ 0
- 0
releasenotes/source/_templates/.placeholder View File


+ 281
- 0
releasenotes/source/conf.py View File

@@ -0,0 +1,281 @@
1
+# -*- coding: utf-8 -*-
2
+# Licensed under the Apache License, Version 2.0 (the "License");
3
+# you may not use this file except in compliance with the License.
4
+# You may obtain a copy of the License at
5
+#
6
+#    http://www.apache.org/licenses/LICENSE-2.0
7
+#
8
+# Unless required by applicable law or agreed to in writing, software
9
+# distributed under the License is distributed on an "AS IS" BASIS,
10
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
11
+# implied.
12
+# See the License for the specific language governing permissions and
13
+# limitations under the License.
14
+
15
+# This file is execfile()d with the current directory set to its
16
+# containing dir.
17
+#
18
+# Note that not all possible configuration values are present in this
19
+# autogenerated file.
20
+#
21
+# All configuration values have a default; values that are commented out
22
+# serve to show the default.
23
+
24
+# If extensions (or modules to document with autodoc) are in another directory,
25
+# add these directories to sys.path here. If the directory is relative to the
26
+# documentation root, use os.path.abspath to make it absolute, like shown here.
27
+# sys.path.insert(0, os.path.abspath('.'))
28
+
29
+# -- General configuration ------------------------------------------------
30
+
31
+# If your documentation needs a minimal Sphinx version, state it here.
32
+# needs_sphinx = '1.0'
33
+
34
+# Add any Sphinx extension module names here, as strings. They can be
35
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
36
+# ones.
37
+extensions = [
38
+    'openstackdocstheme',
39
+    'reno.sphinxext',
40
+]
41
+
42
+# Add any paths that contain templates here, relative to this directory.
43
+templates_path = ['_templates']
44
+
45
+# The suffix of source filenames.
46
+source_suffix = '.rst'
47
+
48
+# The encoding of source files.
49
+# source_encoding = 'utf-8-sig'
50
+
51
+# The master toctree document.
52
+master_doc = 'index'
53
+
54
+# General information about the project.
55
+project = u'gyan Release Notes'
56
+copyright = u'2017, OpenStack Developers'
57
+
58
+# openstackdocstheme options
59
+repository_name = 'openstack/gyan'
60
+bug_project = 'gyan'
61
+bug_tag = ''
62
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
63
+
64
+# The version info for the project you're documenting, acts as replacement for
65
+# |version| and |release|, also used in various other places throughout the
66
+# built documents.
67
+#
68
+# The short X.Y version.
69
+# The full version, including alpha/beta/rc tags.
70
+release = ''
71
+# The short X.Y version.
72
+version = ''
73
+
74
+# The language for content autogenerated by Sphinx. Refer to documentation
75
+# for a list of supported languages.
76
+# language = None
77
+
78
+# There are two options for replacing |today|: either, you set today to some
79
+# non-false value, then it is used:
80
+# today = ''
81
+# Else, today_fmt is used as the format for a strftime call.
82
+# today_fmt = '%B %d, %Y'
83
+
84
+# List of patterns, relative to source directory, that match files and
85
+# directories to ignore when looking for source files.
86
+exclude_patterns = []
87
+
88
+# The reST default role (used for this markup: `text`) to use for all
89
+# documents.
90
+# default_role = None
91
+
92
+# If true, '()' will be appended to :func: etc. cross-reference text.
93
+# add_function_parentheses = True
94
+
95
+# If true, the current module name will be prepended to all description
96
+# unit titles (such as .. function::).
97
+# add_module_names = True
98
+
99
+# If true, sectionauthor and moduleauthor directives will be shown in the
100
+# output. They are ignored by default.
101
+# show_authors = False
102
+
103
+# The name of the Pygments (syntax highlighting) style to use.
104
+pygments_style = 'sphinx'
105
+
106
+# A list of ignored prefixes for module index sorting.
107
+# modindex_common_prefix = []
108
+
109
+# If true, keep warnings as "system message" paragraphs in the built documents.
110
+# keep_warnings = False
111
+
112
+
113
+# -- Options for HTML output ----------------------------------------------
114
+
115
+# The theme to use for HTML and HTML Help pages.  See the documentation for
116
+# a list of builtin themes.
117
+html_theme = 'openstackdocs'
118
+
119
+# Theme options are theme-specific and customize the look and feel of a theme
120
+# further.  For a list of options available for each theme, see the
121
+# documentation.
122
+# html_theme_options = {}
123
+
124
+# Add any paths that contain custom themes here, relative to this directory.
125
+# html_theme_path = []
126
+
127
+# The name for this set of Sphinx documents.  If None, it defaults to
128
+# "<project> v<release> documentation".
129
+# html_title = None
130
+
131
+# A shorter title for the navigation bar.  Default is the same as html_title.
132
+# html_short_title = None
133
+
134
+# The name of an image file (relative to this directory) to place at the top
135
+# of the sidebar.
136
+# html_logo = None
137
+
138
+# The name of an image file (within the static path) to use as favicon of the
139
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
140
+# pixels large.
141
+# html_favicon = None
142
+
143
+# Add any paths that contain custom static files (such as style sheets) here,
144
+# relative to this directory. They are copied after the builtin static files,
145
+# so a file named "default.css" will overwrite the builtin "default.css".
146
+html_static_path = ['_static']
147
+
148
+# Add any extra paths that contain custom files (such as robots.txt or
149
+# .htaccess) here, relative to this directory. These files are copied
150
+# directly to the root of the documentation.
151
+# html_extra_path = []
152
+
153
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
154
+# using the given strftime format.
155
+# html_last_updated_fmt = '%b %d, %Y'
156
+
157
+# If true, SmartyPants will be used to convert quotes and dashes to
158
+# typographically correct entities.
159
+# html_use_smartypants = True
160
+
161
+# Custom sidebar templates, maps document names to template names.
162
+# html_sidebars = {}
163
+
164
+# Additional templates that should be rendered to pages, maps page names to
165
+# template names.
166
+# html_additional_pages = {}
167
+
168
+# If false, no module index is generated.
169
+# html_domain_indices = True
170
+
171
+# If false, no index is generated.
172
+# html_use_index = True
173
+
174
+# If true, the index is split into individual pages for each letter.
175
+# html_split_index = False
176
+
177
+# If true, links to the reST sources are added to the pages.
178
+# html_show_sourcelink = True
179
+
180
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
181
+# html_show_sphinx = True
182
+
183
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
184
+# html_show_copyright = True
185
+
186
+# If true, an OpenSearch description file will be output, and all pages will
187
+# contain a <link> tag referring to it.  The value of this option must be the
188
+# base URL from which the finished HTML is served.
189
+# html_use_opensearch = ''
190
+
191
+# This is the file name suffix for HTML files (e.g. ".xhtml").
192
+# html_file_suffix = None
193
+
194
+# Output file base name for HTML help builder.
195
+htmlhelp_basename = 'gyanReleaseNotesdoc'
196
+
197
+
198
+# -- Options for LaTeX output ---------------------------------------------
199
+
200
+latex_elements = {
201
+    # The paper size ('letterpaper' or 'a4paper').
202
+    # 'papersize': 'letterpaper',
203
+
204
+    # The font size ('10pt', '11pt' or '12pt').
205
+    # 'pointsize': '10pt',
206
+
207
+    # Additional stuff for the LaTeX preamble.
208
+    # 'preamble': '',
209
+}
210
+
211
+# Grouping the document tree into LaTeX files. List of tuples
212
+# (source start file, target name, title,
213
+#  author, documentclass [howto, manual, or own class]).
214
+latex_documents = [
215
+    ('index', 'gyanReleaseNotes.tex',
216
+     u'gyan  Release Notes Documentation',
217
+     u'OpenStack Foundation', 'manual'),
218
+]
219
+
220
+# The name of an image file (relative to this directory) to place at the top of
221
+# the title page.
222
+# latex_logo = None
223
+
224
+# For "manual" documents, if this is true, then toplevel headings are parts,
225
+# not chapters.
226
+# latex_use_parts = False
227
+
228
+# If true, show page references after internal links.
229
+# latex_show_pagerefs = False
230
+
231
+# If true, show URL addresses after external links.
232
+# latex_show_urls = False
233
+
234
+# Documents to append as an appendix to all manuals.
235
+# latex_appendices = []
236
+
237
+# If false, no module index is generated.
238
+# latex_domain_indices = True
239
+
240
+
241
+# -- Options for manual page output ---------------------------------------
242
+
243
+# One entry per manual page. List of tuples
244
+# (source start file, name, description, authors, manual section).
245
+man_pages = [
246
+    ('index', 'gyanrereleasenotes',
247
+     u'gyan  Release Notes Documentation',
248
+     [u'OpenStack Foundation'], 1)
249
+]
250
+
251
+# If true, show URL addresses after external links.
252
+# man_show_urls = False
253
+
254
+
255
+# -- Options for Texinfo output -------------------------------------------
256
+
257
+# Grouping the document tree into Texinfo files. List of tuples
258
+# (source start file, target name, title, author,
259
+#  dir menu entry, description, category)
260
+texinfo_documents = [
261
+    ('index', 'gyan ReleaseNotes',
262
+     u'gyan Release Notes Documentation',
263
+     u'OpenStack Foundation', 'gyanReleaseNotes',
264
+     'One line description of project.',
265
+     'Miscellaneous'),
266
+]
267
+
268
+# Documents to append as an appendix to all manuals.
269
+# texinfo_appendices = []
270
+
271
+# If false, no module index is generated.
272
+# texinfo_domain_indices = True
273
+
274
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
275
+# texinfo_show_urls = 'footnote'
276
+
277
+# If true, do not generate a @detailmenu in the "Top" node's menu.
278
+# texinfo_no_detailmenu = False
279
+
280
+# -- Options for Internationalization output ------------------------------
281
+locale_dirs = ['locale/']

+ 8
- 0
releasenotes/source/index.rst View File

@@ -0,0 +1,8 @@
1
+============================================
2
+ gyan Release Notes
3
+============================================
4
+
5
+.. toctree::
6
+   :maxdepth: 1
7
+
8
+   unreleased

+ 5
- 0
releasenotes/source/unreleased.rst View File

@@ -0,0 +1,5 @@
1
+==============================
2
+ Current Series Release Notes
3
+==============================
4
+
5
+.. release-notes::

+ 5
- 0
requirements.txt View File

@@ -0,0 +1,5 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+
5
+pbr>=2.0 # Apache-2.0

+ 37
- 0
setup.cfg View File

@@ -0,0 +1,37 @@
1
+[metadata]
2
+name = gyan
3
+summary = Machine Learning Infra as a service
4
+description-file =
5
+    README.rst
6
+author = OpenStack
7
+author-email = openstack-dev@lists.openstack.org
8
+home-page = http://www.openstack.org/
9
+classifier =
10
+    Environment :: OpenStack
11
+    Intended Audience :: Information Technology
12
+    Intended Audience :: System Administrators
13
+    License :: OSI Approved :: Apache Software License
14
+    Operating System :: POSIX :: Linux
15
+    Programming Language :: Python
16
+    Programming Language :: Python :: 2
17
+    Programming Language :: Python :: 2.7
18
+    Programming Language :: Python :: 3
19
+    Programming Language :: Python :: 3.5
20
+
21
+[files]
22
+packages =
23
+    gyan
24
+
25
+[compile_catalog]
26
+directory = gyan/locale
27
+domain = gyan
28
+
29
+[update_catalog]
30
+domain = gyan
31
+output_dir = gyan/locale
32
+input_file = gyan/locale/gyan.pot
33
+
34
+[extract_messages]
35
+keywords = _ gettext ngettext l_ lazy_gettext
36
+mapping_file = babel.cfg
37
+output_file = gyan/locale/gyan.pot

+ 29
- 0
setup.py View File

@@ -0,0 +1,29 @@
1
+# Copyright (c) 2013 Hewlett-Packard Development Company, L.P.
2
+#
3
+# Licensed under the Apache License, Version 2.0 (the "License");
4
+# you may not use this file except in compliance with the License.
5
+# You may obtain a copy of the License at
6
+#
7
+#    http://www.apache.org/licenses/LICENSE-2.0
8
+#
9
+# Unless required by applicable law or agreed to in writing, software
10
+# distributed under the License is distributed on an "AS IS" BASIS,
11
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
12
+# implied.
13
+# See the License for the specific language governing permissions and
14
+# limitations under the License.
15
+
16
+# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT
17
+import setuptools
18
+
19
+# In python < 2.7.4, a lazy loading of package `pbr` will break
20
+# setuptools if some other modules registered functions in `atexit`.
21
+# solution from: http://bugs.python.org/issue15881#msg170215
22
+try:
23
+    import multiprocessing  # noqa
24
+except ImportError:
25
+    pass
26
+
27
+setuptools.setup(
28
+    setup_requires=['pbr'],
29
+    pbr=True)

+ 11
- 0
test-requirements.txt View File

@@ -0,0 +1,11 @@
1
+# The order of packages is significant, because pip processes them in the order
2
+# of appearance. Changing the order has an impact on the overall integration
3
+# process, which may cause wedges in the gate later.
4
+
5
+hacking>=0.12.0,<0.13 # Apache-2.0
6
+
7
+coverage>=4.0,!=4.4 # Apache-2.0
8
+python-subunit>=0.0.18 # Apache-2.0/BSD
9
+oslotest>=1.10.0 # Apache-2.0
10
+stestr>=1.0.0 # Apache-2.0
11
+testtools>=1.4.0 # MIT

+ 52
- 0
tox.ini View File

@@ -0,0 +1,52 @@
1
+[tox]
2
+minversion = 2.0
3
+envlist = py35,py27,pep8
4
+skipsdist = True
5
+
6
+[testenv]
7
+usedevelop = True
8
+install_command = pip install -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt} {opts} {packages}
9
+setenv =
10
+   VIRTUAL_ENV={envdir}
11
+   PYTHONWARNINGS=default::DeprecationWarning
12
+   OS_STDOUT_CAPTURE=1
13
+   OS_STDERR_CAPTURE=1
14
+   OS_TEST_TIMEOUT=60
15
+deps = -r{toxinidir}/test-requirements.txt
16
+commands = stestr run {posargs}
17
+
18
+[testenv:pep8]
19
+commands = flake8 {posargs}
20
+
21
+[testenv:venv]
22
+commands = {posargs}
23
+
24
+[testenv:cover]
25
+setenv =
26
+    VIRTUAL_ENV={envdir}
27
+    PYTHON=coverage run --source gyan --parallel-mode
28
+commands =
29
+    stestr run {posargs}
30
+    coverage combine
31
+    coverage html -d cover
32
+    coverage xml -o cover/coverage.xml
33
+
34
+[testenv:docs]
35
+deps = -r{toxinidir}/doc/requirements.txt
36
+commands = sphinx-build -W -b html doc/source doc/build/html
37
+
38
+[testenv:releasenotes]
39
+deps = {[testenv:docs]deps}
40
+commands =
41
+  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html
42
+
43
+[testenv:debug]
44
+commands = oslo_debug_helper {posargs}
45
+
46
+[flake8]
47
+# E123, E125 skipped as they are invalid PEP-8.
48
+
49
+show-source = True
50
+ignore = E123,E125
51
+builtins = _
52
+exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build

Loading…
Cancel
Save