Akd v0.2.1 API Reference
Modules
A framework that makes elixir deployments a breeze. It’s highly configurable, yet easy to set up
A native Hook module that comes shipped with Akd
A native Hook module that comes shipped with Akd
A native Hook module that comes shipped with Akd
A native Hook module that comes shipped with Akd
This module defines helper functions used to initialize, add hooks to, and execute a deployment
This module represents a Deployment
struct which contains metadata about
a deployment
This module represents a Destination
struct which contains metadata about
a destination/location/host
This module defines helper functions which can be used to resolve a destination for based on deployment and the destination type
Defines a Hook
Defines an Akd Pipeline
A native Hook module that comes shipped with Akd
A native Hook module that comes shipped with Akd
This module handles the generation of Dockerfiles which can be used for the deploy process
This module handles the generation of custom hooks which use Akd.Hook
.
This can either directly be called, or called through a mix task,
mix akd.gen.hook
This module handles the generation of a custom task which use Akd.Task
.
This can either directly be called, or called through a mix task,
mix akd.gen.task
A native Hook module that comes shipped with Akd
This module defines a __using__
macro which allows another module
to behave like an Akd.Mix.Task
and define functions which
allow us to define a series of operations on a Deployment
struct and
execute those operations in an organized manner
This module represents an Operation
struct which contains metadata about
a command/operation that can be run on a destination
This module is a work in progress
A native Hook module that comes shipped with Akd
This module is a work in progress
This module defines helper functions that are used by Akd
to execute
a set of commands through the Secure channel, examples: ssh and scp
A native Hook module that comes shipped with Akd
A native Hook module that comes shipped with Akd
Mix Tasks
This task generates a dockerfile module which can be used to run commands on
a Akd.Deployment.t
struct
This task generates a hook module which can be used to run commands on
a Akd.Deployment.t
struct
This task generates a mix task which can be used to deploy an app
This task deploys an app