Comment utiliser Instance Scheduler avec CloudFormation pour planifier des instances EC2 ?

Résolution

Remarque : Si des erreurs surviennent lorsque vous exécutez des commandes de l'interface de la ligne de commande AWS (AWS CLI), consultez la section Résoudre des erreurs liées à l’AWS CLI. Vérifiez également que vous utilisez bien la version la plus récente de l'AWS CLI.

Pour automatiser le déploiement d’Instance Scheduler sur AWS, utilisez les modèles CloudFormation.

Remarque : Si vous utilisez Instance Scheduler pour des instances d’Amazon EC2 avec un Amazon Elastic Block Store (Amazon EBS) chiffré, vos instances ne démarreront pas. Vous devez ajouter la politique de clé à la clé AWS Key Management Service (AWS KMS) pour autoriser le rôle d’utilisateur de clés à utiliser cette clé.

Installer Instance Scheduler

Installez Instance Scheduler. Puis, pour vérifier que l’installation a réussi, exécutez la commande suivante :

$ scheduler-cli --version

Créer une pile CloudFormation avec le modèle Instance Scheduler

Pour déployer une fonction AWS Lambda, une table Amazon DynamoDB, une règle Amazon EventBridge et des métriques personnalisées Amazon CloudWatch, procédez comme suit :

1. Ouvrez la Console de gestion AWS.
2. Ouvrez la console CloudFormation à l'aide du modèle Instance Scheduler. Par défaut, le modèle est lancé dans la région USA Est (Virginie du Nord). Vous pouvez également passer à la page Étape 1. Lancer la page pile du hub d’Instance Scheduler, puis choisissez Lancer la solution.
   Dans la barre de navigation, sélectionnez la région AWS où vous souhaitez lancer votre pile avec le modèle, puis cliquez sur Suivant.
   Dans Nom de la pile, nommez votre pile.
   Dans Nom d’identification d’Instance Scheduler, vous pouvez conserver la valeur par défaut comme Plan ou la personnaliser.
   Dans Fréquence, choisissez une fréquence d’exécution de votre planificateur en minutes. Vous pouvez par exemple choisir 5 minutes.
   Remarque : la vitesse est le nombre de minutes qui s’écoulent avant qu’EventBridge ne relance la fonction Lambda pour Instance Scheduler. Si les instances sont nombreuses, utilisez la fréquence maximale pour éviter toute limitation. Si la fréquence est trop faible pour vos besoins, vous pouvez régler la propriété Fréquence ultérieurement.
   Dans Activer des métriques CloudWatch, choisissez Oui.
   Dans Activer des journaux CloudWatch, choisissez Oui.
   (Facultatif) Dans Identifications lancées, saisissez state=started.
   (Facultatif) Dans Identifications arrêtées, saisissez state=stopped.
   Pour la planification intercompte, indiquez le paramètre Rôles intercomptes. Saisissez les Amazon Resource Names (ARN) pour chaque rôle des comptes secondaires, en les séparant par des virgules. Si vous ne souhaitez pas appliquer la planification intercompte, laissez le paramètre vide.
3. Sélectionnez Suivant.
4. Sur la page Options, choisissez Suivant.
5. Vérifiez vos paramètres, puis choisissez Je reconnais qu’AWS CloudFormation peut créer des ressources IAM.
6. Sélectionnez Créer.

Créer les périodes

Pour créer des périodes, vous pouvez utiliser la CLI d’Instance Scheduler, la console DynamoDB ou des ressources personnalisées. Pour plus d’informations sur les durées, consultez la section Heures de début et de fin.

Utiliser la CLI d’Instance Scheduler

Connectez-vous à la CLI d’Instance Scheduler, puis exécutez les commandes create-period de l'AWS CLI suivantes :

$ scheduler-cli create-period --stack your_stack_name --region aa-example-1 --name mon-fri-9-5 --begintime 9:00 --endtime 16:59 --weekdays mon-fri    
$ scheduler-cli create-period --stack your_stack_name --region aa-example-1 --name sat-9-12 --begintime 9:00 --endtime 11:59 --weekdays sat

Remarque : Remplacezyour_stack_name par le nom de pile que vous avez choisi à l’étape 2 et aa-example-1 par votre région.

Utiliser la console DynamoDB

Pour créer des périodes, procédez comme suit :

1. Ouvrez la console DynamoDB.
2. Choisissez Tables, puis sélectionnez la table de configuration.
   Remarque : Le modèle Instance Scheduler crée automatiquement une table DynamoDB d’état et de configuration. La table d’état enregistre l’état d’instances que le modèle arrête et démarre. La table de configuration vous permet de spécifier les périodes et les horaires correspondant à vos besoins.
3. Choisissez Explorer les éléments de la table.
4. Choisissez Créer un élément.
5. Choisissez la vue JSON, puis utilisez le modèle JSON suivant :

   {    "type": {  
       "S": "period"  
     },  
     "name": {  
       "S": "mon-fri-9-5"  
     },  
     "begintime": {  
       "S": "9:00"  
     },  
     "endtime": {  
       "S": "16:59"  
     },  
     "weekdays": {  
       "SS": [  
         "mon-fri"  
       ]  
     }  
   }

   Remarque : Le modèle JSON précédent crée la première période. Utilisez un modèle JSON similaire pour la deuxième période. Remplacez mon-fri-9-5 par le nom de votre période, 9:00 par votre heure de début et 16:59 par votre heure de fin.

Créer un plan

Pour créer un plan, utilisez la CLI d’Instance Scheduler, la console DynamoDB ou des ressources personnalisées.

Utiliser la CLI d’Instance Scheduler

Pour créer un plan, exécutez la commande CLI create-schedule suivante :

$ scheduler-cli create-schedule --stack your_stack_name --name m-f9-5-sat9-12 --region aa-example-1 --periods mon-fri-9-5,sat-9-12 --timezone UTC

Remarque : Remplacez your_stack_name par le nom de votre pile, aa-example-1 par votre région et mon-fri-9-5,sat-9-12 par votre plan.

Utiliser la console DynamoDB

Pour créer un plan, procédez comme suit :

1. Ouvrez la console DynamoDB.
2. Choisissez Tables, puis sélectionnez la table de configuration.
3. Choisissez Explorer les éléments de la table.
4. Choisissez Créer un élément.
5. Choisissez la vue JSON, puis utilisez le modèle JSON suivant :

   {    "type": {  
       "S": "schedule"  
     },  
     "name": {  
       "S": "m-f9-5-sat9-12"  
     },  
     "timezone": {  
       "S": "UTC"  
     },  
     "periods": {  
       "SS": [  
         "mon-fri-9-5"  
       ]  
     }  
   }

Marquer l’instance et tester le plan

Marquer les instances

Lorsque vous utilisez une pile CloudFormation avec Instance Scheduler, vous devez définir le paramètre Nom d’identification d’Instance Scheduler. La valeur par défaut de ce paramètre est Plan.

Instance Scheduler surveille les identifications sur les instances. Si la clé d’identification d’instance correspond à l’identification du planificateur, Instance Scheduler applique le plan défini pour la valeur d’identification d’instance. Par exemple, la clé d’une identification est définie sur Plan et la valeur est définie sur m-f9-5-sat9-12. Dans cet exemple, les instances démarrent à 9 heures et s’arrêtent à 17 heures du lundi au vendredi. Elles démarrent également à 9 heures et s’arrêtent à 12 heures le samedi.

Remarque : Les clés et les valeurs d’identification sont sensibles à la casse. Si vous démarrez manuellement des instances en dehors de la période d'exécution, Instance Scheduler n'arrête pas de les exécuter. Instance Scheduler ne démarre pas non plus une instance si vous l'arrêtez manuellement pendant la période d'exécution, à moins que vous n'appliquiez le plan. Pour plus d’informations, consultez la section Définitions du plan.

Utiliser des plans prédéfinis

Outre les plans personnalisés, vous pouvez également utiliser l’un des plans prédéfinis de la table de configuration. Les étapes suivantes testent le plan prédéfini nommé en cours d’exécution :

1. Ouvrez la console Amazon EC2.
2. Choisissez les instances arrêtées que vous souhaitez baliser.
3. Choisissez la vue Balises, puis cliquez sur Gérer les balises.
4. Choisissez Ajouter une balise.
5. Pour Clé, saisissez Plan.
6. Pour Valeur, saisissez en cours d’exécution.
7. Sélectionnez Enregistrer.
8. Actualisez la console Amazon EC2, puis patientez jusqu’au lancement de la fonction Lambda.
   Remarque : Si la fonction Lambda démarre et s'exécute sans erreur, l'état de l'instance s’affiche comme étant en cours d'exécution. Cela dépend du plan que vous testez. Dans la console CloudWatch, vous pouvez vérifier les métriques CloudWatch pour détecter les invocations et les erreurs Lambda.
9. Ouvrez la console DynamoDB.
10. Choisissez Tables, puis sélectionnez la table d’état.
11. Choisissez Explorer les éléments de table et confirmez que l’instance marquée a démarré.
    Important : Des frais supplémentaires peuvent vous être facturés selon la vitesse et la durée de la fonction Lambda que vous utilisez. Des frais supplémentaires peuvent également vous être facturés pour les tables DynamoDB ou pour les règles EventBridge que vous créez.

Plans intercomptes

Pour planifier des instances dans des comptes secondaires à l’aide d’Instance Scheduler, déployez le modèle de CloudFormation aws-instance-scheduler-remote. Ce modèle crée le rôle qui permet à Instance Scheduler du compte principal de gérer les instances du compte secondaire.

Remarque : Vous devez fournir l’ARN de rôle sous forme de paramètre de la pile d’Instance Scheduler dans le compte principal. Veillez à créer ou à mettre à jour votre pile d’Instance Scheduler avec le bon paramètre.

Pour lancer la pile distante dans les comptes secondaires, procédez comme suit :

1. Ouvrez la console de gestion AWS du compte secondaire et lancez le modèle CloudFormation aws-instance-scheduler-remote. Vous pouvez également télécharger le modèle pour l’utiliser ultérieurement.

   Remarque : Par défaut, le modèle est lancé dans la région USA Est (Virginie du Nord).

2. Dans la barre de navigation, sélectionnez la région où vous souhaitez lancer votre pile avec le modèle, puis cliquez sur Suivant.

3. Sur la page Sélection de modèle, vérifiez que vous avez bien sélectionné le bon modèle, puis choisissez Suivant.

4. Sur la page Spécifier les détails, nommez votre pile distante.

5. Dans Paramètres, vérifiez et modifiez le paramètre Compte primaire. Saisissez le numéro de compte du compte principal.

6. Sélectionnez Suivant.

7. Sur la page Options, choisissez Suivant.

8. Vérifiez vos paramètres, puis choisissez Je reconnais qu’AWS CloudFormation peut créer des ressources IAM.

9. Sélectionnez Créer.

10. Choisissez l’onglet Sorties de pile, puis copiez la valeur CrossAccountRole.

11. À partir du compte principal, sélectionnez votre pile CloudFormation, puis cliquez sur Mettre à jour.

12. Sur la page Mettre à jour la pile, choisissez Utiliser le modèle actuel.

13. Dans le paramètre Rôles intercomptes, collez la valeur CrossAccountRole.

14. Choisissez Suivant, puis Je reconnais qu’AWS CloudFormation peut créer des ressources IAM.

15. Choisissez Mettre à jour la pile.