Install

Installation requires an enterprise licence. Please contact support.

There are several options to install vHSM, the CLI and the enclaivelet:

1. Docker container with precompiled binary

2. Helm for Kubernetes

3. Compile from source

4. Download the CLI

Docker container with precompiled binary

Login to the enclaive repository and enter user and password

docker login harbor.enclaive.cloud 

Pull the container

docker pull harbor.enclaive.cloud/enclaive-dev/vhsm:latest

Helm Chart for Kubernetes

With the release of Helm 3.8.0, Helm is able to store and work with charts in container registries, as an alternative to Helm repositories.

Login to the enclaive repository and enter user and password

helm registry login harbor.enclaive.cloud

You can now install the chart

helm install oci://harbor.enclaive.cloud/enclaive-dev/vhsm --version <version>

Compiling from source

To compile from source, you will need Go installed and properly configured (including a GOPATH environment variable set), as well as a copy of git in your PATH.

Clone the Vault repository from GitHub into your GOPATH:

mkdir -p $GOPATH/src/github.com/enclaive && cd $_
git clone https://github.com/enclaive/vhsm.git
cd vhsm

Bootstrap the project. This will download and compile libraries and tools needed to compile Vault:

make bootstrap

Build Vault for your current system and put the binary in ./bin/ (relative to the git checkout). The make dev target is just a shortcut that builds vhsm for only your local build environment (no cross-compiled targets). The make dev-uibuilds the target with the UI.

make dev

To verify Vault is installed, run vhsm -h on your system. You should see the help output. If you are executing it from the command line, ensure it is on your PATH to avoid receiving an error that Vault is not found.

Download the CLI

Sometimes it may be handy to work with the command line.

enclaive vHSM CLI

Download the Linux CLI from the vHSM server

wget https://vhsm.enclaive.cloud/static/vhsm

Hashicorp Vault CLI

To ensure easy compatibility, enclaive vHSM works seamlessly with the HashiCorp Vault CLI. Please follow the instructions in the Official Packaging Guide to install the HashiCorp GPG key, verify the key's fingerprint, and install Vault.

Ubuntu/Debian

Update the package manager and install GPG and wget.

sudo apt update && sudo apt install gpg wget

Download the keyring

wget -O- https://apt.releases.hashicorp.com/gpg | sudo gpg --dearmor -o /usr/share/keyrings/hashicorp-archive-keyring.gpg

Verify the keyring

gpg --no-default-keyring --keyring /usr/share/keyrings/hashicorp-archive-keyring.gpg --fingerprint

Add the HashiCorp repository.

echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/hashicorp-archive-keyring.gpg] https://apt.releases.hashicorp.com $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hashicorp.list

Install Vault.

sudo apt update && sudo apt install vault

Fedora

Install dnf config-manager to manage your repositories.

sudo dnf install -y dnf-plugins-core

Use dnf config-manager to add the official HashiCorp Linux repository.

sudo dnf config-manager --add-repo https://rpm.releases.hashicorp.com/fedora/hashicorp.repo

Install Vault.

sudo dnf -y install vault

Amazon Linux

Install yum-config-manager to manage your repositories.

$ sudo yum install -y yum-utils

Use yum-config-manager to add the official HashiCorp Linux repository.

$ sudo yum-config-manager --add-repo https://rpm.releases.hashicorp.com/AmazonLinux/hashicorp.repo

Install Vault.

$ sudo yum -y install vault