Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api implements REST API support for Aptomi, including user-level and admin-level calls.
|
Package api implements REST API support for Aptomi, including user-level and admin-level calls. |
|
Package config provides support for Aptomi configuration - Server config, Client config, and their common sections (API config)
|
Package config provides support for Aptomi configuration - Server config, Client config, and their common sections (API config) |
|
Package engine implements core engine of Aptomi, which does policy resolution (resolve), diff calculation between states (diff), and state enforcement by applying actions (apply).
|
Package engine implements core engine of Aptomi, which does policy resolution (resolve), diff calculation between states (diff), and state enforcement by applying actions (apply). |
|
actual
Package actual defines a state updater, which reacts to changes in actual state done by engine applier.
|
Package actual defines a state updater, which reacts to changes in actual state done by engine applier. |
|
apply
Package apply implements state enforcer, which executes a list of actions to move from actual state to desired state, performing actual deployment of services and configuration of the underlying cloud components.
|
Package apply implements state enforcer, which executes a list of actions to move from actual state to desired state, performing actual deployment of services and configuration of the underlying cloud components. |
|
apply/action
Package action defines a base action (actions get born a result of policy diff calculation), as well as context which gets passed to all actions during apply phase.
|
Package action defines a base action (actions get born a result of policy diff calculation), as well as context which gets passed to all actions during apply phase. |
|
apply/action/component
Package component defines all component-specific actions, which get generated by the policy diff when component changes occur for specific component instances.
|
Package component defines all component-specific actions, which get generated by the policy diff when component changes occur for specific component instances. |
|
apply/action/global
Package global defines a global post-processing action, which gets generated by the policy diff only once after processing all component instances.
|
Package global defines a global post-processing action, which gets generated by the policy diff only once after processing all component instances. |
|
diff
Package diff allows Aptomi to determine the difference between actual state (running on the cloud) and desired state (that Aptomi wants to enforce), generating a list of actions to reconcile the difference.
|
Package diff allows Aptomi to determine the difference between actual state (running on the cloud) and desired state (that Aptomi wants to enforce), generating a list of actions to reconcile the difference. |
|
progress
Package progress implements progress indicators, which are used during state enforcement while running actions and plugins to estimate progress and show completion percentage to the user.
|
Package progress implements progress indicators, which are used during state enforcement while running actions and plugins to estimate progress and show completion percentage to the user. |
|
resolve
Package resolve is a heart of Aptomi that performs policy resolution, taking policy and service consumption intents as input, producing a set of components to be instantiated in the cloud (desired state) as output, along with their discovery parameters, code parameters, and component instance graph.
|
Package resolve is a heart of Aptomi that performs policy resolution, taking policy and service consumption intents as input, producing a set of components to be instantiated in the cloud (desired state) as output, along with their discovery parameters, code parameters, and component instance graph. |
|
Package errors defines custom errors which are widely used across Aptomi code base.
|
Package errors defines custom errors which are widely used across Aptomi code base. |
|
Package event implements support for Aptomi Event Logs and saving them to console, memory, and external stores (BoltDB).
|
Package event implements support for Aptomi Event Logs and saving them to console, memory, and external stores (BoltDB). |
|
Package external implements support for all pluggable data sources which are external to Aptomi, such as users and secrets.
|
Package external implements support for all pluggable data sources which are external to Aptomi, such as users and secrets. |
|
secrets
Package secrets implements support for retrieving user Secrets from external sources (File).
|
Package secrets implements support for retrieving user Secrets from external sources (File). |
|
users
Package users implements support for retrieving Users and their labels from external sources (LDAP, File).
|
Package users implements support for retrieving Users and their labels from external sources (LDAP, File). |
|
Package lang provides core constructs for describing Aptomi policy, as well as core structures for processing policy.
|
Package lang provides core constructs for describing Aptomi policy, as well as core structures for processing policy. |
|
builder
Package builder provides simple and easy-to-use way to construct Aptomi Policy in the source code, primarily for unit tests.
|
Package builder provides simple and easy-to-use way to construct Aptomi Policy in the source code, primarily for unit tests. |
|
expression
Package expression provides support for evaluating expressions in Aptomi, with support for caching compiled expressions.
|
Package expression provides support for evaluating expressions in Aptomi, with support for caching compiled expressions. |
|
template
Package template provides support for evaluating text templates in Aptomi, with support for caching compiled templates.
|
Package template provides support for evaluating text templates in Aptomi, with support for caching compiled templates. |
|
yaml
Package yaml provides support for marshalling YAML objects and loading/unmarshalling them from YAML files.
|
Package yaml provides support for marshalling YAML objects and loading/unmarshalling them from YAML files. |
|
Package plugin introduces plugins for Aptomi engine, which are responsible for component instantiation and management on different cloud providers (e.g.
|
Package plugin introduces plugins for Aptomi engine, which are responsible for component instantiation and management on different cloud providers (e.g. |
|
helm
Package helm implements support for Helm plugin, which can deploy Helm charts onto k8s clusters via Helm API.
|
Package helm implements support for Helm plugin, which can deploy Helm charts onto k8s clusters via Helm API. |
|
store/core
Package core allows to persist Aptomi engine objects into the object store.
|
Package core allows to persist Aptomi engine objects into the object store. |
|
Package server implements Aptomi server, which serves UI front-end, API calls, as well as does policy resolution & continuous state enforcement.
|
Package server implements Aptomi server, which serves UI front-end, API calls, as well as does policy resolution & continuous state enforcement. |
|
Package util contains various utility methods for working with data (slice, map, nested map, string, time) as well as system-level primitives (files, exec).
|
Package util contains various utility methods for working with data (slice, map, nested map, string, time) as well as system-level primitives (files, exec). |
|
Package version allows to capture and store information about Aptomi binary (version, commit, date) so that we know when and how it was built.
|
Package version allows to capture and store information about Aptomi binary (version, commit, date) so that we know when and how it was built. |
|
Package visualization implements Aptomi policy & resolution data visualization using network-based diagrams for visjs
|
Package visualization implements Aptomi policy & resolution data visualization using network-based diagrams for visjs |
Click to show internal directories.
Click to hide internal directories.