Skip to content

Setting up parameters

Orestis Gkorgkas edited this page Apr 26, 2019 · 15 revisions

Required parameters

For deploying the service we need to store in AWS System Manager's (Parameter Store)[https://github.com/BIBSYSDEV/pipeline-builder-docs/blob/master/parameter-store.jpeg] the following parameters:

  • INFRASTRUCTURE_URL : The URL from which our service will be available. e.g. infr.my-service.unit.no.
    • Important!! A valid URL must end with a dot!
  • HOSTED_ZONE_NAME : The name of the Route53 hosted zone used in this account
    • Important!! A valid hosted zone name must end with a dot!
  • SWAGGER_API_OWNER : SwaggerHub username or organization name
  • INFRASTRUCTURE_SWAGGER_API_ID : SwaggerHub API id
    • This is an arbitrary name (id) for showing the deployed API in SwaggerHub
  • INFRASTRUCTURE_CERTIFICATE_ARN: The ARN of a certificate stored in Certificate Manager

In case you do not want to set-up a static URL you should still setup the parameters with dummy values. For example

  • INFRASTRUCTURE_URL : NOURL.
  • HOSTED_ZONE_NAME : NOZONE. (Do not forget the ".")
  • INFRASTRUCTURE_CERTIFICATE_ARN: NOCERT
  • SWAGGER_API_OWNER : SwaggerHub username or organization name
  • INFRASTRUCTURE_SWAGGER_API_ID : SwaggerHub API id

Important!

You should not edit a parameter, because each edit generates a new version of the parameter. The service looks only at the first version of each parameter. If you want to change the value of a parameter you have to delete and re-create the parameter

Note: Be sure to save the parameters in the correct AWS Region!

Clone this wiki locally