Volcano Engine Function as a Service
Volcano Engine Function as a Service
Document
- Documentation
Volcano Engine Function as a ServiceUser guideCloud sandboxSandbox applicationSandbox applications management
Copy page
Download PDFSandbox application
Sandbox applications management
Copy pageDownload PDFSandbox applications management
A sandbox application is the fundamental unit of a cloud sandbox, which is used for managing resource scheduling and operation. This topic mainly describes how to create, use, and manage cloud sandbox applications in the veFaaS console.
Creating sandbox applications
Prerequisites
- An API Gateway (APIG) instance and corresponding services (domain names) have been created to expose the application endpoint. For details, see Creating instances and Creating services.
- (Optional) The custom images you need are already uploaded to the Volcano Engine Container Registry (CR). For details, see Pushing and pulling docker images.
- (Optional) The Volcano Engine Torch Log Service (TLS) has been activated. If you need to use a custom logging project to handle function logs, ensure that the project and topics have already been created. For details, see Creating log projects and Creating log topics.
- (Optional) The Volcano Engine Virtual Private Cloud (VPC) service has been activated, and a VPC, subnets, and security groups have been created in the region where the function is to be deployed. For details, see Creating VPCs, Creating subnets, and Creating security groups.
- (Optional) Read Mounting TOS for instructions related to Torch Object Storage (TOS).
- Optional: Read Mounting NAS file storage for instructions related to NAS file storage.
Procedure
- Log in to the veFaaS console.
- In the top navigation bar, select the target region.
- In the left navigation bar, click Cloud sandbox > Sandbox app. Then, click Create sandbox app.
- On the Create sandbox applications page, specify parameters according to the following instructions.
- ParameterDescriptionBasic informationNameSpecify a custom name for the sandbox application. The sandbox application name must be unique within the same account. The name cannot be modified after being created.DescriptionEnter the description of the sandbox application. It can be left empty.For sandbox imagesContainer imageDeploy sandbox applications by using container images:
- Public image: The ready-to-use public images provided by default.
- Custom images: The custom images that are already preheated. You can filter images by ID or address.
Startup commandEnter a start command for the application. If you need to specify a script file, use an absolute path and make sure that the script file has executable permissions.tip- If you set the Container image parameter to Public image, veFaaS will provide the default start command based on the selected image. You can modify the command if necessary.
- If you set the Container image parameter to Custom images: veFaaS will automatically parse the configuration file of the target image to obtain the start command. You can modify it if necessary.
Listening portEnter the port that the HTTP server listens on.warning- Avoid using the ports that are already occupied by veFaaS: 9000, 9001, 9990.
- The enabled HTTP server needs to listen on 0.0.0.0:Port or *:Port. Otherwise, a request timeout error will occur.
Gateway routing configurationDomain typeThe domain type of the sandbox application. Valid values:- Unified domain: All the instances in a sandbox application share the same domain name. You can target a specific instance by including the x-faas-instance-name header or the faasInstanceName query parameter in requests.
- Wildcard domain: [Beta - apply for trial] Each sandbox instance can have a separate access address.
APIG instanceSelect an APIG instance. The sandbox application will use an APIG instance as the traffic entrance.Gateway serviceSelect the service that corresponds to the APIG instance.Route nameSpecify a custom route name. The route name cannot be modified after being created.PathSet a request path through which the sandbox application can be accessed. It can be matched only by a prefix and must start with a forward slash (/).Route authenticationConfigure route authentication for the APIG instance to ensure the route security of the sandbox application.- Disable: Authentication is disabled by default. You can manually enable Key Auth as needed. For detailed operations, see API Key authentication and authorization.
- Key Auth: Use the Key Auth add-on on APIG to implement API Key-based authentication and authorization.
- After selecting Key Auth, you also need to perform authentication configuration, which means that you need to select the location of the Key Auth information.
- header: Add Key Auth information in the request header. The default source is Authorization.
- querystring: Add Key Auth information in the request parameters. The default source is token.
tipWhen you use Key Auth, the APIG instance version must be v3.1 or later. If the version does not meet your business requirements, you can submit an APIG ticket or contact your Volcano Engine account manager to upgrade the instance version.Environment variablesEnvironment variablesConfigure custom environment variables, which can be directly read during the runtime of the function code.tipIf you set the Container image parameter to Custom images, veFaaS will automatically parse the configuration file of the target image to obtain the environment variables for the image. You can modify it if necessary.Advanced settings
- Read and select the checkbox of Function Service Terms of Service and Function Service Product Service Level Agreement, and then click Confirm to create the sandbox application.
Managing sandbox applications
After creating a sandbox application, you can view its basic information, monitoring information, and logs. You can also manage it and set queries per minute (QPM) for the API that creates sandbox instances.
- Log in to the veFaaS console.
- In the top navigation bar, select the target region.
- In the left navigation bar, click Cloud sandbox > Sandbox app.
- On the Sandbox app page, view information about the sandbox application.
-
- Find a sandbox application and click the application name to go to the details page.
- Top of the details page
- You can release or delete the application in the upper-right corner of the details page.
- Basic information
-
- For sandbox instances
-
- Update log
-
- Monitoring
- You can view or configure monitoring for sandbox applications. For details, see Monitoring and logs.
- Logging
- You can view the logs of the sandbox application. For details, see Monitoring and logging.
Testing sandbox applications
The following content will use an image named sandbox-fusion and tagged as Code type as an example to demonstrate how to test a sandbox application.
Testing by using APIG
Execute the curl command locally to call the API to test the cloud sandbox application. You can specify instance requests by using x-faas-insatnce-name.
- Replace https://****.apigateway-cn-beijing.volceapi.com with the actual access address of your cloud sandbox function.
- Replace the value of data as needed.
tip
- If you are usingvefaas-public/sandbox-fusion, read the open-source document Sandbox fusion and then replace the value of the data parameter.
- If you are using a custom image, specify the value of the data parameter according to the actual requirements.
-
Performing testing by using Playground
- On the details page of the sandbox application, go to the Basic information tab and find the Gateway routing configuration section, where you can view the access address of the application.
- On the Sandbox Fusion page, click the Playground tab and then click Sandbox in the left navigation bar.
- In the Code textbox, select a programming language and enter your code, and then click Submit to submit the code.
- After the code is run, view the result.
Last updated: 2026.08.19 14:06:07
All rights reserved © Beijing Volcano Engine Technology Co., Ltd2024
