Running Self-Managed API Gateway On VM
Last updated
Last updated
VM with Podman or Docker installed. See preparing VM
From main dashboard, select Account Settings from dropdown list menu.
Select Personal -> Tokens menu from left panel, then click Add Access Token link.
Enter following details, then click Create Access token button.
Name: Local Gateway
Scopes: Select Account Management API
Permission: Read Only
Copy the token to somewhere you can recall later. Then click I have copied the token button.
A new access token should be created.
Login to VM via SSH.
Switch to root user with this command.
Use podman to login to Red Hat Registry with your Red Hat account.
Run the APIcast container with this command. DO NOT forget to replace following vaiables:
ACCESS_TOKEN: the access token generated in 3scale above.
DOMAIN: the OpenShift cluster domain i.e. cluster-hrpdc.hrpdc.sandbox140.opentlc.com. You can use oc whoami --show-console|awk -F'apps.' '{print $2}' command to get the domain value.
Test if you can access APIcast. Replace VM_HOSTNAME with the actual VM hostname in the email after VM provisioning. Don't worry about HTTP 404 Not Found at the moment.
Sample output:
Switch to 3scale admin web console, click API link in the Products panel from the main dashboard.
Note. The reason we use the API product for demonstration is because we're running APIcast outside OpenShift cluster so if we use the Human Resource Services product then the APIcast won't be able to forward incomming reqeusts to the backend APIs due to we've configured the backend APIs using local/in-cluster URLs i.e. employee.demo.svc.cluster.local which is accessible only within OpenShift cluster.
However, the API product has a backend API configured with public URL that's accessible over internet so APIcast running on VM will be able to access the API as well.
Select Integration -> Settings menu from left panel. Then replace Production Public Base URL with http://<VM_HOSTNAME> where the VM_HOSTNAME is the hostname of VM that's running APIcast.
Scroll down to bottom of the page, then click Update Product button.
Select Integration -> Configuration menu from left panel. Then promote configuration to both Staging and Production environments.
You'll see that the Production APIcast URL gets changed to the APIcast running on VM.
Open a new tab in Postman, then enter the APIcast API Gatway URL.
Copy user_key query parameter from 3scale web console.
Append the copied user_key to the URL in Postman (DO NOT forget to add / character to the URL before append the user_key param) and click Send button. You should get response back from API Gateway.
