Skip to content

Commit

Permalink
Added pkg readme (#32)
Browse files Browse the repository at this point in the history
  • Loading branch information
kleineshertz authored May 14, 2023
1 parent ebf1fe0 commit e0502ff
Show file tree
Hide file tree
Showing 2 changed files with 49 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ For more details about getting started, see [Getting started](doc/started.md). F
### [Capillaries deploy tool: Openstack cloud deployment](test/deploy/README.md)
### [Glossary](doc/glossary.md)
### [Q & A](doc/qna.md)
### [Capillaries Blog](https://capillaries.io/blog/index.html)
### [Capillaries blog](https://capillaries.io/blog/index.html)
### [MIT License](LICENSE)

(C) 2023 kleines.hertz[at]protonmail.com
48 changes: 48 additions & 0 deletions pkg/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# What's in the pkg

## api
High-level calls used by [Toolbelt](../doc/glossary.md#toolbelt) and [Webapi](../doc/glossary.md#webapi)

## cql
CQL query builder

## ctx
Processing context used across all levels of RabbitMQ message processing

## custom
Custom [processors](../doc/glossary.md#processor):
- [py_calc](../doc/glossary.md#py_calc-processor)
- [tag_and_denormalize](../doc/glossary.md#tag_and_denormalize-processor)

## deploy
Utility functions used by [Deploy tool](../doc/glossary#deploy-tool)

## env
Environment configuration for Capillaries [binaries](../doc/binconfig.md)

## eval
Go expression evaluation engine

## exe
Capillaries [binaries](../doc/binconfig.md)

## l
Logging

## proc
Core [script node](../doc/glossary.md#script-node) [processor](../doc/glossary.md#processor)

## sc
Capillaries [Script configuration](../doc/scriptconfig.md) objects

## wf
RabbitMQ messages handled here

## wfdb
Workflow db access functions

## wfmodel
Workflow model

## xfer
SSH/HTTP/SFTP utility functions used by [processors](../doc/glossary.md#processor) and [Deploy tool](../doc/glossary#deploy-tool)

0 comments on commit e0502ff

Please sign in to comment.