tencent cloud

Use a dependency management tool such as npm to install the dependencies locally and upload them together with the function code.

Note

When you package them, the function entry file needs to be put in the root directory of the zip package. If you package the entire folder as the zip package and upload it, function creation will fail because the entry file cannot be found in the root directory after decompression.

1. Run the mkdir test-package command in the local terminal to create a directory for storing the function code and dependency libraries.
2. Run the following command to install the lodash dependency library in this directory.
   

   cd test-package
   npm install lodash
   

3. Create the function entry file index.js in this directory and import the lodash library in the code.
   

   'use strict';
   const _ = require('lodash');
   exports.main_handler = async (event, context) => {
       console.log("Hello World")
       console.log(event)
       console.log(event["non-exist"])
       console.log(context)
       return event
   };
   

4. Compress the function code and dependency libraries into a zip package, upload the package in the SCF console, and create a function in the following steps:
   1. Log in to the SCF console and click Function Service on the left sidebar.
   2. Select the region where to create a function at the top of the page and click Create to enter the function creation process.
   3. Enter the basic information of the function on the Create Function page as shown below:
      
      • Creation Method: select Custom Creation.
      • Runtime Environment: select Node.js 12.16.
      • Submitting Method: select Local ZIP file.
   4. Click Complete.

The Node.js runtime provides an online dependency installation feature, which can install dependencies online according to the dependency information configured in package.json. For more information, please see Online Dependency Installation.

Serverless Web IDE, SCF's online editor, provides a terminal feature and builds the package management tool npm in the terminal. This document takes installing the lodash library in the terminal as an example:

1. Log in to the SCF console and select Function Service on the left sidebar.
2. In the function list, click a function name to enter the function details page.
3. On the Function Management page, select Function Code > Edit Code to view and edit the function.
4. Select Terminal > New Terminal on the topbar of the IDE to open the terminal window.
5. Run the following command in the terminal to install the lodash dependency library:
   

   cd src  # The dependency library needs to be installed in a directory at the same level as the function entry file, that is, you need to enter the `src` directory before installing the dependency.
   npm install lodash
   

6. After the installation is completed, view package.json and node_modules in the file tree on the left side of the IDE.
7. After you click Deploy, the dependency library can be packaged and uploaded to the cloud together with the function code.

Use a dependency management tool such as pip to install the dependencies locally and upload them together with the function code.

Note

• When you package them, the function entry file needs to be put in the root directory of the zip package. If you package the entire folder as the zip package and upload it, function creation will fail because the entry file cannot be found in the root directory after decompression.
• For different runtime environment configurations, you can replace pip with pip3 or pip2 by yourself.
• The function runtime environment is CentOS 7, and you need to install the dependencies in the same environment. If not, an error where the dependencies cannot be found may occur while running the function after upload. You can install dependencies as instructed in SCF Container Image or by using the online IDE.
• If some dependencies involve a dynamic link library, you need to manually copy the relevant dependency package to the dependency installation directory before packaging and uploading them. For more information, please see Installing Dependency with Docker. You can also use the online IDE for installation.

1. Run the mkdir test-package command in the local terminal to create a directory for storing the function code and dependency libraries.
2. Run the following command to install the numpy dependency library in this directory.
   

   cd test-package
   pip install numpy -t .
   

3. Create the function entry file index.py in this directory and import the numpy library in the code.
   

   # -*- coding: utf8 -*-
   import json
   import numpy
   def main_handler(event, context):
       print("Received event: " + json.dumps(event, indent = 2)) 
       print("Received context: " + str(context))
       print("Hello world")
       return("Hello World")
   

4. Compress the function code and dependency libraries into a zip package, upload the package in the SCF console, and create a function in the following steps:
   1. Log in to the SCF console and click Function Service on the left sidebar.
   2. Select the region where to create a function at the top of the page and click Create to enter the function creation process.
   3. Enter the basic information of the function on the Create Function page as shown below:
      
      • Creation Method: select Custom Creation.
      • Runtime Environment: select Python 3.6.
      • Submitting Method: select Local ZIP file.
   4. Click Complete.

Serverless Web IDE, SCF's online editor, provides a terminal feature and builds the package management tool pip in the terminal. This document takes installing the numpy library in the terminal as an example:

1. Log in to the SCF console and select Function Service on the left sidebar.
2. In the function list, click a function name to enter the function details page.
3. On the Function Management page, select Function Code > Edit Code to view and edit the function.
4. Select Terminal > New Terminal on the topbar of the IDE to open the terminal window.
5. Run the following command in the terminal to install the numpy dependency library:
   

   cd src  # The dependency library needs to be installed in a directory at the same level as the function entry file, that is, you need to enter the `src` directory before installing the dependency.
   pip install numpy -t .
   

6. After the installation is completed, view the installed dependency libraries in the file tree on the left side of the IDE.
7. After you click Deploy, the dependency library can be packaged and uploaded to the cloud together with the function code.
   

   Note

   • You can run pip freeze > requirements.txt to generate the requirements.txt files for all dependencies in the local environment.
   • Run pip install -r requirements.txt -t . in the terminal of the IDE to install the dependency package according to the configuration in requirements.txt.

Use a dependency management tool such as Composer to install the dependencies locally and upload them together with the function code.

Note

When you package them, the function entry file needs to be put in the root directory of the zip package. If you package the entire folder as the zip package and upload it, function creation will fail because the entry file cannot be found in the root directory after decompression.

1. Run the mkdir test-package command in the local terminal to create a directory for storing the function code and dependency libraries.
2. Create composer.json under test-package and specify the dependency library and version to be installed.
   

   {
   "require": {
   "requests": ">=1.0"
   }
   }
   

3. Run the following command to install the requests dependency library in this directory.
   

   cd test-package
   composer install
   

4. Create the function entry file index.php in this directory and import the requests library in the code.
   

   <?php
   require 'vendor/autoload.php';
   function main_handler($event, $context) {
      return "hello world";
   }
   ?> 
   

5. Compress the function code and dependency libraries into a zip package, upload the package in the SCF console, and create a function in the following steps:
   1. Log in to the SCF console and click Function Service on the left sidebar.
   2. Select the region where to create a function at the top of the page and click Create to enter the function creation process.
   3. Enter the basic information of the function on the Create Function page as shown below:
      
      • Creation Method: select Custom Creation.
      • Runtime Environment: select PHP 7.
      • Submitting Method: select Local ZIP file.
6. Click Complete.

Create the extension folder php_extension in a directory at the same level as the function entry file, add the custom extension file .so and configuration file php.ini, and package and upload them together with the function code.

This document uses installing the custom extension swoole.so for PHP 7 as an example.

1. Run the mkdir test-package command in the local terminal to create a directory for storing the function code and dependency libraries.
2. Run the following command to create the folder php_extension in test-package and place the configuration file php.ini and extension file .so corresponding to the extension in this directory. The directory structure is as follows:
   

   Note

   • The extension folder php_extension and configuration file php.ini are given fixed names. If other names are used, the extension may fail to load.
   • The extension folder php_extension, the configuration file php.ini, and the custom extension file .so need to have executable permissions.

   
   

   |____php_extension
   | |____php.ini
   | |____swoole.so
   |____index.php  
   

3. Custom extensions can be loaded from the code or layers. If an extension is uploaded as a layer, please make sure that the unzipped directory structure of the uploaded zip file is as follows:
   

   |____php_extension
   | |____swoole.so
   

4. php.ini writing method:
   • The extension is in the code directory:
     

     extension=/var/user/php_extension/swoole.so
     

   • This extension is in the layer directory:
     

     extension=/opt/php_extension/swoole.so
     

5. Create the function entry file index.php in this directory. Check whether the extension is loaded successfully through the extension_loaded( ) function, and if so, true will be returned; otherwise, false will be returned.
   

   <?php
   function main_handler($event, $context) {
        var_dump(extension_loaded('swoole'));
      return "hello world";
   }
   ?> 
   

6. Compress the function code and dependency libraries into a zip package, upload the package in the SCF console, and create a function in the following steps:
   1. Log in to the SCF console and click Function Service on the left sidebar.
   2. Select the region where to create a function at the top of the page and click Create to enter the function creation process.
   3. Enter the basic information of the function on the Create Function page as shown below:
      
      • Creation Method: select Custom Creation.
      • Runtime Environment: select PHP 7.
      • Submitting Method: select Local ZIP file.
7. Click Complete.