Limitations de fonction

• Pas de prise en charge de l'abonnement aux producteurs d'événements.
• Pas de prise en charge de Terraform.

Comment faire en sorte que mon code soit exécuté en tant que composant fonctionnel Code Engine?

Que votre code existe en tant que source dans un fichier local ou dans un dépôt Git, ou que votre code soit un paquet de code existant situé dans un registre public ou privé, Code Engine fournit un moyen rationalisé d'exécuter votre code en tant que fonction.

• Si vous commencez avec un code source situé dans un dépôt Git, vous pouvez choisir de pointer vers l'emplacement de votre source, et Code Engine se chargera de construire le paquet de code à partir de votre source et de créer la fonction en une seule opération. Dans ce scénario, Code Engine télécharge votre code vers IBM Cloud® Container Registry Pour en savoir plus, voir Création d'une fonction à partir du code source du référentiel.

• Si vous commencez avec le code source sur un poste de travail local, vous pouvez choisir de pointer vers l'emplacement de votre source, et Code Engine se chargera de construire l'image à partir de votre source et de créer la fonction avec une seule commande CLI. Dans ce scénario, Code Engine télécharge votre code vers IBM Cloud® Container Registry Pour en savoir plus, voir Création de votre fonction à partir du code source local à l'aide de l'interface de ligne de commande.

• Si vous commencez avec du code source, vous pouvez également exécuter votre code source en ligne. Dans ce scénario, vous collez votre code source lorsque vous créez votre fonction. Pour plus d'informations, voir Création de votre fonction avec du code en ligne.

Après avoir créé et exécuté votre fonction, vous pouvez également la mettre à jour en utilisant l'une des méthodes précédentes, indépendamment de la manière dont vous l'avez créée ou mise à jour précédemment.

Que se passe-t-il lorsque j'appelle ma fonction?

Lorsqu'une fonction est appelée (démarrée), l'instance de fonction correspondante est initialisée avec les paramètres de conteneur Runtime et de ressource configurés. Le processus de la première initialisation est appelé démarrage à froid.

Pour réduire le temps d'attente de démarrage à froid, Code Engine optimise l'appel en préchauffant certains environnements d'exécution avec des configurations d'UC et de mémoire spécifiques. Les combinaisons préchauffées pour les fonctions incluent les versions Node.js 18 et Python 3.11, ainsi que la combinaison d'UC et de mémoire par défaut pour Functions, qui est 0.25 vCPU x 1 Go de mémoire. En outre, le système est conçu pour améliorer la réutilisation des instances de fonction qui sont déjà initialisées. Par conséquent, une instance de fonction est maintenue active une fois l'appel terminé pour permettre les appels suivants en réutilisant la même instance et en réutilisant l'état de l'instance à la fin du dernier appel. La réutilisation d'une instance de fonction n'est pas garantie.

Puis-je garder mon instance de fonction en vie plus longtemps?

Avec Code Engine, votre fonction augmente et baisse automatiquement en fonction de la charge de travail. Lorsque vous créez votre fonction avec la combinaison d'UC et de mémoire par défaut, votre fonction est injectée dans un conteneur "préchauffé", qui est optimisé pour être utilisé. Lorsque vous créez une fonction avec une combinaison d'UC et de mémoire autre que la combinaison par défaut, votre fonction est injectée dans un nouveau conteneur. Par défaut, ce conteneur n'est conservé actif que pendant un court laps de temps après la fin de la fonction. Pour plus d'informations, voir Combinaisons d'UC et de mémoire prises en charge pour les fonctions.

Vous pouvez modifier la durée pendant laquelle votre conteneur est maintenu actif à l'aide de l'option --scale-down-delay dans l'interface de ligne de commande ou de l'option Délai de mise à l'échelle dans la console. Notez que tout en conservant votre conteneur actif réduit les temps de démarrage à froid pour toute exécution ultérieure de votre fonction, vous êtes également facturé pour la durée d'existence du conteneur de fonction personnalisée.

Demandes et réponses

Les fonctions sont appelées avec le protocole HTTP. Lorsque vous appelez votre fonction, vous pouvez spécifier les paramètres de demande personnalisés, le corps de demande personnalisé et les en-têtes, ainsi que la méthode HTTP. Les paramètres de demande sont mis à la disposition du code de fonction en tant que paramètres d'entrée. Le code de fonction peut définir le corps de la réponse, les en-têtes de réponse et le code de réponse, qui sont renvoyés à l'appelant à partir du noeud final des fonctions.

  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}`
    }
}

Traitement et débogage des erreurs

Les appels de fonction peuvent renvoyer des erreurs système ou d'application. Par exemple, les erreurs système indiquent que le code de fonction ne s'est pas exécuté correctement, tandis que les erreurs d'application indiquent un problème dans le code de fonction lui-même.

Lorsqu'une erreur système se produit, un code de réponse HTTP similaire aux codes suivants est renvoyé.

Si Code Engine peut exécuter le code des fonctions, il répond à l'appel avec l'un des codes de statut suivants.

En tant que développeur d'une fonction, vous pouvez générer n'importe quel code de statut HTTP arbitraire, même ceux répertoriés précédemment. Par conséquent, un en-tête de réponse indique que le code de statut a été généré par le code de fonction.

Les fonctions Code Engine ajoutent les en-têtes de réponse suivants à la réponse d'appel de fonction.

Caractéristiques d'entrée/sortie des données de fonction

Pour exécuter votre fonction dans Code Engine, votre code doit implémenter un contrat d'exécution avec les caractéristiques suivantes.

• Doit être appelable à partir d'un point de terminaison d'application Web publique, afin qu'il puisse être intégré à des pages Web, puis invoqué à partir de n'importe quel Code Engine Source d'événements, un navigateur Web ou tout autre client compatible HTTPS.
• Vous devez implémenter une procédure main comme point d'entrée. La procédure main peut recevoir des paramètres d'entrée sous la forme d'une structure de données au format JSON et peut renvoyer des paramètres de sortie, également sous la forme d'une structure de données au format JSON.
• Peut recevoir un sous-chemin facultatif, de sorte que la fonction puisse implémenter différentes versions, en fonction du chemin spécifié. La procédure main de la fonction reçoit le chemin en tant que paramètre d'entrée __ce_path.
• Peut recevoir des paramètres de requête facultatifs, qui peuvent être utilisés pour configurer la fonction lors de l'exécution. La procédure main de la fonction reçoit les paramètres sous forme de paires clé-valeur dans la structure de données d'entrée au format JSON.
• Peut recevoir des en-têtes de demande, de sorte que le code client puisse spécifier des codages acceptés.
• Peut recevoir un en-tête de demande de type de contenu facultatif.
• Peut recevoir un contenu de demande (corps) facultatif, que la fonction traite lors de l'exécution. En fonction du type de contenu de demande sélectionné, la charge de données est transmise au point d'entrée principal de la fonction, sous forme codée en base 64 ou "dépliée" dans le cadre de la structure de données d'entrée JSON. Les caractères spéciaux dans les paires de valeurs de clés de l'entrée application/x-www-form-urlencoded sont des valeurs percent-encoded.
• Peut définir un code de statut HTTP arbitraire (facultatif) qui est ensuite renvoyé au client appelant.
• Peut définir des en-têtes de réponse arbitraires, tels qu'un emplacement de redirection, un codage de réponse ou des valeurs de cookie.
• Peut renvoyer un corps de réponse arbitraire avec un codage binaire ou non binaire sélectionné ; par exemple, application/octet-stream, application/json, text/*, image/* ou audio/*. Si aucun en-tête de réponse content-type n'est défini, la valeur par défaut est text/plain.
• Prend en charge les types de contenu de demande suivants: application/x-www-form-urlencoded (par défaut), text/plain, application/json, application/octet-stream, image/*, audio/*
• Ne prend pas en charge l'en-tête de demande multipart/form-data.

Options de visibilité pour une fonction Code Engine

Avec Code Engine, vous pouvez déterminer le bon niveau de visibilité pour votre fonction en définissant les points de terminaison, ou les mappages du domaine du système qui sont disponibles pour recevoir des requêtes.

Chaque fonction a une correspondance interne avec le domaine du système qui est visible par tous les composants du même projet Code Engine, mais pas à l'extérieur du projet. En plus du mappage de domaine de système interne, vous choisissez de rendre la fonction visible sur l'Internet public ou sur le réseau privé IBM Cloud.

Pour une visibilité publique ou privée, la fonction est exposée sur un point de terminaison HTTPS. Pour plus de détails sur le certificat TLS utilisé, voir Certificats TLS pour les projets Code Engine

Vous pouvez déployer votre fonction avec les niveaux de visibilité suivants:

Vous pouvez définir les paramètres de visibilité d'une fonction à partir de la console ou de l'interface de programmation lorsque vous créez, déployez ou mettez à jour votre fonction.

Options de création de fonctions

Découvrez les options que vous pouvez spécifier lorsque vous créez votre fonction. Notez que les options peuvent varier entre la console et l'interface de ligne de commande.

Remarques relatives aux quotas de fonctions

Lorsque vous utilisez des applications, des fonctions et des travaux par lots, ces ressources s'exécutent dans le contexte d'un projet Code Engine. Les quotas de ressources sont définis par projet et des limites s'appliquent aux applications, aux fonctions et aux travaux par lots.

Pour plus d'informations sur les limites dans Code Engine, voir Limites et quotas pour Code Engine.

Etapes suivantes

Maintenant que vous connaissez les concepts clés de l'utilisation des fonctions Code Engine, êtes-vous prêt à créer et à utiliser des fonctions? Voir les rubriques suivantes.

• Création de charges de travail de fonction avec du code en ligne.
• Création de charges de travail de fonction avec le code source du référentiel.
• Création de charges de travail de fonction à partir du code source local.

Pour plus d'informations sur l'utilisation des fonctions, voir les rubriques suivantes.

• Charges de travail de fonction.
• Intégration des services IBM Cloud à des liaisons de service.
• Utilisation des variables d'environnement, des configmaps et des secrets.
• Traitement des incidents liés aux fonctions.