Update install.md

[SayefReyadh]

Configuration to deploy AWS Lambda using serverless, esbuild and serverless-esbuild

[lovell]

Hi, thanks for the PR.

Did you see the existing section about esbuild that provides information about excluding sharp from a build?

https://sharp.pixelplumbing.com/install#esbuild

This section in the sharp docs is more generally about code bunders rather than being specific to deployment, so I'm not sure details of using downstream deployment tools fits here.

Maybe we should add a sentence to the existing Lambda section highlighting that those using a code bundler should read the Bundlers section?

https://sharp.pixelplumbing.com/install#aws-lambda

[SayefReyadh]

Hi, thanks for the PR.

Did you see the existing section about esbuild that provides information about excluding sharp from a build?

https://sharp.pixelplumbing.com/install#esbuild

This section in the sharp docs is more generally about code bunders rather than being specific to deployment, so I'm not sure details of using downstream deployment tools fits here.

Maybe we should add a sentence to the existing Lambda section highlighting that those using a code bundler should read the Bundlers section?

https://sharp.pixelplumbing.com/install#aws-lambda

Prior to my development, I came across this issue when trying to deploy from my local environment win32-x64 with serverless-esbuild for bundling and serverless deploy and faced similar issues described here #3126. I presume as it tries to bundle the package locally maybe that is why.

• I will update the PR and move the comments below aws-lambda sections with bundler information as it makes more sense as we are trying to deploy on AWS-Lambda.

On this note, I did try to follow the aws-lambda instructions while local deployment with serverless-esbuild but it was unable to bundle the with sharp-linux-x64.node even if the file contains inside the node_modules. The webpack solution discussed here #2230 helped better understand how to resolve the serverless-esbuild issue.

For automatic deployment, we use CodeBuild from AWS and no other configurations were needed for me.

[lovell]

Thank you for the update, I've left some questions inline.

[lovell]

Does sharp need to be listed under externals on Linux x64 machines too? If so, the wording is a little ambiguous.

[SayefReyadh]

Need some investigations for this case, if it's required for linux x64 machines as well. So far, in my initial dev deployment, I have configured the following way and it was stable with this configuration.

[SayefReyadh]

@lovell It does not work if sharp is not put under external with esbuild. Btw, while testing it seems the above setup does not work for v0.30.5.

Currently, I am using v0.30.3 and under the esbuild script tag I have given - npm install --arch=x64 --platform=linux [email protected] to match the version. When I tried to update it with v0.30.5 for both package.json and serverless.yml and run the deployment, the was lambda again started saying something is wrong with the installation "Cannot find module '../build/Release/sharp-linux-x64.node'"

If you have some free time, can you look into this as well. Maybe I am doing something wrong here on my setup. Currently I am using the following versions.

dependencies
    "sharp": "^0.30.3",
    
devDependencies
    "serverless": "^3.16.0",
    "serverless-offline": "^8.4.0",
    "esbuild": "^0.14.38",
    "serverless-esbuild": "^1.26.2",
    "@types/sharp": "^0.30.0",

[lovell]

Thank you!

[cauboy]

For me the esbuild configuration for serverless-esbuild from the docs didn't work.

After running serverless package the arm file ended up in the node_modules folder of the .zip file.

What worked for me was the following configuration:

# serverless.yml
custom:
  esbuild:
    bundle: true
    external:
      - sharp
    installExtraArgs:
      - '--arch=x64'
      - '--platform=linux'

Version of serverless-esbuild:
"serverless-esbuild": "^1.33.0",