Browse Source

Add initial content for plugin

This files are required for successful plugin
building with Fuel Plugin Builder

Change-Id: I1acf3b13a18de4f56718be110edf6eae48cb1639
Alexander Kurenyshev 3 years ago
parent
commit
1c4e131924

+ 202
- 0
LICENSE View File

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

+ 9
- 0
README.md View File

@@ -0,0 +1,9 @@
1
+fuel-debug-plugin
2
+============
3
+
4
+Plugin enables additional debug output for MOS services.
5
+This plugin could be useful when we try to get know
6
+what's wrong with some service, try to get requests/responces
7
+for example.
8
+After plugin installation there should be more info at the 
9
+logs of the services mentioned at environment_config.yaml.

+ 39
- 0
deployment_scripts/debug_plugin.rb View File

@@ -0,0 +1,39 @@
1
+#!/usr/bin/env ruby
2
+require 'rubygems'
3
+require 'hiera'
4
+require 'fileutils'
5
+
6
+HIERA_CONFIG  = '/etc/puppet/hiera.yaml'
7
+OVERRIDE_FILE = '/etc/hiera/override/plugins.yaml'
8
+OVERRIDE_FOLDER = '/etc/hiera/override'
9
+
10
+def hiera
11
+  return $hiera if $hiera
12
+  $hiera = Hiera.new(:config => HIERA_CONFIG)
13
+  Hiera.logger = "noop"
14
+  $hiera
15
+end
16
+
17
+def debug_plugin
18
+  plugin_data = hiera.lookup 'debug_plugin', [], {}, nil, :hash
19
+  raise 'Invalid plugin data!' unless plugin_data.is_a? Hash
20
+  plugin_data
21
+end
22
+
23
+def yaml_additional_config
24
+  debug_plugin.fetch 'yaml_additional_config', ''
25
+end
26
+
27
+def ensure_override_directory
28
+  FileUtils.mkdir_p OVERRIDE_FOLDER unless File.directory? OVERRIDE_FOLDER
29
+end
30
+
31
+def write_override_file(data)
32
+  File.open(OVERRIDE_FILE, 'w') do |f|
33
+    f.puts data
34
+  end
35
+end
36
+
37
+ensure_override_directory
38
+write_override_file yaml_additional_config
39
+

+ 8
- 0
deployment_scripts/run_override.pp View File

@@ -0,0 +1,8 @@
1
+notice('MODULAR: run_override.pp')
2
+
3
+file { '/etc/fuel/plugins/debug_plugin-1.0/debug_plugin.rb':
4
+ ensure  => 'file',
5
+ }
6
+exec { "/usr/bin/ruby /etc/fuel/plugins/debug_plugin-1.0/debug_plugin.rb":
7
+ require => File['/etc/fuel/plugins/debug_plugin-1.0/debug_plugin.rb'],
8
+ }

+ 9
- 0
deployment_tasks.yaml View File

@@ -0,0 +1,9 @@
1
+ - id: debug_plugin-pre-deployment-override
2
+   type: puppet
3
+   groups: [primary-controller, controller, compute, cinder]
4
+   required_for: [globals]
5
+   requires: [hiera]
6
+   parameters:
7
+     puppet_manifest: run_override.pp
8
+     puppet_modules: "."
9
+     timeout: 1800

+ 57
- 0
environment_config.yaml View File

@@ -0,0 +1,57 @@
1
+attributes:
2
+  yaml_additional_config:
3
+    type: "textarea"     
4
+    validate: "yaml"   
5
+    weight: 30
6
+    value: |  
7
+      vcenter_hash:
8
+        debug: true
9
+        verbose: true
10
+      swift_hash:
11
+        debug: true
12
+        verbose: true
13
+      sahara_hash:
14
+        debug: true
15
+        verbose: true
16
+      mongo:
17
+        debug: true
18
+        verbose: true
19
+      compute:
20
+        debug: true
21
+        verbose: true
22
+      rabbit_hash:
23
+        debug: true
24
+        verbose: true
25
+      openstack_network:
26
+        debug: true
27
+        verbose: true
28
+      openstack_controller:
29
+        debug: true
30
+        verbose: true
31
+      cinder_hash:
32
+        debug: true
33
+        verbose: true
34
+      murano_hash:
35
+        debug: true
36
+        verbose: true
37
+      syslog_hash:
38
+        debug: true
39
+        verbose: true
40
+      keystone:
41
+        debug: true
42
+        verbose: true
43
+      horizon:
44
+        debug: true
45
+        verbose: true
46
+      heat:
47
+        debug: true
48
+        verbose: true
49
+      glance:
50
+        debug: true
51
+        verbose: true
52
+      haproxy:
53
+        debug: true
54
+        verbose: true
55
+    label: "Additional config"
56
+    description: "Put here a valid yaml describes services to debug"
57
+

+ 35
- 0
metadata.yaml View File

@@ -0,0 +1,35 @@
1
+# Plugin name
2
+name: debug_plugin
3
+# Human-readable name for your plugin
4
+title: Debug plugin options
5
+# Plugin version
6
+version: '1.0.0'
7
+# Description
8
+description: Enables additional output to the MOS services 
9
+# Required fuel version
10
+fuel_version: ['7.0', '8.0']
11
+# Specify license of your plugin
12
+licenses: ['Apache License Version 2.0']
13
+# Specify author or company name
14
+authors: ['akurenyshev@mirantis.com']
15
+# A link to the plugin's page
16
+homepage: 'https://github.com/akurenyshevmirantis/fuel-debug-plugin'
17
+# Specify a group which your plugin implements, possible options:
18
+# network, storage, storage::cinder, storage::glance, hypervisor
19
+groups: []
20
+
21
+# The plugin is compatible with releases in the list
22
+releases:
23
+  - os: ubuntu
24
+    version: 2015.1.0-7.0
25
+    mode: ['ha']
26
+    deployment_scripts_path: deployment_scripts/
27
+    repository_path: repositories/ubuntu
28
+  - os: ubuntu
29
+    version: 2015.1.0-8.0
30
+    mode: ['ha']
31
+    deployment_scripts_path: deployment_scripts/
32
+    repository_path: repositories/ubuntu
33
+
34
+# Version of plugin package
35
+package_version: '3.0.0'

+ 5
- 0
pre_build_hook View File

@@ -0,0 +1,5 @@
1
+#!/bin/bash
2
+
3
+# Add here any the actions which are required before plugin build
4
+# like packages building, packages downloading from mirrors and so on.
5
+# The script should return 0 if there were no errors.

+ 0
- 0
repositories/centos/.gitkeep View File


+ 0
- 0
repositories/ubuntu/.gitkeep View File


+ 7
- 0
volumes.yaml View File

@@ -0,0 +1,7 @@
1
+volumes_roles_mapping:
2
+  # Default role mapping
3
+  debug_plugin:
4
+    - {allocate_size: "min", id: "os"}
5
+
6
+# Set here new volumes for your role
7
+volumes: []

Loading…
Cancel
Save