APIIDA API Gateway Manager

Install on OpenShift (Non Helm)

Owned by Maurizio Garzelli, created
Last updated: Mar 22, 2024 by Mirco Hoffmann
2 min read

There is no mysql/mariadb image specified in the yaml.

Make sure that you have a project created for the AAGM

Remember to have the .lic aagm license at hand

 

This guide will help with installing the APIIDA API Gateway Manager (AAGM) on an OpenShift environment.

Please find attached the YAML file that you can download and use.

Instructions

  1. Request a license for the AAGM

  2. Download the yaml file.

  3. Create a certificate and a passwordless private key. There are many instructions online on how to do that, eg:

    1. https://learn.microsoft.com/en-us/azure/iot-hub/tutorial-x509-self-sign

    2. https://gist.github.com/ArnaudValensi/6e23027bd361c58a68040f80e9d6f5ab

    3. https://help.cloud66.com/maestro/how-to-guides/security/remove-passphrase.html

  4. Create a project in your OpenShift environment.

  5. Edit the yaml and replace the placeholders with the values that are required. The placeholders can be recognised because they are formatted as an xml element <example placeholder>. you will have to change the whole placeholder including the angle brackets (chevrons). The placeholders are the following:

    1. <hostname, address of the mysql/mariadb>
      This is the hostname or address of the mysql/mariadb instance that you are going to use.

    2. <base64 of the password for the database>
      This is the value of the password used by the AAGM to connect to the database. This will have to be base64 encoded before pasting it in the yaml.

    3. <clear text of the certificate>
      This is the value of the certificate generated in step 3, it is clear text, and any newline should be substituted by \r\n see herebelow for instructions

    4. <base64 of a secret, it can be the base64 of a binary>
      This is a passphrase used to encrypt data, you need to specify one, it should be an impossible-to-guess value, so it could be a binary value, you will need to encode it in base64 (even if a string) and copy it in here.

    5. <base64 of the private key (without password)>
      The base64 value of the private key generated in step 3

    6. <base64 of your AAGM license>
      Copy here the base64 encoded string of the content of the .lic license file. You can use the command base64 license.lic and coy the output.

    7. <whatever hostname needed>
      This is the public hostname of the aagm, the exposed URL hostname.

  6. use the oc command to create the project with the yaml.