Documentation

Recent changes

Installing KrakenD Enterprise

KrakenD Enterprise is delivered in several formats, including Docker, Linux packages (deb, rpm) and generic installation options.

Find your KrakenD License email
To download any Enterprise binaries, check your inbox and find our license activation email with the certificates to access the Enterprise content. Don’t have one? Ask for a trial version

Pre-requisites

Part of the private content you will need to run KrakenD Enterprise is stored in AWS or Azure. It doesn’t mean that you need to work with any of these two providers in production, they purely serve us as a hosting solution for our files and artifacts.

Installation using AWS CLI

You need to install the AWS CLI in your development machine (not the final KrakenD server)

The AWS credentials that you received by email need to be stored under ~/.aws/credentials. The file might looks like this (fake credentials below):

[default]
aws_access_key_id = AKIAQYWA47SCCDSQLWAN
aws_secret_access_key = xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

If you already have credentials, add another named profile.

Installation using Azure CLI

For installations on Azure platform:

  1. Install Azure CLI
  2. Login to Azure with az login
  3. When the browser opens, use the credentials you have received from KrakenD

Docker

If you are already familiar with Docker, the easiest way to get started is by pulling our KrakenD image from Azure or AWS. As the repositories are private, you need to provide the credentials we sent.

From Amazon ECR

To pull our Docker image from AWS, you need to:

  1. Install the AWS CLI and add the credentials we provided
  2. Login to ECR
  3. Pull the container
  4. Push it to your registry

Login to ECR

Depending on which version of the AWS CLI you have installed you might need one of these two commands:

AWS CLI v2:

Login to ECR with AWS CLI v2 
$aws ecr get-login-password --region us-east-1 | \ 
     docker login --username AWS --password-stdin \ 
     052351007912.dkr.ecr.us-east-1.amazonaws.com 

AWS CLI v1:

Login to ECR with AWS CLI v1 
$$(aws ecr get-login --region us-east-1 --no-include-email) 

Pull the image and push to your registry

Running KrakenD using the Docker container 
$docker pull 052351007912.dkr.ecr.us-east-1.amazonaws.com/krakend-ee:2.0.3 

If you have a corporate Docker registry you might want to push the image locally:

Running KrakenD using the Docker container 
$docker tag 052351007912.dkr.ecr.us-east-1.amazonaws.com/krakend-ee:2.0.3 youregistry.com/krakend-ee:2.0.3 
docker push youregistry.com/krakend-ee:2.0.3 

From Azure Container Registry

To pull our Docker image from Azure, you need to:

  1. Install Azure CLI
  2. az acr login --name krakend
  3. docker pull krakend.azurecr.io/krakend-ee:2.0.3

After these commands you will have in your local computer the krakend enterprise container. You can push it to your own ACR or use it locally.

Mac installation

The Mac installation requires downloading a zipped package and uncompressing its content. Your Macintosh should be relatively new, using an M1 processor (ARM64).

With the AWS credentials provided by krakend, make a folder under /opt/krakendand download the package:

Download the package 
$mkdir krakend 
cd krakend 
aws s3 cp s3://download.enterprise.krakend.io/bin/krakend-ee_2.0.3_osx-arm64.tar.gz . 

And then uncompress it and move it to a location of your choice, e.g.:

Uncompress the file 
$tar xvfz krakend-ee_2.0.3_osx-arm64.tar.gz 

Uncompressing produces two items:

  • The krakend binary
  • The plugins folder.

You can move the krakend binary to /usr/local/bin to have it available anywhere (or somewhere else under your $PATH):

Move krakend to PATH 
$sudo mv krakend /usr/local/bin/krakend 

By default, KrakenD documentation locates plugins under /opt/krakend/plugins but you can leave them where they are or use any other location as long as you specify the path on the configuration. If you want to use the defaults:

Move krakend to PATH 
$sudo mkdir -p /opt/krakend 
sudo mv plugins /opt/krakend/ 

Linux installation (without Docker)

The installation process requires going through these steps:

  1. Copy the LICENSE and LICENSE.key to the server
  2. Download and copy the certificate chain
  3. Setup the KrakenD repository
  4. Install KrakenD
  5. Start the KrakenD service

Download the certificate and copy your license

Once the AWS CLI is installed and configured with the credentials we provided by email, the first step to all Linux flavours is to download the certicate chain from our repository. :

Downloading the CA chain 
$aws s3 cp s3://download.enterprise.krakend.io/krakend-ca-chain.pem . 

Now copy the certificate and licenses to the server. Replace [email protected] with your actual username and IP address:

ssh [email protected] mkdir -p /etc/krakend/
scp krakend-ca-chain.pem [email protected]:/etc/krakend/krakend-ca-chain.pem
scp LICENSE [email protected]:/etc/krakend/LICENSE
scp LICENSE.key [email protected]:/etc/krakend/LICENSE.key

Debian and Ubuntu (apt)

SSH in the machine and create a config file in /etc/apt/apt.conf.d/99krakend with this content:

cat << EOF > /etc/apt/apt.conf.d/99krakend
Acquire::https::repo.enterprise.krakend.io {
    CaInfo "/etc/krakend/krakend-ca-chain.pem";
    SslCert "/etc/krakend/LICENSE";
    SslKey  "/etc/krakend/LICENSE.key";
};
EOF

Make sure the three files LICENSE, LICENSE.key, and krakend-ca-chain.pem exist in /etc/krakend.

Run the following commands:

apt-get install -y gnupg ca-certificates
apt-key adv --keyserver keyserver.ubuntu.com --recv 5DE6FD698AD6FDD2
echo "deb https://repo.enterprise.krakend.io/apt stable main" | tee /etc/apt/sources.list.d/krakend-ee.list
apt-get update
apt-get install -y krakend-ee

Now the krakend command is available in the system.

KrakenD should run on old systems too, at least from Debian 8 and Ubuntu 16.x

CentOS, Oracle Linux, and Redhat (yum)

The RPM file can be downloaded from here:

aws s3 cp s3://download.enterprise.krakend.io/krakend-ee-repo-1.0-2.x86_64.rpm .

Make sure the three files LICENSE, LICENSE.key, and krakend-ca-chain.pem exist in /etc/krakend.

Then install and start the latest version of KrakenD with:

rpm -Uvh krakend-ee-repo-1.0-2.x86_64.rpm
yum install krakend-ee
systemctl start krakend-ee

Manual Linux install

You can also download a tar.gz and decompress it anywhere. Instructions to check the SHA and PGP signature here

Download:

aws s3 cp s3://download.enterprise.krakend.io/bin/krakend-ee_2.0.3_amd64.tar.gz .
aws s3 cp s3://download.enterprise.krakend.io/bin/krakend-ee_2.0.3_amd64.tar.gz.sha256 .
aws s3 cp s3://download.enterprise.krakend.io/bin/krakend-ee_2.0.3_amd64.tar.gz.asc .

Uncompress:

tar xvfz krakend-ee_2.0.3_amd64.tar.gz

Once you have downloaded the binary, you should move the contents to each folder. You will need root permissions or add sudo to some of these commands:

mv usr/bin/krakend /usr/local/bin/krakend
mkdir -p /opt/krakend/
mv plugins /opt/krakend
chmod +x /usr/local/bin/krakend

Now you can type krakend.

To stop KrakenD graceful use any of these two commands:

killall -s SIGTERM krakend
killall -s SIGINT krakend

Unresolved issues?

The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.

We use cookies to understand how you use our site and to improve your overall experience. By continuing to use our site, you accept our Privacy Policy. More information