Skip to content

Updating

Ashton Eby edited this page Mar 27, 2019 · 5 revisions

v2.3.3 -> v3.0.0

Updating from v2 to v3 should be a minimally invasive process. To upgrade:

In the command below, replace your-lambda-artifacts-bucket-name with the name of a bucket that you manage and that already exists. Then, run:

  • sam package --template-file ./cloudformation/template.yaml --output-template-file ./cloudformation/packaged.yaml --s3-bucket your-lambda-artifacts-bucket-name

In the command below, replace your-lambda-artifacts-bucket-name with the name of a bucket that you manage and that exists. Replace custom-prefix in the command below with some prefix that is globally unique, like your org name or username. Verify that your stack is named "dev-portal", or replace "dev-portal" with the name of your stack. Then, run:

  • sam deploy --template-file ./cloudformation/packaged.yaml --stack-name "dev-portal" --s3-bucket your-lambda-artifacts-bucket-name --capabilities CAPABILITY_NAMED_IAM --parameter-overrides DevPortalSiteS3BucketName="custom-prefix-dev-portal-static-assets" ArtifactsS3BucketName="custom-prefix-dev-portal-artifacts"
  • Then, navigate to the S3 console, find the bucket named "custom-prefix-dev-portal-artifacts" (where your custom-prefix is the prefix from the above command), and download and delete all the files under /catalog. The v3.0.0 dev portal expects the swagger files in the catalog to be named in a particular format.
  • To repopulate the catalog, create an admin user and use the admin panel interface as documented in the README.

Clone this wiki locally