Installation¶

This document holds instructions on installing Vintner.

Script¶

Vintner can be installed on Linux x64/ arm64 and Windows x64 using our installation scripts.

Linux x64/ arm64Windows x64

curl -fsSL https://vintner.opentosca.org/install.sh | sudo bash -

Install a specific version as follows.

curl -fsSL https://vintner.opentosca.org/install.sh | sudo VERSION=${VERSION} bash -

powershell -Command "& {Invoke-WebRequest -Uri 'https://vintner.opentosca.org/install.ps1' -UseBasicParsing | Invoke-Expression}"

Install a specific version as follows.

Invoke-WebRequest -Uri "https://vintner.opentosca.org/install.ps1" -OutFile install.ps1
$env:VERSION = "DESIRED_VERSION"
powershell -ExecutionPolicy Bypass -File .\install.ps1
Remove-Item install.ps1

NPM¶

Vintner can be installed using npm. Ensure, that npm bin -g is in your $PATH.

npm install --global opentosca-vintner

Yarn (Classic)¶

Vintner can be installed using yarn (classic). Ensure, that yarn global bin is in your $PATH.

yarn global add opentosca-vintner

Yarn (Modern)¶

Vintner can be installed using yarn (modern). However, this will not install Vintner permanently but only temporary.

1	`yarn dlx opentosca-vintner`

Choco¶

Vintner can be installed using choco.

choco install opentosca-vintner -y

Docker¶

Vintner can be installed using Docker. The Image is about 3GB large and contains tools, such as xOpera, Unfurl, Ansible, Terraform, and all of our examples.

GitHub Container Registry¶

Pull the latest image from the GitHub Container Registry.

1	`docker pull ghcr.io/opentosca/opentosca-vintner:latest`

Starting the Container¶

First, we create directories for persisting data.

mkdir vintner
cd vintner

mkdir data
mkdir shared

Next, we start the container.

docker run \
  --detach \
  --volume ${PWD}/data:/vintner/data \
  --volume ${PWD}/shared:/vintner/shared  \
  --network host \
  --name vintner \
  ghcr.io/opentosca/opentosca-vintner:latest

The command consists of the following aspects.

--detach starts the container in the background.
--volume ${PWD}/data:/vintner/data persists all data written by Vintner.
--volume ${PWD}/shared:/vintner/shared should be used to share data between the host and the container, e.g., CSARs or GCP credentials.
--network host uses the host network, e.g., for ipv6 support.
--name vintner is the container name.
ghcr.io/opentosca/opentosca-vintner:latest pulls the latest Docker Image

Inside the container, the following directories are of interest.

/vintner/data holds all data written by Vintner.
/vintner/shared should be used to share data between the host and the container, e.g., CSARs or GCP credentials.
/vintner/examples holds the examples directory of the repository.

Executing a Command¶

The container runs in the background. Vintner is executed as follows.

docker exec -it vintner vintner --version

On Linux, we set an alias to directly use Vintner as command in the terminal on the docker host. To persist the alias, add the alias, e.g., to ~/.bashrc (requires reloading the session).

alias vintner="docker exec -it vintner vintner"

Now, Vintner is available as follows.

1	`vintner --version`

xOpera¶

xOpera is already installed inside the container and Vintner is already correctly configured to connect to xOpera. By default, xOpera is already enabled. Enable xOpera as follows.

docker exec -it vintner vintner orchestrators enable --orchestrator xopera

Unfurl¶

Unfurl is already installed inside the container and Vintner is already correctly configured to connect to Unfurl. Enable Unfurl as follows.

docker exec -it vintner vintner orchestrators enable --orchestrator unfurl

Stopping the Container¶

Ensure to only stop Vintner, once Vintner is idle. Otherwise, data and deployments will be corrupted. Stop the container as follows.

1	`docker stop vintner`

Watching the Logs of the Container¶

Watch the logs of the container as follows.

docker logs -f vintner

Debugging the Container¶

In case we need to debug something inside the container or perform any administrative ./tasks, we can exec into the container as follows. This starts a shell inside the container.

docker exec -it vintner /bin/bash

Manual¶

Install Vintner manually by downloading the binary for your system and adding it to $PATH. There are no other dependencies required. The following example shows the installation on selected platforms and architectures.

Linux x64Linux arm64Alpine x64Windows x64

wget https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-linux-x64.xz
tar -xf vintner-linux-x64.xz
rm vintner-linux-x64.xz
mv vintner-linux-x64 /usr/bin/vintner
chmod +x /usr/bin/vintner
vintner setup init

wget https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-linux-arm64.xz
tar -xf vintner-linux-arm64.xz
rm vintner-linux-arm64.xz
mv vintner-linux-arm64 /usr/bin/vintner
chmod +x /usr/bin/vintner
vintner setup init

wget https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-alpine-x64.xz
tar -xf vintner-alpine-x64.xz
rm vintner-alpine-x64.xz
mv vintner-alpine-x64 /usr/bin/vintner
chmod +x /usr/bin/vintner
vintner setup init

First, create the directory $env:USERPROFILE\bin and add it to your PATH. We recommend to do this manually.

$userBin = "$env:USERPROFILE\bin"
if (-not (Test-Path -Path $userBin)) {
    New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\bin"
    $userPath = [System.Environment]::GetEnvironmentVariable("PATH", [System.EnvironmentVariableTarget]::User)
    $newPath = "$userPath$userBin;"
    [System.Environment]::SetEnvironmentVariable("PATH", $newPath, [System.EnvironmentVariableTarget]::User)
}

Next, install vintner.

$userBin = "$env:USERPROFILE\bin"
Invoke-WebRequest -URI https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-win-x64.exe.xz -OutFile vintner-win-x64.exe.xz
tar -xf vintner-win-x64.exe.xz
Remove-Item vintner-win-x64.exe.xz
Move-Item vintner-win-x64.exe $userBin\vintner.exe
vintner setup init

The following binaries are available:

Platform	Architecture	Binary	Archive	Signature	Checksum
Alpine	x64	link	link	link	link
Linux	arm64	link	link	link	link
Linux	x64	link	link	link	link
Windows	x64	link	link	link	link

Checksum¶

To verify the integrity of a binary, proceed as follows. The following is a walkthrough for vintner-linux-x64. We assume that vintner-linux-x64 is present in the current working directory.

wget https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-linux-x64.sha256
sha256sum --check vintner-linux-x64.sha256

Signature¶

Every binary is cryptographically signed.

Verification¶

To verify a signature of a binary, first import our public key and download the respective signature. The following is a walkthrough for vintner-linux-x64 using gpg. We assume that vintner-linux-x64 is present in the current working directory.

First, we import the public key.

curl https://vintner.opentosca.org/vintner-release.gpg | gpg --import

Next, we download the signature.

1	`wget https://github.com/opentosca/opentosca-vintner/releases/download/latest/vintner-linux-x64.asc`

Next, we verify the signature.

1	`gpg --verify vintner-linux-x64.asc`

The output should be something as follows.

gpg: assuming signed data in 'vintner-linux-x64'
gpg: Signature made Sun Oct 23 19:12:56 2022 UTC
gpg:                using RSA key 4BB862B810B792CC072D59DB964183A1485881AD
gpg: Good signature from "vintner-release" [unknown]
gpg: WARNING: This key is not certified with a trusted signature!
gpg:          There is no indication that the signature belongs to the owner.
Primary key fingerprint: 4BB8 62B8 10B7 92CC 072D  59DB 9641 83A1 4858 81AD

Public Key¶

The following public key shall be used for verifying signatures. The public key is also available as download.

pub   rsa4096/964183A1485881AD 2022-10-23 [SC]
      4BB862B810B792CC072D59DB964183A1485881AD
uid                 [unknown] vintner-release
sub   rsa4096/B230BD6651AA1BB8 2022-10-23 [E]

Last update: November 18, 2024