Abonnement aux évènements IBM Cloud Object Storage pour une application à partir de la console

Vous pouvez créer et mettre à jour des abonnements d’évènements IBM Cloud Object Storage pour une application à partir de la console.

Avant de commencer

• Créez un projet.
• Créez une application. Par exemple, créez une application appelée myapp qui utilise l'image icr.io/codeengine/cos-event. Cette image est issue de cos-listen.go, disponible dans le dépôt « Samples for IBM Cloud Code Engine » GitHub.

Suivez les étapes suivantes pour créer et mettre à jour un abonnement d’évènement IBM Cloud Object Storage pour une application à partir de la console.

1. Depuis la page « Projets » d' Code Engine, accédez à votre projet.

2. Sur la page Présentation, cliquez sur Abonnements à des événements.

3. Sur la page Abonnements à des événements, cliquez sur Créer pour créer votre abonnement.

4. Dans la page Créer un abonnement d’évènement, procédez comme suit.

   1. Pour leType d’évènement, sélectionnez la mosaïque Cloud Object Storage. Cliquez sur Suivant.
   2. DansGénéral, fournissez un nom pour l'abonnement Object Storage , par exemple, mycos. Vous pouvez le cas échéant fournir des attributs d'événement. Notez que si le consommateur d’évènements Object Storage est une application, les attributs d'évènement sont disponibles en tant qu'en-têtes HTTP. Si le consommateur d'événement est un travail, les attributs de l'événement sont disponibles sous forme de variables d'environnement. Cliquez sur Suivant pour continuer.
   3. Pour desDétails sur le compartiment de l'évènement, sélectionnez ou entrez le nom d'un compartiment Object Storage existant. Indiquez les types de modification de votre objet et indiquez éventuellement un préfixe ou un suffixe de nom d'objet pour filtrer les objets dans le compartiment qui doivent déclencher des évènements pour l'abonnement. Cliquez sur Suivant pour continuer.
   4. Pour leConsommateur d’évènement, spécifiez l'application qui va recevoir les évènements. Notez que vous pouvez faire un choix dans une liste d'applications et de travaux définis. Pour cet exemple, utilisez l'application myapp qui référence l'image icr.io/codeengine/cos-listen. Si votre application n'existe pas, vous pouvez fournir le nom de votre application et créer votre application après avoir créé l'abonnement Object Storage . Pour les applications uniquement, vous pouvez le cas échéant spécifier un chemin. Par défaut, les événements sont acheminés vers l'URL racine de l'application de destination. Vous pouvez envoyer des événements vers une autre destination dans l'application en spécifiant un chemin. Par exemple, si votre chemin d'abonnement indique /events, les évènements sont envoyés à https://<base application URL>/events. Cliquez sur Suivant pour continuer.
   5. Pour le récapitulatif, vérifiez les paramètres de votre abonnement d’évènement Object Storage et faites des modifications si nécessaire. Lorsque vous êtes prêt, cliquez sur créer pour créer l'abonnement Object Storage .

5. Maintenant que votre abonnement Object Storage est créé, accédez à la page Abonnements d’évènements pourafficher la liste des abonnements définis.

6. Pour mettre à jour un abonnement, accédez à votre page d'abonnement Object Storage. Sur cette dernière, cliquez sur le nom de l'abonnement à mettre à jour.

7. A partir de votre page d'abonnement Object Storage, modifions le type de changement d'objet par les modifications d'objet delete uniquement. Dans l'onglet Détails de l'évènement de compartiment, sélectionnez uniquement le type delete de changement d'objet. Cliquez sur Sauvegarder pour sauvegarder vos modifications.

8. Étant donné que l'application myapp fait référence à l'exemple d'application cos-listen, qui imprime des informations dans les fichiers journaux, vous pouvez afficher les journaux. Une fois qu'un objet est supprimé du compartiment, vous pouvez voir un évènement qui matérialise la suppression dans les journaux de l'application. Voir Affichage des journaux d'application à partir de la console.

Après avoir défini un abonnement d’évènement IBM Cloud Object Storage qui fait référence à un compartiment spécifique, vous ne pouvez plus mettre à jour cet abonnement pour utiliser un autre compartiment. Vous devez créer un abonnement pour référencer le compartiment que vous souhaitez.

Abonnement aux évènements IBM Cloud Object Storage pour une application avec l'interface de ligne de commande

Avant de commencer

• Configurez votre environnement d'interface de ligne de commande Code Engine.

• Créez et utilisez un projet.

• Permet de créer une application. Par exemple, créez une application appelée myapp qui utilise l'image icr.io/codeengine/cos-listen. Cette image est issue de cos-listen.go, disponible dans le dépôt « Samples for IBM Cloud Code Engine » GitHub. Par exemple :

  ibmcloud ce application create --name myapp --image icr.io/codeengine/cos-listen
  

1. Connectez votre application au producteur d’évènements IBM Cloud Object Storage à l'aide de la commande ibmcloud ce subscription cos create . Par exemple :

   ibmcloud ce subscription cos create --name mycosevent --destination-type app --destination myapp --bucket mybucket
   

2. Une fois votre abonnement créé, exécutez la commande subscription cos get pour obtenir plus de détails sur votre abonnement.

   ibmcloud ce subscription cos get --name mycosevent
   

   Exemple de sortie

   Getting COS source 'mycosevent'...
   OK
   Name:          mycosevent
   ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:  myproject
   Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
   Age:           59s
   Created:       2021-03-01T20:08:36-06:00
   Destination:  App:myapp
   Bucket:       mybucket
   Event Type:   all
   Ready:        true
   Conditions:
       Type            OK    Age  Reason
       CosConfigured   true  55s
       Ready           true  55s
       ReadyForEvents  true  55s
       SinkProvided    true  55s
   Events:
       Type     Reason           Age      Source                Messages
       Normal   FinalizerUpdate  61s      cossource-controller  Updated "mycosevent" finalizers
   

Désormais, chaque fois que vous modifiez votre compartiment, votre application reçoit une notification.

Vous voulez suivre un tutoriel ? Reportez-vous au tutoriel décrivant l'abonnement à des événements Object Storage. Vous recherchez d'autres exemples de code ? Consultez le répertoire Samples for IBM Cloud Code Engine GitHub.

Affichage des informations d'événement pour une application à partir de la console

Pour afficher des informations sur vos abonnements à des événements,

1. Depuis la page « Projets » d' Code Engine, accédez à votre projet.
2. Sur la page Présentation, cliquez sur Abonnements à des événements pour afficher une liste des abonnements définis.

Si votre application imprime des informations dans les fichiers journaux, comme le fait l'exemple d'application cos-listen, affichez les fichiers journaux de votre application client d’évènement. Voir Affichage des journaux d'application à partir de la console.

Affichage des informations d'événement pour une application à l'aide de l'interface de ligne de commande

Si votre application imprime des informations dans les fichiers journaux, comme le fait l'application cos-listen, utilisez la commande d'interface de ligne de commande ibmcloud ce app logs pour afficher les informations qui ont été envoyées.

Avant de pouvoir afficher les informations d'événement pour votre application, vous devez d'abord créer un événement Object Storage. Apportez une modification à votre compartiment.

Pour afficher les journaux de l'application que vous avez créée dans l'exemple précédent,

ibmcloud ce application logs --application myapp

Exemple de sortie

Getting logs for all instances of application 'myapp'...
OK
myapp-a2mvv-1-deployment-d97dcd6cf-zc9lg/user-container:
Listening on port 8080
2021-04-13 19:43:45 - Received:
Body: {"bucket":"mybucket","endpoint":"","key":"Notes.rtf","notification":{"bucket_name":"mybucket","content_type":"text/rtf","event_type":"Object:Write","format":"2.0","object_etag":"2944035e54ee1bdc423848c8eaf05e86","object_length":"4642","object_name":"NOtes.rtf","request_id":"6abc7123-382d-4115-98e8-7568b2cc03f8","request_time":"2021-04-13T19:43:36.610Z"},"operation":"Object:Write"}

Notez que les informations de journalisation relatives aux applications ne sont conservées que pendant une heure. Pour plus d'informations sur la journalisation, voir Affichage des journaux.

Vous recherchez d'autres exemples de code ? Consultez le répertoire Samples for IBM Cloud Code Engine GitHub.

Informations d'en-tête et de corps IBM Cloud Object Storage pour les événements distribués aux applications

Tous les événements distribués aux applications sont reçus en tant que messages HTTP. Les événements contiennent des en-têtes HTTP qui vous aident à déterminer rapidement des informations clés sur les événements sans examiner le corps (logique métier) de l'événement. Pour plus d'informations, consultez la spécification « CloudEvents ».

ce-id:  3fb2c04e-a660-4640-8899-b82efb8169b6
ce-source: https://cloud.ibm.com/catalog/services/cloud-object-storage/mybucket
ce-specversion: 1.0
ce-subject: object-69-144
ce-time: 2021-08-17T20:22:02.917Z
ce-type: com.ibm.cloud.cos.document.delete

{
  "bucket": "mybucket",
  "endpoint": "",
  "key": "object-69-144",
  "notification": {
    "bucket_name": "mybucket",
    "content_type": "image/svg+xml",
    "event_type": "Object:Delete",
    "format": "2.0",
    "object_etag": "f3a9dbde30fdf48abc23e5f8b485d6e5",
    "object_length": "1064391",
    "object_name": "object-69-144",
    "request_id": "67a2048a-abcd-abcd-9e0c-968744094b85",
    "request_time": "2021-08-17T20:22:02.917Z"
  },
  "operation": "Object:Delete"
}

Abonnement aux évènements IBM Cloud Object Storage pour un travail à partir de la console

Vous pouvez créer et mettre à jour des abonnements d’évènements IBM Cloud Object Storage pour un travail à partir de la console.

Avant de commencer

• Créez un projet.
• Créez un travail. Par exemple, créez un travail appelé myjob qui utilise l'image icr.io/codeengine/codeengine. Cette image est issue de codeengine.go, disponible dans le dépôt « Samples for IBM Cloud Code Engine » GitHub.

Suivez les étapes ci-dessous pour créer ou mettre à jour un abonnement aux événements « IBM Cloud Object Storage » pour une tâche depuis la console :

1. Depuis la page « Projets » d' Code Engine, accédez à votre projet.

2. Sur la page Présentation, cliquez sur Abonnements à des événements.

3. Sur la page Abonnements à des événements, cliquez sur Créer pour créer votre abonnement.

4. Sur la page « Créer un abonnement à un événement », procédez comme suit :

   1. Pour leType d’évènement, sélectionnez la mosaïque Cloud Object Storage. Cliquez sur Suivant.

   2. DansGénéral, fournissez un nom pour l'abonnement Object Storage , par exemple, mycos-job. Vous pouvez le cas échéant fournir des attributs d'événement. Lorsque le consommateur d’évènements est un travail, les attributs d'évènement sont disponibles en tant que variables d'environnement. Cliquez sur Suivant pour continuer.

   3. Pour les détails de l'événement Bucket, sélectionnez ou saisissez le nom d'un bucket Object Storage existant et indiquez les types de modifications de votre objet pour lesquels vous souhaitez déclencher des événements.

      Pour le type de changement d'objet, spécifiez quand recevoir des événements pour des actions sur votre objet Object Storage ; vous pouvez sélectionner l'un ou l'autre type de changement d'objet, ou les deux :

      • Utilisez Créer et mettre à jour pour recevoir un événement à chaque fois qu'un nouvel objet est créé ou qu'un objet existant est mis à jour.
      • Utilisez l'option Supprimer pour recevoir un événement chaque fois qu'un objet existant est supprimé de votre seau.

      Vous pouvez également fournir un préfixe ou un suffixe de nom d'objet pour filtrer les objets dans le seau afin de déclencher des événements pour l'abonnement. Spécifiez les valeurs Préfixe du nom d'objet ou Suffixe du nom d'objet pour indiquer les chaînes qui correspondent au début (préfixe) ou à la fin (suffixe) des noms d'objets pour lesquels vous souhaitez recevoir des événements. Cette valeur limite les objets de votre panier Object Storage qui déclenchent des événements aux noms de fichiers qui commencent ou se terminent par le préfixe ou le suffixe spécifié. N'utilisez pas de caractères génériques ou d'expressions régulières ; indiquez uniquement du texte en clair pour le préfixe et le suffixe (par exemple, indiquez abc, et non *abc pour indiquer tous les objets commençant par abc ). En outre, les noms de fichiers incluent l'extension du fichier (par exemple, si vous spécifiez json comme suffixe, l'événement sera traité pour les fichiers tels que abc.json, mais pas pour abcjson.txt).

      Cliquez sur Suivant pour continuer.

   4. Pour leConsommateur d’évènement, indiquez le travail pour recevoir des évènements. Notez que vous pouvez choisir parmi une liste de travaux définis. Pour cet exemple, utilisez le travail myjob qui référence l'image icr.io/codeengine/codeengine. Si votre travail n'existe pas, vous pouvez spécifier le nom de votre travail et créer votre travail après avoir créé l'abonnement Object Storage. Cliquez sur Suivant pour continuer.

   5. Pour le récapitulatif, vérifiez les paramètres de votre abonnement d’évènement Object Storage et faites des modifications si nécessaire. Lorsque vous êtes prêt, cliquez sur créer pour créer l'abonnement Object Storage .

5. Maintenant que votre abonnement Object Storage est créé, accédez à la page Abonnements d’évènements pourafficher la liste des abonnements définis.

6. Pour mettre à jour un abonnement, accédez à votre page d'abonnement Object Storage. Sur cette dernière, cliquez sur le nom de l'abonnement à mettre à jour.

7. A partir de votre page d'abonnement Object Storage, modifions le type de changement d'objet par les modifications d'objet delete uniquement. Dans l'onglet Détails de l'évènement de marché, sélectionnez uniquement le type de modification d'objet delete. Cliquez sur Sauvegarder pour sauvegarder vos modifications.

8. Étant donné que le travail myjob fait référence à l'exemple de travail icr.io/codeengine/codeengine, qui imprime des informations dans les fichiers journaux, vous pouvez afficher les journaux. Une fois qu'un objet a été supprimé du compartiment, vous pouvez voir un évènement pour la suppression dans les journaux d'exécution de travaux. Voir Affichage des journaux de travail à partir de la console.

Les exécutions de travail qui sont créées par des abonnements sont supprimées au bout de 10 minutes.

Après avoir défini un abonnement d’évènement IBM Cloud Object Storage qui fait référence à un compartiment spécifique, vous ne pouvez plus mettre à jour cet abonnement pour utiliser un autre compartiment. Vous devez créer un abonnement pour référencer le compartiment que vous souhaitez.

Abonnement aux événements IBM Cloud Object Storage pour un travail avec l'interface de ligne de commande

Avant de commencer

• Configurez votre environnement d'interface de ligne de commande Code Engine.

• Créez et utilisez un projet.

• Permet de créer un travail. Par exemple, créez un travail appelé myjob qui utilise l'image icr.io/codeengine/codeengine. Cette image est issue de codeengine.go, disponible dans le dépôt « Samples for IBM Cloud Code Engine » GitHub.

  ibmcloud ce job create --name myjob --image icr.io/codeengine/codeengine
  

1. Connectez votre travail au producteur d’évènements IBM Cloud Object Storage à l'aide de la commande ibmcloud ce subscription cos create.

   ibmcloud ce subscription cos create --name mycosevent --destination-type job --destination myjob --bucket mybucket
   

2. Une fois votre abonnement créé, exécutez la commande subscription cos get pour obtenir plus de détails sur votre abonnement.

   ibmcloud ce subscription cos get --name mycosevent
   

   Exemple de sortie

   Getting COS source 'mycosevent'...
   OK
   Name:          mycosevent
   ID:            abcdefgh-abcd-abcd-abcd-1a2b3c4d5e6f
   Project Name:  myproject
   Project ID:    01234567-abcd-abcd-abcd-abcdabcd1111
   Age:           59s
   Created:       2021-03-01T20:08:36-06:00
   Destination Type:  job
   Destination:       myjob
   Bucket:       mybucket
   Event Type:   all
   Ready:        true
   Conditions:
       Type            OK    Age  Reason
       CosConfigured   true  55s
       Ready           true  55s
       ReadyForEvents  true  55s
       SinkProvided    true  55s
   Events:
       Type     Reason           Age      Source                Messages
       Normal   FinalizerUpdate  61s      cossource-controller  Updated "mycosevent" finalizers
   

Désormais, chaque fois que vous modifiez votre compartiment, votre travail reçoit une notification.

Les exécutions de travail qui sont créées par des abonnements sont supprimées au bout de 10 minutes.

Vous voulez suivre un tutoriel ? Reportez-vous au tutoriel décrivant l'abonnement à des événements Object Storage. Vous recherchez d'autres exemples de code ? Consultez le répertoire Samples for IBM Cloud Code Engine GitHub.

Affichage des informations d'événement pour un travail à partir de la console

Pour afficher des informations sur vos abonnements à des événements,

1. Depuis la page « Projets » d' Code Engine, accédez à votre projet.
2. Sur la page Présentation, cliquez sur Abonnements à des événements pour afficher une liste des abonnements définis.

Si votre travail imprime des informations dans les fichiers journaux, comme le fait l'exemple de travail codeengine, vous pourrez alors voir les fichiers journaux pour votre application client d’évènement. Voir Affichage des journaux de travail à partir de la console.

Affichage des informations d'événement pour un travail à l'aide de l'interface de ligne de commande

Si votre travail imprime des informations aux fichiers journaux, comme le fait le travail codeengine, utilisez la commande CLI ibmcloud ce jobrun logs pour voir les informations qui ont été envoyées.

Avant de pouvoir afficher les informations d'événement pour votre travail, vous devez d'abord créer un événement Object Storage. Apportez une modification à votre compartiment.

Pour trouver l'exécution du travail dans l'exemple précédent,

ibmcloud ce jobrun list

Exemple de sortie

Listing job runs...
OK
Name         Failed  Pending  Requested  Running  Succeeded  Unknown  Age
myjob-pnz6m  0       0        0          0        1          0        39s

Affichez les journaux pour l'exécution du travail en indiquant le nom d'exécution du travail.

ibmcloud ce jobrun logs --jobrun myjob-pnz6m

Exemple de sortie

Getting logs for all instances of job run 'myjob-pnz6m'...
Getting jobrun 'myjob-pnz6m'...
Getting instances of jobrun 'myjob-pnz6m'...
OK
myjob-pnz6m-0-0/myjob:
Hello from helloworld! I'm a batch job! Index: 0
Hello World from:
. ___  __  ____  ____
./ __)/  \(    \(  __)
( (__(  O )) D ( ) _)
.\___)\__/(____/(____)
.____  __ _   ___  __  __ _  ____
(  __)(  ( \ / __)(  )(  ( \(  __)
.) _) /    /( (_ \ )( /    / ) _)
(____)\_)__) \___/(__)\_)__)(____)
Some Env Vars:
--------------
CE_DATA={"bucket":"mybucket","endpoint":"","key":"Notes.rtf","notification":{"bucket_name":"mybucket","content_type":"text/rtf","event_type":"Object:Delete","format":"2.0","object_length":"4642","object_name":"Notes.rtf","request_id":"b59727ee-9c4e-446a-9261-5616f6d1283b","request_time":"2021-04-13T20:10:37.631Z"},"operation":"Object:Delete"}
CE_ID=b59727ee-9c4e-446a-9261-5616f6d1283b
CE_SOURCE=https://cloud.ibm.com/catalog/services/cloud-object-storage/mybucket
CE_SPECVERSION=1.0
CE_TIME=2021-04-13T20:10:37.631Z
CE_TYPE=com.ibm.cloud.cos.document.delete
CONTENT_TYPE=application/json
HOME=/root
HOSTNAME=myjob-pnz6m-0-0
JOB_INDEX=0
KUBERNETES_PORT=tcp://172.21.0.1:443
KUBERNETES_PORT_443_TCP=tcp://172.21.0.1:443
KUBERNETES_PORT_443_TCP_ADDR=172.21.0.1
KUBERNETES_PORT_443_TCP_PORT=443
KUBERNETES_PORT_443_TCP_PROTO=tcp
KUBERNETES_SERVICE_HOST=172.21.0.1
KUBERNETES_SERVICE_PORT=443
KUBERNETES_SERVICE_PORT_HTTPS=443
PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
PWD=/
SHLVL=1

Veuillez noter que les informations de journalisation relatives à l'exécution des tâches ne sont conservées que pendant une heure. Pour plus d'informations sur la journalisation, voir Affichage des journaux.

Vous recherchez d'autres exemples de code ? Consultez le répertoire Samples for IBM Cloud Code Engine GitHub.

Variables d'environnement pour les événements distribués aux travaux

Tous les événements distribués à un travail sont reçus en tant que variables d'environnement. Ces variables d'environnement sont précédées du préfixe « CE_ » et s'appuient sur la spécification « CloudEvents ».

Chaque événement contient un certain nombre de variables d'environnement communes qui s'affichent chaque fois que l'événement est distribué à un travail. Le jeu de variables réel de chaque événement peut comporter plus d'options. Pour plus d'informations et pour découvrir d'autres options de variables d'environnement, consultez les attributs de la commande « CloudEvent ».

Le tableau suivant décrit les variables d'environnement qui sont propres aux événements IBM Cloud Object Storage.

{
"bucket":"mybucket",
"endpoint":"",
"key":"Notes.rtf",
"notification": {
    "bucket_name":"mybucket",
    "content_type":"text/rtf",
    "event_type":"Object:Delete",
    "format":"2.0",
    "object_length":"4642",
    "object_name":"Notes.rtf",
    "request_id":"b59727ee-9c4e-446a-9261-5616f6d1283b",
    "request_time":"2021-04-13T20:10:37.631Z"
},
"operation":"Object:Delete"}

CE_DATA={"bucket":"mybucket","endpoint":"","key":"Notes.rtf","notification":{"bucket_name":"mybucket","content_type":"text/rtf","event_type":"Object:Delete","format":"2.0","object_length":"4642","object_name":"Notes.rtf","request_id":"b59727ee-9c4e-446a-9261-5616f6d1283b","request_time":"2021-04-13T20:10:37.631Z"},"operation":"Object:Delete"}
CE_ID=b59727ee-9c4e-446a-9261-5616f6d1283b
CE_SOURCE=https://cloud.ibm.com/catalog/services/cloud-object-storage/mybucket
CE_SPECVERSION=1.0
CE_TIME=2021-04-13T20:10:37.631Z
CE_TYPE=com.ibm.cloud.cos.document.delete

Suppression d'un abonnement de la console

1. Depuis la page « Projets » d' Code Engine, accédez à votre projet.
2. Sur la page Présentation, cliquez sur Abonnements à des événements pour afficher une liste des abonnements définis.
3. Dans la liste des abonnements, supprimez l'abonnement que vous souhaitez supprimer de votre application ou travail.

Si vous supprimez une application ou un travail associé à l'abonnement, l'abonnement n'est pas supprimé. Si vous recréez l'application ou le travail (ou une autre application ou un autre travail portant le même nom), votre abonnement se reconnecte à l'application ou au travail.

Suppression d'un abonnement avec l'interface de ligne de commande

Vous pouvez supprimer un abonnement IBM Cloud Object Storage en exécutant la commande ibmcloud ce subscription cos delete.

Par exemple, utilisez la commande suivante pour supprimer un abonnement IBM Cloud Object Storage appelé mycosevent,

ibmcloud ce subscription cos delete --name mycosevent

Si vous supprimez une application ou un travail associé à l'abonnement, l'abonnement n'est pas supprimé. Au lieu de cela, il passe à l'état prêt de false car l'abonnement dépend de la disponibilité de l'application ou du travail. Si vous recréez l'application ou le travail (ou une autre application ou un autre travail portant le même nom), votre abonnement se reconnecte et l'état Prêt est true.