This section explains how to install Gravitee API Management (APIM) on Red Hat Enterprise Linux, CentOS Linux, or Oracle Linux using the yum
package manager.
{% hint style="warning" %} RPM install is not supported on distributions with old versions of RPM, such as SLES 11 and CentOS 5 — in this case, you need to install APIM with .zip instead. {% endhint %}
Amazon Linux instances use the package manager yum
. The steps below show how to use yum
to set up access to Gravitee's repository containing the APIM components.
- Create a file called
/etc/yum.repos.d/graviteeio.repo
using the following command:
{% code title="/etc/yum.repos.d/graviteeio.repo" %}
sudo tee -a /etc/yum.repos.d/graviteeio.repo <<EOF
[graviteeio]
name=graviteeio
baseurl=https://packagecloud.io/graviteeio/rpms/el/7/\$basearch
gpgcheck=0
enabled=1
gpgkey=https://packagecloud.io/graviteeio/rpms/gpgkey
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
metadata_expire=300
EOF
{% endcode %}
- Enable GPG signature handling (required by some of Gravitee's RPM packages) by installing the following packages. In many cases, these packages will already be installed on your Amazon Linux instance.
sudo yum install pygpgme yum-utils -y
- Refresh the local cache:
{% code overflow="wrap" %}
sudo yum -q makecache -y --disablerepo='*' --enablerepo='graviteeio'
{% endcode %}
You can choose to install the full APIM stack or install the components one by one:
- Install the full APIM stack (includes all components below)
- Install APIM Components
For version 4.1.4 and above, you can upgrade and restart APIM to perform an rpm
upgrade of APIM components.
{% hint style="warning" %} Refer to the changelog to follow potential breaking changes. {% endhint %}
The appropriate upgrade process depends on the type of installation:
- Upgrade the full APIM stack
- Upgrade APIM Components
To install the Enterprise Edition of APIM requires a license key.
{% hint style="info" %} For information on obtaining a license key, visit the Gravitee pricing page. {% endhint %}
Users can directly provide the base64-encoded enterprise license with the GRAVITEE_LICENSE_KEY
environment variable.
The default location of the EE license file license.key
is the GRAVITEE_HOME/license/license.key
directory. To override this with a different location, provide the absolute path to the license file using the -Dgravitee.license
property in the gravitee.yml
file, e.g., gravitee_license: /path/to/my/own_license.key
.
To locate the license.key
, both the Gateway
and Management API
components use the following search sequence:
- The component will first look for the
GRAVITEE_LICENSE_KEY
environment variable - If it cannot find the
GRAVITEE_LICENSE_KEY
environment variable, the component will look for an absolute path to the license file in thelicense
property ofgravitee.yml
- If the license property is not set in the
gravitee.yml
file, the component will try to retrieve the key from the default locationGRAVITEE_HOME/license/license.key