ExVault v0.1.0-beta.1 ExVault View Source

TODO: Proper documentation for ExVault.

Link to this section Summary

Types

Options:

  • :address - Address of the Vault server to talk to. (Required)
  • :token - The Vault token to authenticate with. If not provided, any calls requiring authentication will fail.
  • :adapter - The Tesla adapter to use. Defaults to Tesla.Adapter.Hackney, which has the best out-of-the-box TLS support. Don't change this without a specific reason

Functions

Perform a 'delete' operation

Perform a 'list' operation

Create a new ExVault client

Perform a 'read' operation

Perform a 'write' operation

Link to this section Types

Link to this type

option() View Source
option() ::
  {:address, String.t()}
  | {:token, String.t()}
  | {:adapter, Tesla.Client.adapter()}

Options:

  • :address - Address of the Vault server to talk to. (Required)
  • :token - The Vault token to authenticate with. If not provided, any calls requiring authentication will fail.
  • :adapter - The Tesla adapter to use. Defaults to Tesla.Adapter.Hackney, which has the best out-of-the-box TLS support. Don't change this without a specific reason.

Link to this section Functions

Perform a 'delete' operation.

Params:

Perform a 'list' operation.

Params:

Create a new ExVault client.

Link to this function

read(client, path, opts \\ []) View Source

Perform a 'read' operation.

Params:

  • client must be an ExVault.client/0 value, as constructed by ExVault.new/1.
  • path is the full path of the entity to read.
  • opts is currently unused. FIXME
Link to this function

write(client, path, params) View Source
write(client(), String.t(), body()) :: ExVault.Response.t()

Perform a 'write' operation.

Params:

  • client must be an ExVault.client/0 value, as constructed by ExVault.new/1.
  • path is the full path of the entity to write.
  • params should be the data to be written, usually in the form of an Elixir map.