Installation and setup

Configuration

For leveraging plugins from within the csspin-ce plugin-package for csspin, the plugin-package must be added to the list of plugin-packages within a project’s spinfile.yaml.

Example: spinfile.yaml setup to enable the provided plugins

plugin_packages:
    - csspin-ce
    - csspin-frontend   # required by csspin-ce
    - csspin-java       # required by csspin-ce
    - csspin-python     # required by csspin-ce
plugins:
    - csspin_ce:
        - ce_services
        - mkinstance
        - pkgtest
contact_elements:
    umbrella: <The umbrella to use>
python:
    version: '3.11.9'
    index_url: <URL to package server to retrieve CE wheels from>
node:
    version: '18.17.1'

After the setup is done, the plugin-package can be provisioned by executing the following command within the project’s directory:

spin provision

The plugins defined in the plugins section of the spinfile.yaml can now be used, using:

spin ce-services --help

Note

Using any plugin of this package requires setting contact_elements.umbrella in the spinfile.yaml.

System requirements

The csspin-ce plugin-package requires the following software to be installed on the host system in order to work properly for all provided plugins (if not further specified, the requirements apply to all operating systems):

• csspin

• vcredist140 (Windows, e.g. via Microsoft Visual C++ 2015-2022 Redistributable)

For using the ce_services plugin, the following additional software is needed:

• build-essential (Debian/Ubuntu, e.g. via apt-get install build-essential)

• libaio1 (Debian/Ubuntu, if Oracle instances are used, e.g. via apt-get install libaio1)

• redis-server (Debian/Ubuntu, e.g. via apt-get install redis-server)

• make (Debian/Ubuntu, if using the RabbitMQ service without pre-installed Erlang, e.g. via apt-get install make)