Skip to content

punchlinectl

Abstract

main command to interact with archives punchlines straight ahead, without going through a channel command.

Synopsis

This command lets you interact with your archives, whatever the device (filesystem, ceph, minio...). It can be used to list topics, get a status of a pool, dump objects, delete a topic...

The storectl command if fully documented inline and provides a rich auto-completion. This page contains only the very basic usage.

Be careful: delete-topic command deletes data from archiving storage and all its references in the indexation cluster.

Examples

  • To get a status of pool 'mytenant' from a Ceph cluster named 'main':
    storectl pool-status --pool mytenant --device-address ceph_configuration:///etc/ceph/main.conf
    
  • To list topics of pool 'mytenant' from any device in January 2018:
    storectl list-topics --pool mytenant \
        --es-cluster-name es_search --es-index-pattern mytenant-archive \
        --from-date 2018-01-01T00:00:00+01:00 --to-date 2018-01-31T23:59:59+01:00
    
  • To list objects of pool 'mytenant' from a filesystem in January 2018 matching a specific ip using bloom filters:
    storectl list-objects  \
        --pool mytenant --topic apache \
        --from-date 2018-01-01T00:00:00+01:00 --to-date 2018-01-31T23:59:59+01:00 \
        --es-cluster-name es_search --es-index-pattern mytenant-archive \
        --match 128.78.18.47
    
  • To print details (number of tuples, size, ...) of topic, you are free to use --details option:
    storectl list-topics --pool mytenant --es-cluster-name es_search \
        --from-date 2018-01-01T00:00:00+01:00 --to-date 2018-01-31T23:59:59+01:00 \
        --details
    
  • To get a status of a particular topic 'apache' in January 2018:
    storectl topic-status \
        --pool mytenant --topic apache \
        --es-cluster-name es_search --es-index-pattern mytenant-archive \
        --from-date 2018-01-01T00:00:00+01:00 --to-date 2018-01-31T23:59:59+01:00