Limitaciones de función

• No hay soporte para suscribirse a productores de sucesos.
• No hay soporte para Terraform.

¿Cómo puedo hacer que mi código se ejecute como un componente de función Code Engine?

Tanto si su código existe como fuente en un archivo local o en un repositorio Git, como si su código es un paquete de código existente que se encuentra en un registro público o privado, Code Engine le proporciona una forma simplificada de ejecutar su código como una función.

• Si estás empezando con código fuente que se encuentra en un repositorio Git, puedes elegir apuntar a la ubicación de tu fuente, y Code Engine se encarga de construir el paquete de código desde tu fuente y crear la función con una sola operación. En este caso, " Code Engine carga su código en " IBM Cloud® Container Registry. Para obtener más información, consulte Creación de una función a partir del código fuente del repositorio.

• Si usted está comenzando con el código fuente en una estación de trabajo local, puede optar por apuntar a la ubicación de su fuente, y Code Engine se encarga de la construcción de la imagen de su fuente y la creación de la función con un solo comando CLI. En este caso, " Code Engine carga su código en " IBM Cloud® Container Registry. Para obtener más información, consulte Creación de la función a partir del código fuente local con la CLI.

• Si está empezando con el código fuente, también puede ejecutar el código fuente en línea. En este escenario, pegue el código fuente al crear la función. Para obtener más información, consulte Creación de la función con código en línea.

Después de crear y ejecutar su función, también puede actualizar su función utilizando cualquiera de las formas anteriores, independientemente de cómo haya creado o actualizado previamente su función.

¿Qué sucede cuando invoco mi función?

Cuando se invoca (inicia) una función, la instancia de función correspondiente se inicializa con el contenedor de tiempo de ejecución y los parámetros de recurso configurados. El proceso de la primera inicialización se conoce como inicio en frío.

Para reducir la latencia de inicio en frío, Code Engine optimiza la invocación precalentando determinados tiempos de ejecución con configuraciones de CPU y memoria específicas. Las combinaciones precalentadas para las funciones incluyen las versiones Node.js 18 y Python 3.11, así como la combinación de CPU y memoria predeterminada para las funciones, que es 0.25 vCPU x 1 GB de memoria. Además, el sistema está diseñado para mejorar la reutilización de instancias de función que ya están inicializadas. Por lo tanto, una instancia de función se mantiene activa una vez finalizada la invocación para permitir invocaciones posteriores reutilizando la misma instancia y reutilizando el estado de la instancia cuando se completó la última invocación. No se garantiza la reutilización de una instancia de función.

¿Puedo mantener mi instancia de función activa durante más tiempo?

Con Code Engine, la función se escala hacia arriba y hacia abajo automáticamente, en función de la carga de trabajo. Cuando se crea la función con la combinación de CPU y memoria predeterminada, la función se inyecta en un contenedor "precalentado", que se optimiza para su uso. Cuando crea una función con una combinación de CPU y memoria distinta de la combinación predeterminada, la función se inyecta en un nuevo contenedor. De forma predeterminada, este contenedor se mantiene activo sólo durante un breve periodo de tiempo después de que se complete la función. Para obtener más información, consulte Combinaciones soportadas de CPU y memoria para funciones.

Puede cambiar la cantidad de tiempo que el contenedor se mantiene activo con la opción --scale-down-delay en la CLI o la opción Retardo de escalado en la consola. Tenga en cuenta que si bien mantener activo el contenedor reduce las horas de inicio en frío para cualquier ejecución posterior de la función, también se le facturará el tiempo que existe el contenedor de función personalizada.

Solicitudes y respuestas

Las funciones se invocan con el protocolo HTTP. Al invocar la función, puede especificar los parámetros de solicitud personalizada, el cuerpo de solicitud personalizada y las cabeceras, así como el método HTTP. Los parámetros de solicitud se ponen a disposición del código de función como parámetros de entrada. El código de función puede establecer el cuerpo de respuesta, las cabeceras de respuesta y el código de respuesta, que se devuelven al interlocutor desde el punto final de funciones.

  function main(params) {
      var msg = 'You did not tell me who you are.';
      if (params.name) {
          msg = `Hello, ${params.name}!`
       } else {
          msg = `Hello, FaaS on CodeEngine!`
      }
      return {
          headers: { 'Content-Type': 'text/html; charset=utf-8' },
          body: `<html><body><h3>${msg}</h3></body></html>`
       }
  }

  module.exports.main = main;

function main(params) {
    return {
        headers: { location: 'https://cloud.ibm.com/docs/codeengine' },
        statusCode: 302
    }
}

function main(params) {
    var msg = 'You did not tell me who you are.';
    if (params.name !== "") {
        msg = `Hello, ${params.name}!`
    }
    return {
        headers: { 'Content-Type': 'text/plain;charset=utf-8' },
        body: `${msg}`
    }
}

Manejo y depuración de errores

Las invocaciones de función pueden devolver errores del sistema o de la aplicación. Por ejemplo, los errores del sistema indican que el código de función no se ha ejecutado correctamente, mientras que los errores de aplicación indican un problema en el propio código de función.

Cuando se produce un error del sistema, se devuelve un código de respuesta HTTP similar a los códigos siguientes.

Si Code Engine puede ejecutar el código de funciones, responde a la invocación con uno de los siguientes códigos de estado.

Como desarrollador de una función, puede generar cualquier código de estado HTTP arbitrario, incluso los listados anteriormente. Por lo tanto, una cabecera de respuesta indica que el código de función ha generado el código de estado.

Las funciones Code Engine añaden las siguientes cabeceras de respuesta a la respuesta de invocación de función.

Características de entrada/salida de datos de función

Para ejecutar la función en Code Engine, el código debe implementar un contrato de tiempo de ejecución con las características siguientes.

• Debe poder invocarse desde un punto final de aplicación web pública, para que pueda incrustarse en páginas web y luego invocarse desde cualquier Code Engine Fuente de eventos, un navegador web o cualquier otro cliente compatible con HTTPS.
• Debe implementar un procedimiento main como punto de entrada. El procedimiento main puede recibir parámetros de entrada en forma de una estructura de datos con formato JSON y puede devolver parámetros de salida, también en forma de una estructura de datos con formato JSON.
• Puede recibir una subvía de acceso opcional, para que la función pueda implementar diferentes tipos, basándose en la vía de acceso especificada. El procedimiento main de la función recibe la vía de acceso como un parámetro de entrada __ce_path.
• Puede recibir parámetros de consulta opcionales, que se pueden utilizar para configurar la función en tiempo de ejecución. El procedimiento main de la función recibe los parámetros como pares de clave-valor dentro de la estructura de datos de entrada con formato JSON.
• Puede recibir cabeceras de solicitud, para que el código de cliente pueda especificar codificaciones aceptadas.
• Puede recibir una cabecera de solicitud de tipo de contenido opcional.
• Puede recibir una carga útil de solicitud opcional (cuerpo), que la función procesa en tiempo de ejecución. En función del tipo de contenido de solicitud seleccionado, la carga útil de datos se pasa al punto de entrada principal de la función, ya sea en formato codificado en base 64 o "desplegado" como parte de la estructura de datos de entrada JSON. Los caracteres especiales en los pares de valores de claves de application/x-www-form-urlencoded entrada son valores percent-encoded.
• Puede definir un código de estado HTTP arbitrario (opcional) que se devuelve al cliente que lo invoca.
• Puede establecer cabeceras de respuesta arbitrarias, como por ejemplo una ubicación de redirección, una codificación de respuesta o valores de cookie.
• Puede devolver un cuerpo de respuesta arbitrario con una codificación binaria o no binaria seleccionada; por ejemplo, application/octet-stream, application/json, text/*, image/* o audio/*. Si no se establece ninguna cabecera de respuesta content-type, el valor predeterminado es text/plain.
• Da soporte a los siguientes tipos de contenido de solicitud: application/x-www-form-urlencoded (predeterminado), text/plain, application/json, application/octet-stream, image/*, audio/*
• No da soporte a la cabecera de solicitud multipart/form-data.

Opciones de visibilidad para una función Code Engine

Con Code Engine, puede determinar el nivel adecuado de visibilidad para su función mediante la definición de los puntos finales, o mapeos de dominio del sistema que están disponibles para recibir solicitudes.

Cada función tiene un mapeo interno del dominio del sistema que es visible para todos los componentes dentro del mismo proyecto Code Engine, pero no fuera del proyecto. Además de la correlación interna del dominio del sistema, puede optar por hacer que la función sea visible para la red pública de Internet o para la red privada de IBM Cloud.

Para una visibilidad pública o privada, la función se expone en un extremo HTTPS. Para obtener más información sobre el certificado TLS que se utiliza, consulte Certificados TLS para proyectos Code Engine.

Puede desplegar la función con los siguientes niveles de visibilidad:

Puede establecer la configuración del punto final para la visibilidad de una función desde la consola o con la CLI cuando cree y despliegue, o actualice su función.

Opciones para crear funciones

Conozca las opciones que puede especificar al crear su función. Tenga en cuenta que las opciones pueden variar entre la consola y la CLI.

Consideraciones sobre las cuotas de funciones

Cuando trabaja con aplicaciones, funciones y trabajos por lotes, estos recursos se ejecutan en el contexto de un proyecto Code Engine. Las cuotas de recursos se definen por proyecto y se aplican límites para aplicaciones, funciones y trabajos por lotes.

Para obtener más información sobre los límites de Code Engine, consulte Límites y cuotas de Code Engine.

Próximos pasos

Ahora que está familiarizado con los conceptos clave de trabajar con las funciones de Code Engine, ¿está preparado para crear y trabajar con funciones? Consulte los temas siguientes.

• Creación de cargas de trabajo de función con código en línea.
• Creación de cargas de trabajo de función con código fuente de repositorio.
• Creación de cargas de trabajo de función a partir del código fuente local.

Para más información sobre cómo trabajar con funciones, consulte los siguientes temas.

• Cargas de trabajo de función.
• Integración de servicios de IBM Cloud con enlaces de servicio.
• Trabajar con variables de entorno, mapas de configuración y secretos.
• Resolución de problemas de funciones.