Open-Source Wikis

/

Vault

/

Packages

hashicorp/vault

Packages

Two Go modules in this repository are meant to be imported by other projects:

Path Module Purpose
api/ github.com/hashicorp/vault/api The Vault HTTP API client.
sdk/ github.com/hashicorp/vault/sdk The plugin and helper SDK used to build auth methods, secret engines, and database plugins.

A third "package", the Ember.js UI under ui/, is described in systems / UI.

The repo also publishes per-auth-method client packages — api/auth/<name>/ — as their own Go modules. They wrap the lower-level api.Client in convenience methods specific to one login workflow.

The remainder of the OSS source tree (vault/, command/, http/, physical/, audit/, serviceregistration/, helper/, internalshared/, internal/, limits/) is not intended to be imported. Some projects have done it anyway, and the README explicitly disclaims support for that:

Note that this repository also contains Vault (the product), and as with most Go projects, Vault uses Go modules to manage its dependencies. … the presence of that file also makes it theoretically possible to import Vault as a dependency into other projects. … This is not, and has never been, a supported way to use the Vault project.

Pages

  • api — the Go HTTP client and per-auth-method helper packages.
  • sdk — the framework for building Vault plugins.

Built by Factory AutoWiki from public repository content. It is a generated preview for codebase exploration, not source-maintained documentation.

Packages – Vault wiki | Factory