Fixes #10255: Document plugin package format #292
Conversation
8_reference/74_package_format.txt
Outdated
|
|
||
| Rudder has a specific package format for plugins. | ||
|
|
||
| You can manage Rudder packages with the rudder-pkg command. This is the documentation of how theyr are created. |
|
|
||
| The metadata file is a JSON file and is named 'metadata': | ||
| ``` | ||
| { |
There was a problem hiding this comment.
You should clearly state which fields are optional.
8_reference/74_package_format.txt
Outdated
| # this is purely informative | ||
| "build-date": "2017-01-20", | ||
| # the list of jar files to enable if this is a webapp plugin | ||
| "jarfiles": [ "test.jar" ], |
There was a problem hiding this comment.
jar-files to stay consistent with build-date
8_reference/74_package_format.txt
Outdated
| # the list of packages or other plugins that this package depends on | ||
| # this is currently only informative | ||
| "depends": { | ||
| # dependencies on dpkg based systemd |
There was a problem hiding this comment.
(or a new systemd component I'm no aware of? ;))
8_reference/74_package_format.txt
Outdated
| "rudder": [ "new-plugin" ] | ||
| }, | ||
| # the plugin content | ||
| "content": { |
There was a problem hiding this comment.
The script uses metadata['files']
There was a problem hiding this comment.
files is not in the medata, it is only used by the package manager internaly
|
Commit modified |
peckpeck
force-pushed
the
ust_10255/document_plugin_package_format
branch
from
a21fb27
to
6b99adb
Compare
| "sles-11": [ ], | ||
| # rudder dependency, ie this is a Rudder format package | ||
| "rudder": [ "new-plugin" ] | ||
| }, |
There was a problem hiding this comment.
The cript uses metadata['files'] which does not seem defined here.
There was a problem hiding this comment.
files is not in the medata, it is only used by the package manager internaly
There was a problem hiding this comment.
This means removing the example plugin will lead to delete /opt/rudder/share and /var/rudder?
There was a problem hiding this comment.
No only empty directories installed by the plugin are removed
8_reference/74_package_format.txt
Outdated
| { | ||
| # the only currently supported type in "plugin" (mandatory) | ||
| "type": "plugin", | ||
| # the plugin name must consist of ascii characters without whitespace (mandatory) |
There was a problem hiding this comment.
package name if we want to be generic
8_reference/74_package_format.txt
Outdated
| # the plugin version has the form "rudder_major-version_major.version_minor" (mandatory) | ||
| "version": "4.1-1.0", | ||
| # this is purely informative (optional) | ||
| "build-date": "2017-01-20", |
|
Commit modified |
peckpeck
force-pushed
the
ust_10255/document_plugin_package_format
branch
from
6b99adb
to
1a58247
Compare
|
|
||
| Note that ar r inserts or replaces files so you can create your package with incremental inserts. | ||
|
|
||
| To extract files, 'use ar x' instead. |
There was a problem hiding this comment.
Could you add an empty line here? (needed for asciidoc inclusion..)
|
Commit modified |
peckpeck
force-pushed
the
ust_10255/document_plugin_package_format
branch
from
1a58247
to
9f2f8f9
Compare
|
OK, merging this PR |
https://www.rudder-project.org/redmine/issues/10255