Skip to main content

Fortanix SDKMS Plugin Registry Builder

Project description

SDKMS Plugin Registry Builder

This tool builds a SDKMS plugin registry manifest file out of a git repository. It iterates through each commit and signs it. At each step of the iteration the tool keeps building the manifest which is a JSON structure with the following schema:

[
    {
        "name": "<Plugin Name>",
        "versions": {
            "<version>": {
                "path": <path/to/plugin/file>,
                "description": <plugin description>,
                "short_description": <short description used by SDKMS for display in tiles>,
                "release_notes": [
                    <str>,
                    ...
                ],
                "commit": <hexsha>
            },
            ...
        }
    },
    ...
]

Fortanix Plugin Registry

SDKMS Plugin Registries are GIT repositories that contains SDKMS plugins (custom Lua programs) that can be executed inside SDKMS to achieve certain business specific logic, or a functionality that is not part of the core capabilities offered by SDKMS. The repository should follow the following conventions:

  1. Each plugin should have a unique name.
  2. There should be just one plugin in each subdirectory.
  3. In each subdirectory the following files are required (case-sensitive):
    • plugin.lua: Contains the plugin code.
    • README.md: Contains a description of the plugin.
    • metadata.json: Contains metadata of the plugin. The schema of the JSON should be:
{
    "name": <Plugin name>,
    "version": <Plugin version>,
    "short_description": <Short description of what the plugin does. This text will be displayed in the plugin tile in the UI>,
    "release_notes": [
        <Array of release notes>
    ]
}

NOTE: older plugins have a single plugin.lua file with metadata stored in the first few lines of the file as comments. If a plugin follows that convention correctly then the README.md and metadata.json files are ignored and not required. In such cases the plugin metadata is extracted from the lua file. Here is an example of this convention:

-- Name: Test Plugin
-- Version: 1.0
-- Description: Hello, world!
--
-- This is a test.
-- End of description.

function run(input)
   return "Hello, world!"
end

Instructions

Before running this tool it is necessary that the git repository to be built is setup with the configuration so that its commits can be signed. Once the repository is setup run:

sdkms-plugin-registry-builder --repo-dir <Path/to/git/repository>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sdkms-plugin-registry-builder-1.2.1.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

sdkms_plugin_registry_builder-1.2.1-py2.py3-none-any.whl (6.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sdkms-plugin-registry-builder-1.2.1.tar.gz.

File metadata

  • Download URL: sdkms-plugin-registry-builder-1.2.1.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.8.2 requests/2.27.1 setuptools/38.6.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.10

File hashes

Hashes for sdkms-plugin-registry-builder-1.2.1.tar.gz
Algorithm Hash digest
SHA256 66c3b20e30e880a8b610a6ae6b6ff91a8b9606f85c92f42ebf00ab26de769f5f
MD5 ff7ce198b40039a6d13cce20384374fa
BLAKE2b-256 f52a637cd0bb83cd0b1aa5d2abe42ffd3caa3963c00e48fe48f96f550048666c

See more details on using hashes here.

File details

Details for the file sdkms_plugin_registry_builder-1.2.1-py2.py3-none-any.whl.

File metadata

  • Download URL: sdkms_plugin_registry_builder-1.2.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.8.2 requests/2.27.1 setuptools/38.6.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.10

File hashes

Hashes for sdkms_plugin_registry_builder-1.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f37e934ecdb71d4308cfe0e80b2afa3f2c085e98769d83a0cd4e41a854653df6
MD5 42c0a06dfcaaa28bf68e31424f0e6964
BLAKE2b-256 547594665de7912b6942be974dafaf87b71fad7ed2615cc92da0be96a22c31c0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page