Skip to content

Latest commit

 

History

History
1009 lines (704 loc) · 37.4 KB

README.rst

File metadata and controls

1009 lines (704 loc) · 37.4 KB
Raw

Turtles

Turtles logo

Turtles is a tool to manage LOCKSS plugin sets and LOCKSS plugin registries.

Latest release: 0.5.0 (2024-09-04)

Table of Contents

Installation

Turtles is available from the Python Package Index (PyPI) as lockss-turtles (https://pypi.org/project/lockss-turtles), and can be installed with pip.

The installation process adds a turtles Command Line Tool. You can check at the command line that the installation is functional by running turtles version or turtles --help.

Prerequisites

Prerequisites for development work only:

pip

You can install Turtles with pip.

To install it in your own non-root, non-virtual environment, use the --user option:

pip3 install --user lockss-turtles

To install it in a virtual environment, simply use:

pip3 install lockss-turtles

!DANGER!

Do not run pip3/pip as root, with sudo or otherwise.

Overview

Building Plugins

You can use Turtles to build (package and sign) LOCKSS plugins from one or more LOCKSS plugin sets (codebases containing plugins).

You will need to define one or more Plugin Sets, list them in a Plugin Set Catalog, and declare your Plugin Signing Credentials.

You then use the build-plugin command to build plugins, or the release-plugin command to build and deploy plugins (equivalent of build-plugin followed by deploy-plugin).

Deploying Plugins

You can use Turtles to deploy LOCKSS plugins to LOCKSS plugin registries.

You will need to define one or more Plugin Registries and declare them in a Plugin Registry Catalog.

You then use the deploy-plugin command to deploy plugin JARs, or the release-plugin command to build and deploy plugins from Plugin Sets (equivalent of build-plugin followed by deploy-plugin).

Configuration Files

All Turtles configuration files are YAML files and have a top-level kind key that declares what kind of configuration file it is.

Some Turtles commands require a Plugin Set Catalog, Plugin Registry Catalog, or Plugin Signing Credentials. You can specify the configuration file to use via the appropriate command line option (for example --plugin-set-catalog/-s). Otherwise, Turtles will look for then appropriate configuration file (for example plugin-set-catalog.yaml) in several standard directories, in this order:

  • $XDG_CONFIG_HOME/lockss.turtles (by default $HOME/.config/lockss.turtles)
  • /usr/local/share/lockss.turtles
  • /etc/lockss.turtles

Plugin Set Catalog

Turtles commands that are Building Plugins (build-plugin, release-plugin) need a plugin set catalog. It can be specified via the --plugin-set-catalog/-s option, otherwise Turtles looks through Configuration Files for a file named plugin-set-catalog.yaml.

A plugin set catalog is defined by a YAML document:

---
kind: PluginSetCatalog
plugin-set-files:
  - /path/to/some/file1.yaml
  - /path/to/another/file2.yaml
  - ...

The contents are described below:

kind
Required. Must be set to PluginSetCatalog.
plugin-set-files
Required. A list of one or more paths to Plugin Sets.

Plugin Sets

A plugin set is a project containing the source code of one or more LOCKSS plugins.

A plugin set is defined by a YAML document:

---
kind: PluginSet
id: mypluginset
name: My Plugin Set
builder:
  type: ...
  ...

The contents are described below:

kind
Required. Must be set to PluginSet.
id
Required. A short identifier for the plugin set, for example mypluginset.
name
Required. A display name for the plugin set, for example My Plugin Set.
builder

Required. An object defining the plugin set's builder together with its options.

type
Required. A plugin set builder type. See Plugin Set Builders below.
Other
Additional properties depending on the plugin set builder type. See Plugin Set Builders below.

Plugin Set Builders

Turtles Plugin Sets support two types of plugin set builders:

Maven Plugin Set Builder

This type of plugin set builder is for a Maven project inheriting from org.lockss:lockss-plugins-parent-pom.

Maven Plugin Set Builder Prerequisites
Maven Plugin Set Builder Declaration

For this plugin set builder type, the builder object in the plugin set definition has the following structure:

---
kind: PluginSet
id: ...
name: ...
builder:
  type: mvn
  main: ...
  test: ...
type
Required. Must be set to mvn.
main
Optional. The path (relative to the root of the project) to the plugins' source code. Default: src/main/java.
test
Optional. The path (relative to the root of the project) to the plugins' unit tests. Default: src/test/java.

Ant Plugin Set Builder

This type of plugin set builder is for the LOCKSS 1.x (https://github.com/lockss/lockss-daemon) code tree, based on Ant.

Ant Plugin Set Builder Prerequisites
  • Java Development Kit 8 (JDK).
  • Apache Ant.
  • JAVA_HOME must be set appropriately.
Ant Plugin Set Builder Declaration

For this plugin set builder type, the builder object in the plugin set definition has the following structure:

---
kind: PluginSet
id: ...
name: ...
builder:
  type: ant
  main: ...
  test: ...
type
Required. Must be set to ant.
main
Optional. The path (relative to the root of the project) to the plugins' source code. Default: plugins/src.
test
Optional. The path (relative to the root of the project) to the plugins' unit tests. Default: plugins/test/src.

Plugin Registry Catalog

Turtles commands that are Deploying Plugins (deploy-plugin, release-plugin) need a plugin registry catalog. It can be specified via the --plugin-registry-catalog/-r option, otherwise Turtles looks through Configuration Files for a file named plugin-registry-catalog.yaml.

A plugin set catalog is defined by a YAML document:

---
kind: PluginRegistryCatalog
plugin-registry-files:
  - /path/to/some/file1.yaml
  - /path/to/another/file2.yaml
  - ...

The contents are described below:

kind
Required. Must be set to PluginRegistryCatalog.
plugin-registry-files
Required. A list of one or more paths to Plugin Registries.

Plugin Registries

A plugin registry is a structure containing LOCKSS plugins packaged as signed JAR files.

Currently the only predefined structures are directory structures local to the file system, which are then typically served by a Web server.

A plugin registry is defined by a YAML document:

---
kind: PluginRegistry
id: mypluginregistry
name: My Plugin Registry
layout:
  type: ...
  ...
layers:
  - ...
plugin-identifiers:
  - edu.myuniversity.plugin.publisherx.PublisherXPlugin
  - edu.myuniversity.plugin.publishery.PublisherYPlugin
  - ...
suppressed-plugin-identifiers:
  - edu.myuniversity.plugin.old.OldPlugin
  - ...

The contents are described below:

kind
Required. Must be set to PluginRegistry.
id
Required. A short identifier for the plugin registry, for example mypluginregistry.
name
Required. A display name for the plugin registry, for example My Plugin Registry.
layout

Required. An object defining the plugin registry's layout together with its options.

type
Required. A plugin registry layout type. See Plugin Registry Layouts below.
Other
Additional properties depending on the plugin registry layout type. See Plugin Registry Layouts below.
layers
Required. A list of objects describing the layers of the plugin registry. See Plugin Registry Layers below.
plugin-identifiers
Required. Non-empty list of the plugin identifiers in this plugin registry.
suppressed-plugin-identifiers

Optional. Non-empty list of plugin identifiers that are excluded from this plugin registry.

Turtles does not currently do anything with this information, but it can be used to record plugins that have been abandoned or retracted over the lifetime of the plugin registry.

Plugin Registry Layouts

Turtles supports two kinds of plugin registry layouts:

Directory Plugin Registry Layout

In this type of plugin registry layout, each layer consists of a directory on the local file system where signed plugin JARs are stored, which is then typically served by a Web server. The directory for each layer is designated by the layer's path property.

Directory Plugin Registry Layout Prerequisites

None.

Directory Plugin Registry Layout Declaration

For this plugin registry layout type, the layout object in the plugin registry definition has the following structure:

---
kind: PluginRegistry
id: ...
name: ...
layout:
  type: directory
  file-naming-convention: ...
layers:
  - ...
plugin-identifiers:
  - ...
suppressed-plugin-identifiers:
  - ...
type
Required. Must be set to directory.
file-naming-convention

Optional. A rule for what to name each deployed JAR file. If unspecified, the behavior is that of identifier. Can be one of:

  • identifier: Use the plugin identifier and add .jar. For example edu.myuniversity.plugin.publisherx.PublisherXPlugin results in edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar.
  • underscore: Replace . in the plugin identifier with _, and add .jar. For example edu.myuniversity.plugin.publisherx.PublisherXPlugin results in edu_myuniversity_plugin_publisherx_PublisherXPlugin.jar.
  • abbreviated: Use the last dotted component of the plugin identifier and add .jar. For example edu.myuniversity.plugin.publisherx.PublisherXPlugin results in PublisherXPlugin.jar.

RCS Plugin Registry Layout

In this specialization of the Directory Plugin Registry Layout, each successive version of a given JAR is kept locally in RCS.

RCS Plugin Registry Layout Prerequisites
RCS Plugin Registry Layout Declaration

For this plugin registry layout type, the layout object in the plugin registry definition has the following structure:

---
kind: PluginRegistry
id: ...
name: ...
layout:
  type: rcs
  file-naming-convention: ...
layers:
  - ...
plugin-identifiers:
  - ...
suppressed-plugin-identifiers:
  - ...
type
Required. Must be set to rcs.
file-naming-convention

Optional. A rule for what to name each deployed JAR file. If unspecified, the behavior is that of identifier. Can be one of:

  • identifier: Use the plugin identifier and add .jar. For example edu.myuniversity.plugin.publisherx.PublisherXPlugin results in edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar.
  • underscore: Replace . in the plugin identifier with _, and add .jar. For example edu.myuniversity.plugin.publisherx.PublisherXPlugin results in edu_myuniversity_plugin_publisherx_PublisherXPlugin.jar.
  • abbreviated: Use the last dotted component of the plugin identifier and add .jar. For example edu.myuniversity.plugin.publisherx.PublisherXPlugin results in PublisherXPlugin.jar.

Plugin Registry Layers

A plugin registry consists of one or more layers.

Some plugin registries only one layer, in which case the LOCKSS boxes in a network using the plugin registry will get what is released to it. Some plugin registries may have two or more layers, with the additional layers used for plugin development or content processing quality assurance.

Layers are sequential in nature; a new version of a plugin is released to the lowest layer first, then to the next layer (after some process), and so on until the highest layer. This sequencing is reflected in the ordering of the layers list in the plugin registry definition.

Although the identifiers (see id below) and display names (see name below) of plugin registry layers are arbitrary, the highest layer is commonly referred to as the production layer, and when there are exactly two layers, the lower layer is commonly referred to as the testing layer. Turtles reflects this common idiom with built-in --production/-p and --testing/-t options that are shorthand for --layer=production and --layer=testing respectively.

It is possible for multiple plugin registries to have a layer path in common. An example would be a team working on several plugin registries for different purposes, having distinct (public) production layer paths, but sharing a single (internal) testing layer path, if they are the only audience for it.

A plugin registry layer is defined as one of the objects in the plugin registry definition's layers list. Each layer object has the following structure:

---
kind: PluginRegistry
id: ...
name: ...
layout:
  type: ...
  ...
layers:
  - id: testing
    name: My Plugin Registry (Testing)
    path: /path/to/testing
  - id: production
    name: My Plugin Registry (Production)
    path: /path/to/production
  - ...
plugin-identifiers:
  - ...
suppressed-plugin-identifiers:
  - ...
id
Required. A short identifier for the plugin registry layer, for example testing.
name
Required. A display name for the plugin registry layer, for example My Plugin Registry (Testing).
path
Required. The local path to the root of the plugin registry layer, for example /path/to/testing.

Plugin Signing Credentials

Turtles commands that are Building Plugins (build-plugin, release-plugin) need a reference to plugin signing credentials. They can be specified via the --plugin-signing-credentials/-c option, otherwise Turtles looks through Configuration Files for a file named plugin-signing-credentials.yaml.

Plugin signing credentials are defined by a YAML document:

---
kind: PluginSigningCredentials
plugin-signing-keystore: /path/to/myalias.keystore
plugin-signing-alias: myalias

The contents are described below:

kind
Required. Must be set to PluginSigningCredentials.
plugin-signing-keystore
Required. Path to the plugin signing key (keystore).
plugin-signing-alias
Required. The alias to use, which must be that of the plugin signing key (keystore) and also found in the LOCKSS network's shared keystore.

Command Line Tool

Turtles is invoked at the command line as:

turtles

or as a Python module:

python3 -m lockss.turtles

Help messages and this document use turtles throughout, but the two invocation styles are interchangeable.

Synopsis

Turtles uses Commands, in the style of programs like git, dnf/yum, apt/apt-get, and the like. You can see the list of available Commands by invoking turtles --help, and you can find a usage summary of all the Commands by invoking turtles usage:

usage: turtles [-h] [--debug-cli] [--non-interactive] COMMAND ...

       turtles build-plugin [-h] [--output-format FMT] [--password PASS]
                            [--plugin-set-catalog FILE]
                            [--plugin-signing-credentials FILE]
                            [--identifier PLUGID] [--identifiers FILE]
                            [PLUGID ...]

       turtles copyright [-h]

       turtles deploy-plugin [-h] [--output-format FMT]
                             [--plugin-registry-catalog FILE] [--production]
                             [--testing] [--jar PLUGJAR] [--jars FILE]
                             [--layer LAYER] [--layers FILE]
                             [PLUGJAR ...]

       turtles license [-h]

       turtles release-plugin [-h] [--output-format FMT] [--password PASS]
                              [--plugin-registry-catalog FILE]
                              [--plugin-set-catalog FILE]
                              [--plugin-signing-credentials FILE]
                              [--production] [--testing] [--identifier PLUGID]
                              [--identifiers FILE] [--layer LAYER]
                              [--layers FILE]
                              [PLUGID ...]

       turtles usage [-h]

       turtles version [-h]

Commands

The available commands are:

Command Abbreviation Purpose
build-plugin bp build (package and sign) plugins
copyright   show copyright and exit
deploy-plugin dp deploy plugins
license   show license and exit
release-plugin rp release (build and deploy) plugins
usage   show detailed usage and exit
version   show version and exit

Top-Level Program

The top-level executable alone does not perform any action or default to a given command. It does define a few options, which you can see by invoking Turtles with the --help/-h option:

usage: turtles [-h] [--debug-cli] [--non-interactive] COMMAND ...

options:
  -h, --help            show this help message and exit
  --debug-cli           print the result of parsing command line arguments
  --non-interactive, -n
                        disallow interactive prompts (default: allow)

commands:
  Add --help to see the command's own help message.

  COMMAND               DESCRIPTION
    build-plugin (bp)   build (package and sign) plugins
    copyright           show copyright and exit
    deploy-plugin (dp)  deploy plugins
    license             show license and exit
    release-plugin (rp)
                        release (build and deploy) plugins
    usage               show detailed usage and exit
    version             show version and exit

build-plugin (bp)

The build-plugin command is used for Building Plugins. It has its own --help/-h option:

usage: turtles build-plugin [-h] [--output-format FMT] [--password PASS]
                            [--plugin-set-catalog FILE]
                            [--plugin-signing-credentials FILE]
                            [--identifier PLUGID] [--identifiers FILE]
                            [PLUGID ...]

Build (package and sign) plugins.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, double_grid, double_outline,
                        fancy_grid, fancy_outline, github, grid, heavy_grid,
                        heavy_outline, html, jira, latex, latex_booktabs,
                        latex_longtable, latex_raw, mediawiki, mixed_grid,
                        mixed_outline, moinmoin, orgtbl, outline, pipe, plain,
                        presto, pretty, psql, rounded_grid, rounded_outline,
                        rst, simple, simple_grid, simple_outline, textile,
                        tsv, unsafehtml, youtrack)
  --password PASS       set the plugin signing password
  --plugin-set-catalog FILE, -s FILE
                        load plugin set catalog from FILE (default:
                        $HOME/.config/lockss.turtles/plugin-set-
                        catalog.yaml or
                        /usr/local/share/lockss.turtles/plugin-set-
                        catalog.yaml or /etc/lockss.turtles/plugin-set-
                        catalog.yaml)
  --plugin-signing-credentials FILE, -c FILE
                        load plugin signing credentials from FILE (default:
                        $HOME/.config/lockss.turtles/plugin-signing-
                        credentials.yaml or
                        /usr/local/share/lockss.turtles/plugin-signing-
                        credentials.yaml or /etc/lockss.turtles/plugin-
                        signing-credentials.yaml)

plugin identifier arguments and options:
  --identifier PLUGID, -i PLUGID
                        add PLUGID to the list of plugin identifiers to build
  --identifiers FILE, -I FILE
                        add the plugin identifiers in FILE to the list of
                        plugin identifiers to build
  PLUGID                plugin identifier to build

The command needs:

It also accepts Options for Output Format Control

Examples:

# Help message
turtles build-plugin --help
# Abbreviation
turtles bp -h

# List of plugin identifiers
turtles build-plugin edu.myuniversity.plugin.publisherx.PublisherXPlugin edu.myuniversity.plugin.publishery.PublisherYPlugin ...
# Abbreviation
turtles bp edu.myuniversity.plugin.publisherx.PublisherXPlugin edu.myuniversity.plugin.publishery.PublisherYPlugin ...

# Alternative invocation
turtles build-plugin --identifier=edu.myuniversity.plugin.publisherx.PublisherXPlugin --identifier=edu.myuniversity.plugin.publishery.PublisherYPlugin ...
# Abbreviation
turtles bp -i edu.myuniversity.plugin.publisherx.PublisherXPlugin -i edu.myuniversity.plugin.publishery.PublisherYPlugin ...

# Alternative invocation
# /tmp/pluginids.txt has one plugin identifier per line
turtles build-plugin --identifiers=/tmp/pluginids.txt
# Abbreviation
turtles bp -I /tmp/pluginids.txt

copyright

The copyright command displays the copyright notice for Turtles and exits.

deploy-plugin (dp)

The deploy-plugin command is used for Deploying Plugins. It has its own --help/-h option:

usage: turtles deploy-plugin [-h] [--output-format FMT]
                             [--plugin-registry-catalog FILE] [--production]
                             [--testing] [--jar PLUGJAR] [--jars FILE]
                             [--layer LAYER] [--layers FILE]
                             [PLUGJAR ...]

Deploy plugins.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, double_grid, double_outline,
                        fancy_grid, fancy_outline, github, grid, heavy_grid,
                        heavy_outline, html, jira, latex, latex_booktabs,
                        latex_longtable, latex_raw, mediawiki, mixed_grid,
                        mixed_outline, moinmoin, orgtbl, outline, pipe, plain,
                        presto, pretty, psql, rounded_grid, rounded_outline,
                        rst, simple, simple_grid, simple_outline, textile,
                        tsv, unsafehtml, youtrack)
  --plugin-registry-catalog FILE, -r FILE
                        load plugin registry catalog from FILE (default:
                        $HOME/.config/lockss.turtles/plugin-registry-
                        catalog.yaml or
                        /usr/local/share/lockss.turtles/plugin-registry-
                        catalog.yaml or /etc/lockss.turtles/plugin-registry-
                        catalog.yaml)
  --production, -p      synonym for --layer=production (i.e. add 'production'
                        to the list of plugin registry layers to process)
  --testing, -t         synonym for --layer=testing (i.e. add 'testing' to the
                        list of plugin registry layers to process)

plugin JAR arguments and options:
  --jar PLUGJAR, -j PLUGJAR
                        add PLUGJAR to the list of plugin JARs to deploy
  --jars FILE, -J FILE  add the plugin JARs in FILE to the list of plugin JARs
                        to deploy
  PLUGJAR               plugin JAR to deploy

plugin registry layer options:
  --layer LAYER, -l LAYER
                        add LAYER to the list of plugin registry layers to
                        process
  --layers FILE, -L FILE
                        add the layers in FILE to the list of plugin registry
                        layers to process

The command needs:

  • A Plugin Registry Catalog, either from the --plugin-registry-catalog/-r option or from plugin-signing-credentials.yaml in the Configuration Files.
  • One or more plugin registry layer IDs, from the Plugin Registry Layer Options (--layer/-l options, --layers/-L options, and alternatively, --testing/-t options, --production/-p option).
  • One or more JAR paths. The list of JAR paths to process is derived from:
    • The JAR paths listed as bare arguments to the command.
    • The JAR paths listed as --jar/-j options.
    • The JAR paths found in the files listed as --jars/-J options.

It also accepts Options for Output Format Control.

Examples:

# Help message
turtles deploy-plugin --help
# Abbreviation
turtles dp -h

# List of JARs
# Deploy to 'testing' layer only
turtles deploy-plugin --testing /path/to/edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar /path/to/edu.myuniversity.plugin.publishery.PublisherYPlugin.jar ...
# Abbreviation
turtles dp -t /path/to/edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar /path/to/edu.myuniversity.plugin.publishery.PublisherYPlugin.jar ...

# Alternative invocation
# Deploy to 'production' layer only
turtles deploy-plugin --production --jar=/path/to/edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar --jar=/path/to/edu.myuniversity.plugin.publishery.PublisherYPlugin.jar ...
# Abbreviation
turtles dp -p -j /path/to/edu.myuniversity.plugin.publisherx.PublisherXPlugin.jar -j /path/to/edu.myuniversity.plugin.publishery.PublisherYPlugin.jar ...

# Alternative invocation
# /tmp/pluginjars.txt has one JAR path per line
# Deploy to both 'testing' and 'production' layers
turtles deploy-plugin --testing --production --jars=/tmp/pluginjars.txt
# Abbreviation
turtles bp -tp -J /tmp/pluginids.txt

license

The license command displays the license terms for Turtles and exits.

release-plugin (rp)

The release-plugin command is used for Building Plugins and Deploying Plugins, being essentially build-plugin followed by deploy-plugin. It has its own --help/-h option:

usage: turtles release-plugin [-h] [--output-format FMT] [--password PASS]
                              [--plugin-registry-catalog FILE]
                              [--plugin-set-catalog FILE]
                              [--plugin-signing-credentials FILE]
                              [--production] [--testing] [--identifier PLUGID]
                              [--identifiers FILE] [--layer LAYER]
                              [--layers FILE]
                              [PLUGID ...]

Release (build and deploy) plugins.

options:
  -h, --help            show this help message and exit
  --output-format FMT   set tabular output format to FMT (default: simple;
                        choices: asciidoc, double_grid, double_outline,
                        fancy_grid, fancy_outline, github, grid, heavy_grid,
                        heavy_outline, html, jira, latex, latex_booktabs,
                        latex_longtable, latex_raw, mediawiki, mixed_grid,
                        mixed_outline, moinmoin, orgtbl, outline, pipe, plain,
                        presto, pretty, psql, rounded_grid, rounded_outline,
                        rst, simple, simple_grid, simple_outline, textile,
                        tsv, unsafehtml, youtrack)
  --password PASS       set the plugin signing password
  --plugin-registry-catalog FILE, -r FILE
                        load plugin registry catalog from FILE (default:
                        $HOME/.config/lockss.turtles/plugin-registry-
                        catalog.yaml or
                        /usr/local/share/lockss.turtles/plugin-registry-
                        catalog.yaml or /etc/lockss.turtles/plugin-registry-
                        catalog.yaml)
  --plugin-set-catalog FILE, -s FILE
                        load plugin set catalog from FILE (default:
                        $HOME/.config/lockss.turtles/plugin-set-
                        catalog.yaml or
                        /usr/local/share/lockss.turtles/plugin-set-
                        catalog.yaml or /etc/lockss.turtles/plugin-set-
                        catalog.yaml)
  --plugin-signing-credentials FILE, -c FILE
                        load plugin signing credentials from FILE (default:
                        $HOME/.config/lockss.turtles/plugin-signing-
                        credentials.yaml or
                        /usr/local/share/lockss.turtles/plugin-signing-
                        credentials.yaml or /etc/lockss.turtles/plugin-
                        signing-credentials.yaml)
  --production, -p      synonym for --layer=production (i.e. add 'production'
                        to the list of plugin registry layers to process)
  --testing, -t         synonym for --layer=testing (i.e. add 'testing' to the
                        list of plugin registry layers to process)

plugin identifier arguments and options:
  --identifier PLUGID, -i PLUGID
                        add PLUGID to the list of plugin identifiers to build
  --identifiers FILE, -I FILE
                        add the plugin identifiers in FILE to the list of
                        plugin identifiers to build
  PLUGID                plugin identifier to build

plugin registry layer options:
  --layer LAYER, -l LAYER
                        add LAYER to the list of plugin registry layers to
                        process
  --layers FILE, -L FILE
                        add the layers in FILE to the list of plugin registry
                        layers to process

The command needs:

It also accepts Options for Output Format Control.

Examples:

# Help message
turtles release-plugin --help
# Abbreviation
turtles rp -h

# List of plugin identifiers
# Deploy to 'testing' layer only
turtles release-plugin --testing edu.myuniversity.plugin.publisherx.PublisherXPlugin edu.myuniversity.plugin.publishery.PublisherYPlugin ...
# Abbreviation
turtles rp -t edu.myuniversity.plugin.publisherx.PublisherXPlugin edu.myuniversity.plugin.publishery.PublisherYPlugin ...

# Alternative invocation
# Deploy to 'production' layer only
turtles release-plugin --production --identifier=edu.myuniversity.plugin.publisherx.PublisherXPlugin --identifier=edu.myuniversity.plugin.publishery.PublisherYPlugin ...
# Abbreviation
turtles rp -p -i edu.myuniversity.plugin.publisherx.PublisherXPlugin -i edu.myuniversity.plugin.publishery.PublisherYPlugin ...

# Alternative invocation
# /tmp/pluginids.txt has one plugin identifier per line
# Deploy to both 'testing' and 'production' layers
turtles release-plugin --testing --production --identifiers=/tmp/pluginids.txt
# Abbreviation
turtles rp -tp -I /tmp/pluginids.txt

usage

The usage command displays the usage message of all the Turtles Commands.

version

The version command displays the version number of Turtles and exits.

Options

Plugin Identifier Arguments and Options

Commands that are Building Plugins expect one or more plugin identifiers. The list of plugin identifiers to process is derived from:

  • The plugin identifiers listed as bare arguments to the command.
  • The plugin identifiers listed as --identifier/-i options.
  • The plugin identifiers found in the files listed as --identifiers/-I options.

Plugin Registry Layer Options

Commands that are Deploying Plugins expect one or more plugin registry layer IDs. The list of plugin registry layer IDs to target is derived from:

  • The plugin registry layer IDs listed as --layer/-l options.
  • The plugin registry layer IDs found in the files listed as --layers/-L options.

As a convenience, the following synonyms also exist:

  • --testing/-t is a synonym for --layer=testing
  • --production/-p is a synonym for --layer=production

Output Format Control

Turtles' tabular output is performed by the tabulate library through the --output-format option. See its PyPI page for a visual reference of the various output formats available. The default is simple.