Skip to content

README.md

Latest commit

 

History

History
37 lines (24 loc) · 1.92 KB

README.md

File metadata and controls

37 lines (24 loc) · 1.92 KB

Proxygen-CLI usage

The Proxygen-CLI is a tool which can be used to interact with the APIM proxy layer, to deploy our OAS specification to different environments, deploy a sandbox backend and store secrets and certificates.

Pre-requisites

Install Proxygen-CLI

The proxygen-cli package currently requires Python v3.9 or greater. Note: While proxygen-cli v2.x technically supports Python 3.13, its dependency constraints still require lxml <5.0, which is incompatible with Python 3.13. For Python 3.13 users, install proxygen-cli in a separate virtual environment using Python 3.11 or 3.12 until this is resolved upstream.

pyenv install 3.11.1
pyenv virtualenv 3.11.1 proxygenenv
pyenv local 3.11.1 # if you want to switch to this env in this directory
pyenv activate proxygenenv

python --version # check the virtual env is 3.11.1
pip install proxygen-cli

AWS login

The AWS Portal for logging into the eligibility-signposting-api provides information about access keys for your respective accounts. Any secrets related to Proxygen are stored in the development environment account. You need to set up your AWS CLI with your developer credentials to use the related make commands.

Getting credentials

There are make commands available in the main Makefile:

  • retrieve-proxygen-key - this retrieves the private key for our APIM machine account and places it in ~/.proxygen/. This location is where Proxygen-CLI stores it's configuration.
  • setup-proxygen-credentials - this copies the configuration in /specification/.proxygen to ~/.proxygen/, to pre-configure Proxygen-CLI with details of our API.
  • get-spec - this retrieves the specification we have published in the API catalogue (production environment)

Further Usage

See the CLI documentation