fermyon / developer

This is the home for developer.fermyon.com
https://developer.fermyon.com
Apache License 2.0
53 stars 69 forks source link

Add "Troubleshooting Tips" page for Fermyon Cloud that includes CLI error response codes #1269

Open macolso opened 5 months ago

macolso commented 5 months ago

In the case that a user's deployment or upgrade fails, it would be helpful to be able to direct that user to official developer.fermyon.com documentation that includes step-by-step instructions on how to resolve that issue, as well as a table reference of common CLI error codes from the spin cloud plugin.

See Cloudflare for example

flynnduism commented 5 months ago

Thanks @macolso. Some examples of errors that are sometimes surfaced in failed spin deployments.

As a user who runs into these problems from time to time, there is no place in our docs that lists/explains these responses, so there's no guidance to the user. Given how these deploys bring together many pieces, having a "broad strokes" explanation or direction of the root of the issue would be amazing (i.e. the error is likely a Spin issue, user error, cloud-plugin, nimbus, an SDK etc)

Example CLI responses we see today

Application deployed, but Spin could not establish readiness
Caused by:
    0: failed to read input file
    1: No such file or directory (os error 2)
Error: exit status: 1
Error: cannot push Spin application

Caused by:
    Server error: url https://registry.cloud.fermyon.com/v2/cloud-config/blobs/uploads/, code: 500, message:
Deploying...
Error: Unable to create app

Caused by:
    response status code: 500 Internal Server Error

Learn more at https://developer.fermyon.com/cloud/faq
Error: cannot push Spin application

Caused by:
    Server error: url https://registry.cloud.fermyon.com/v2/fermyon-www/manifests/0.3.0-rf2403829, code: 405, message: {"errors":[{"code":"UNSUPPORTED","message":"Invalid parameter at 'ImageManifest' failed to satisfy constraint: 'Limit on number of layers per image exceeded'"}]}

Learn more at https://developer.fermyon.com/cloud/faq
Error: cannot push Spin application

Caused by:
  Server error: url https://registry.cloud.fermyon.com/v2/fermyon-www-pr-809/blobs/uploads/, code: 401,