Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 1.71 KB

README.md

File metadata and controls

65 lines (48 loc) · 1.71 KB
Raw

plugin-github-inven-collector

Introduction

plugin-spaceone-inven-collector is an Inventory Collector Plugin for SpaceONE, designed to collect resources from Github. This plugin has been developed with a new plugin framework.

Setup and Run

Since the current spaceone-inventory package is in a pre-release state, follow the steps below to configure the package.

1. Virtual Environment Setup

Set up a virtual environment using the venv library.

python3 -m venv venv
source venv/bin/activate

2. Package Installation

Install the package with the following commands in the created virtual environment.

pip3 install -r pkg/pip_requirements.txt
pip3 install --pre spaceone-inventory

3. Interpreter Configuration

If you are using PyCharm, configure the virtual environment as the interpreter. img.png img.png img.png

After following the above steps, run the Plugin Server. img.png

Local Environment Testing

After running the Plugin Server, perform tests for each method with the following commands.

Check available API methods:

spacectl api-resources

Collector.init

spacectl exec init inventory.Collector -f test/init.yml

Collector.verify

spacectl exec verify inventory.Collector -f test/verify.yml

Collector.collect

spacectl exec collect inventory.Collector -f test/collect.yml

Note

Metadata will be defined as a dictionary and will be converted to YAML. The spaceone-inventory package is in a pre-release state, so the --pre option must be added when using pip install.