OSM CLI to automatically create the proxy charm base template
Proposers
- Pedro Escaleira (IT)
Type
Feature
Target MDG/TF
osmclient
Description
The documentation for day-1 operations gives indications on how to create the necessary proxy charms to be executed in this kind of operations. The steps involve the cloning of some repositories, the creation of some yaml config files and of the Python charm itself. This is a task which has to be done multiple times if we want to create multiple charms, and always involves the same sequential steps for setting up these requirements.
Therefore, my idea is to include this set of steps into a command of the OSM CLI, in order to automatically and quickly set up the base charm, so that the programmer will only have to focus on creating the logic, not the base structure of the charm, which as said, is usually the same.
Demo or definition of done
The execution of the following commands using the OSM client to create the base charm:
-
osm charm-create CHARM_NAME
: Creates a charm, whose name will be passed by argument. This command will clone the necessary Git dependencies; -
osm charm-create CHARM_NAME --submodule
: Same functionality as the previous command, but instead of cloning the necessary dependencies, it will add them as Git submodules of the base Git repository (for charms which are included in some developer's repository)
Other flags could also be passed to the command, specially the ones to pass the maintainers name and email, the charm's description and its summary.