cisagov / cisagov/Malcolm

plugin architecture: define file/directory format

Open
#369 0 comments 0 reactions 0 assignees View on GitHub
enhancement plugins
Dominant language
Python
Stars
2.5k
Forks
445
Avg merge
15d 21h
Merged PRs (30d)
22

Description

**[ @mmguero](https://github.com/mmguero)** cloned issue [idaholab/Malcolm#578](https://github.com/idaholab/Malcolm/issues/578) on 2024-10-01:

> This is a sub-issue of **Malcolm "plugin architecture"** #399
>
>
>
> For the plugin types where it's applicable, we need to define some sort of a file/directory format. Ideas might include:
>
>
>
> * a single directory where you can drop all of the plugins
>
> * bind-mounted into the relevant (or all?) docker containers
>
> * a compressed file format (zip, 7z, gz, xz, whatever) containing the contents of the plugin
>
> * a `config.yml` file or something like it defining the type of plugin and any other information it might need
>
> * some sort of shared script or something added to the entrypoint chain of the docker images to extract the `config.yml` file from the compressed plugin file and decide if it's something this container needs to do
>
>

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the parent plugin architecture issue #399 and review how Docker containers and images currently receive shared files or entrypoint logic. Compare the proposed directory, compressed archive, and config.yml approaches; done means the plugin format, plugin type metadata, and container loading behavior are explicitly defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
infrastructure, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.