GitLocker: The Coding Marketplace

Description:

idemsources 2.0.0

Generic sls-source plugins for idem

About
This project provides generic sls-sources for idem.
sls-sources can be used to collect params data or state definitions.

What is POP?
This project is built with pop, a Python-based
implementation of Plugin Oriented Programming (POP). POP seeks to bring
together concepts and wisdom from the history of computing in new ways to solve
modern computing problems.
For more information:

Intro to Plugin Oriented Programming (POP)
pop-awesome
pop-create

Getting Started

Prerequisites

Python 3.8+
git (if installing from source, or contributing to the project)

Installation

Note
If wanting to contribute to the project, and setup your local development
environment, see the CONTRIBUTING.rst document in the source repository
for this project.

If wanting to use idem-sources, you can do so by either
installing from PyPI or from source.

Install from PyPI
pip install idem-sources

Install from source
# clone repo
git clone git@gitlab.com/vmware/idem/idem-sources.git
cd idem-sources

# Setup venv
python3 -m venv .venv
source .venv/bin/activate
pip install -e .

Usage
SLS sources are directory trees, archives, and remote stores that contain sls files.
SLS and param sources can come from many different places.
The plugins that can be used to process SLS sources are in idem/idem/sls.
The format for an sls sources is:
<protocol>://<resource>
The format for authenticated sls sources is:
<protocol_plugin>://<acct_profile>@<resource>
The named acct profile associated with the protocol_plugin provider will have it’s values passed to ctx.acct of the appropriate “cache” function.
File sources that have a mimetype, such as zip files, will be unarchived before further processing.
This is an example of an idem config file that specifies sls_sources and param_sources:
idem:
sls_sources:
- file://path/to/sls_tree
- file://path/to/sls_source.zip
- git://github.com/my_user/my_project.git
- git+http://github.com/my_user/my_project.git
- git+https://github.com/my_user/my_project.git
- git+ssh://github.com/my_user/my_project.git
param_sources:
- file://path/to/sls_tree
- file://path/to/sls_source.zip
- git://github.com/my_user/my_project.git
- git+http://github.com/my_user/my_project.git
- git+https://github.com/my_user/my_project.git
- git+ssh://github.com/my_user/my_project.git
sls_sources and param_sources can also be specified from the CLI.
$ idem state my.sls.ref \
--sls-sources \
"file://path/to/sls_tree" \
"file://path/to/sls_source.zip" \
"git://github.com/my_user/my_project.git" \
"git+http://github.com/my_user/my_project.git"
"git+https://github.com/my_user/my_project.git"
--param-sources \
"file://path/to/sls_tree" \
"file://path/to/sls_source.zip" \
"git://github.com/my_user/my_project.git"
"git+http://github.com/my_user/my_project.git"
"git+https://github.com/my_user/my_project.git"

Roadmap
Reference the open issues for a list of
proposed features (and known issues).

Acknowledgements

Img Shields for making repository badges easy.