Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOC-620
English Panel
bgColor#F6F5F5
borderWidth0

You can add user data to an instance to more specifically configure it. User data can be of any type of information, like a script or text information. You can also specify tags to give precise instructions about the instance placement or IP addresses.   

User data are data linked to the instance by the user. An instance can access user data at any time but they are taken into account only at launch. However, you can create a script contained in the OMI used to launch an instance to require that user data are taken into account at every stop and start. This enables you to modify them, and then stop and start the instance for the modifications to be applied. For more information about how to modify user data, see Utiliser les metadata et les user data.

To get information about the user data of an instance, type to the following address in the terminal of the instance or in a web browser: 169.254.169.254/latest/user-data.

Include PageINCL:_RC-toc-task-choiceINCL:_RC-toc-task-choice
Table of Contents
maxLevel1

Adding a Script or Text in User Data

You can add a script or any other text information in the user data of an instance. Your script can contain text variables and can be used to have the instance execute any action you need at boot, for example to automatically download a file from an Object Storage Unit (OSU) bucket.

These user data can be executed every time the instance boots, if the instance contains a script that can do so:

In the Free section of the User Data tab in the 
Status
colourBlue
titleCreate Instance
 dialog box (Expert Mode only) on Cockpit, or in the
 user-data attribute of the run-instances AWS CLI command:

  • For Linux instances, you need to create a script that fetches and executes the user data. For more information, see Creating an Autonomous Instance.
  • For Windows instances, you can type your script within one of the following wrappers to execute it at boot:

    LanguageWrapperDescriptionPowershell
    Code Block
    languagetext
    # autoexecutepowershellnopasswd
    <your_script>
    # autoexecutepowershellnopasswd 
    Executes the powershell script without init password administrator. The script is launched with the administrator user.Powershell
    Code Block
    languagetext
    # autoexecutepowershell
    <your_script>
    # autoexecutepowershell
    Executes the powershell script with init password administrator. The script is launched with the administrator user.Vbscript
    Code Block
    languagetext
    # autoexecutevbs
    <your_script>
    # autoexecutevbs
    Executes the vbscript script with init password administrator. The script is launched with the administrator user.If the boot script finds one of the above wrappers, it saves the script to a VB or PowerShell file in its /userdata and runs these files when the instance starts.
    UI Text Box
    sizemedium
    titleTip
    typetip

    You can separate the commands in a script using line breaks to run all the commands you want in the Windows PowerShell command prompt.

    AnchorTags to manage IPTags to manage IPAdding Outscale Tags in User Data

    You can add Outscale tags in user data to give instructions about the placement of your instances. You can for example place instances in a same server (also called hypervisor) or cluster (a set of hypervisors) to improve network performance, or place them in different clusters to reduce risks.  

    UI Text Box
    sizemedium
    titleNote
    typeinfo
    You can also add these tags using the classic method. For more information, see Ajouter ou retirer des tags.

    If you are using AWS CLI, create a section for all your Outscale tags following this syntax:

    Code Block
    languagetext
    -----BEGIN OUTSCALE SECTION-----
    <Outscale tags>
    -----END OUTSCALE SECTION-----
     
    UI Text Box
    sizemedium
    titleWarning
    typewarning
    - Do not add a blank space at the end of each line.
    - Insert a carriage return at the end of the code. Otherwise, the last line is not read properly.  
    UI Text Box
    sizemedium
    titleNote
    typeinfo

     If you are using Cockpit, this section is already created.

    Add your tags within this section following the tags.TAG_NAME=TAG_VALUE format. 
    The following tags are available:

    Tags to specify ins tructions about the placement of an instance: 

    Include PageINCL:_RC-FCU-Table-UserDataPlacementINCL:_RC-FCU-Table-UserDataPlacement

    In the following example, instance#1 and instance#2 are placed on the same server, if possible: 

    Code Block
    languagetext
    INSTANCE#1 USER DATA
    -----BEGIN OUTSCALE SECTION-----
    tags.osc.fcu.attract_server=front80
    -----END OUTSCALE SECTION-----
    
    INSTANCE#2 USER DATA
    -----BEGIN OUTSCALE SECTION-----
    tags.osc.fcu.attract_server=front80
    -----END OUTSCALE SECTION-----
     
    In the following example, instance#3 and instance#4 are placed on different servers, and an error occurs if not possible:
    Code Block
    languagetext
    INSTANCE#3 USER DATA
    -----BEGIN OUTSCALE SECTION-----
    tags.osc.fcu.repulse_server_strict=front80
    -----END OUTSCALE SECTION-----
    
    INSTANCE#4 USER DATA
    -----BEGIN OUTSCALE SECTION-----
    tags.osc.fcu.repulse_server_strict=front80
    -----END OUTSCALE SECTION-----
     

    Tags to manage IP addresses associated with an instance:

    Include PageINCL:_RC-FCU-Table-UserDataIpsINCL:_RC-FCU-Table-UserDataIps

    In the following example, the 111.33.22.100 External IP address is attached and fixed to the instance: 

    Code Block
    languagetext
    -----BEGIN OUTSCALE SECTION-----
    tags.osc.fcu.eip.auto-attach=111.33.22.100
    -----END OUTSCALE SECTION-----
     
    UI Text Box
    sizemedium
    titleImportant
    typenote

    If the instance is already started, you need to add the following as EC2 tag, before stopping and restarting the instance (no reboot):

    osc.fcu.eip.auto-attach:111.33.22.100

    French


    Panel
    bgColor#F6F5F5
    borderWidth0

    Vous pouvez ajouter des user data à une instance afin d'y ajouter une configuration plus spécifique ou tout type de données. Vous pouvez ajouter tout type d'information en tant que user data, comme un script ou des données supplémentaires. Vous pouvez également spécifier des tags pour donner des instructions précises quant au placement de l'instance ou ses adresses IP.

    Les user data sont des données liées à l'instance par l'utilisateur à son lancement. Une instance peut accéder aux user data à tout moment mais celles-ci ne sont prises en compte qu'au lancement. Vous pouvez cependant créer un script contenu dans l'OMI utilisée pour lancer l'instance qui requiert que les user data soient prises en compte à chaque démarrage de l'instance. Cela vous permet de les modifier, puis d'arrêter et démarrer l'instance pour que ces modifications soient appliquées. Pour en savoir plus sur la modification des user data, voir

    Utiliser les metadata et les user data

    Modifier un attribut d'une instance.

    Pour obtenir des informations sur les user data d'une instance, tapez l'adresse suivante dans le terminal de l'instance ou dans un navigateur web : 169.254.169.254/latest/user-data .

    Include Page
    INCL:_FR_RC-

    toc

    ToC-

    task

    Task-

    choice

    Choice
    INCL:_FR_RC-

    toc

    ToC-

    task

    Task-

    choice

    Choice

    Table of Contents
    maxLevel1



    Panel
    borderColor#FFFFFF
    bgColor#F6F5F5
    borderWidth2
    titleBGColor#E6E6E6
    borderStylesolid
    titlePages connexes


    Ajouter un script ou un texte aux user data

    Vous pouvez ajouter un script ou des données supplémentaires dans les user data d'une instance. Votre script peut contenir des variables texte et peut permettre que l'instance exécute une action de votre choix au démarrage, par exemple télécharger automatiquement un fichier depuis un bucket

    Object Storage Unit (OSU)

    .

     

    Ces user data peuvent être exécutés à chaque démarrage de l'instance, si l'instance contient un script adéquat : 

    • Dans
    l'encadré Free section
    • le champ Section libre de l'
    onglet 
    • onglet User
    Data de
    • data de la boîte de
    dialogue 
    • dialogue
      Status
      colourBlue
      title
    Create Instance
    • Créer une instance
      Expert uniquement
    • expert uniquement) dans Cockpit, ou dans l'
    attribut 
    • attribut user-data
     de
    • de la commande AWS
    CLI 
    • CLI run-instances
     
    • :

      • Pour les instances Linux,

     vous  
      • (en anglais uniquement). 

      • Pour les instances Windows, vous pouvez taper un script dans l'un des wrappers suivants pour l'exécuter au démarrage : 

        LangageWrapperDescription
        Powershell


        Code Block
        languagetext
        # autoexecutepowershellnopasswd
        <your_script>
        # autoexecutepowershellnopasswd 


        Exécute le script powershell sans init password administrator. Le script est lancé en tant qu'utilisateur administrateur.
        Powershell


        Code Block
        languagetext
        # autoexecutepowershell
        <your_script>
        # autoexecutepowershell


        Exécute le script powershell script avec init password administrator. Le script est lancé en tant qu'utilisateur administrateur.
        Vbscript


        Code Block
        languagetext
        # autoexecutevbs
        <your_script>
        # autoexecutevbs


        Exécute le script vbscript avec init password administrator. Le script est lancé en tant qu'utilisateur administrateur.


        Si le script de démarrage rencontre un des wrappers ci-dessus, le script est sauvegardé dans un VB ou dans un fichier Powershell dans ses /userdata, et exécute ces fichiers lorsque l'instance démarre.

    UI Text BoxsizemediumtitleAstucetype
      • Tip

        Vous pouvez séparer les commandes dans un script en utilisant des retours à la ligne, et ainsi exécuter toutes les commandes que vous souhaitez dans un terminal Windows Powershell.




    Ajouter un tag

    Outscale

    OUTSCALE aux user data

    Vous pouvez ajouter des tags

    Outscale

    OUTSCALE dans les user data pour

    donner des

    donner des instructions précises quant au placement de vos instances.

     Vous

     Vous pouvez par exemple placer les instances sur un même serveur (aussi appelé hyperviseur) ou cluster (un ensemble d'hyperviseurs) pour améliorer les performances réseau, ou les placer sur des clusters différents pour réduire les risques.

    UI Text Box
    sizemedium
    titleNote
    type
    Info
    Vous pouvez également ajouter ces tags avec la méthode classique. Pour en savoir plus, voir Ajouter ou retirer des tags.


    1. Avec AWS CLI, créez une section pour tous vos tags

    Outscale
    1. OUTSCALE suivant cette syntaxe : 

      Code Block
      languagetext
      -----BEGIN OUTSCALE SECTION-----
      
    <Outscale tags>
    1. <tags>
      -----END OUTSCALE SECTION-----
      
      
    UI Text BoxsizemediumtitleAttentiontype- Insérez

    1. Warning

    - N'ajoutez pas d'espace à la fin de chaque ligne.

    1. Insérez un retour chariot à la fin du code. Sinon, la dernière ligne n'est pas lue correctement.  

    UI Text Box
    sizemedium
    titleNote
    typeinfo

    Avec Cockpit, cette section est créée automatiquement.  



    1. Ajoutez vos tags dans cette section suivant le

    format 
    1. format tags.

    TAG
    1. <TAG_

    NAME
    1. NAME>=

    TAG
    1. <TAG_

    VALUE
    1. VALUE>.
      Les tags suivants sont disponibles :

      • Tags pour spécifier les instructions à propos du placement de l'instance :

      
      • Include Page
        INCL:_FR_RC-FCU-Table-UserDataPlacement
        INCL:_FR_RC-FCU-Table-UserDataPlacement

        Dans l'exemple suivant, l'instance#1 et l'instance#2 sont placées sur le même serveur, si possible : 

        Code Block
        languagetext
        INSTANCE#1 USER DATA
        -----BEGIN OUTSCALE SECTION-----
        tags.osc.fcu.attract_server=front80
        -----END OUTSCALE SECTION-----
         
        INSTANCE#2 USER DATA
        -----BEGIN OUTSCALE SECTION-----
        tags.osc.fcu.attract_server=front80
        -----END OUTSCALE SECTION-----
        
        


        Dans l'exemple suivant, l'

    instance#1
      • instance#3 et l'

    instance#2
      • instance#4 sont placées sur des serveurs différents, et une erreur est renvoyée si ce n'est pas possible :

        Code Block
        languagetext
        INSTANCE#3 USER DATA
        -----BEGIN OUTSCALE 
    SECTION
      • SECTION-----
        tags.osc.fcu.repulse_server_strict=front80
        -----END OUTSCALE SECTION-----
         
        INSTANCE#4 USER DATA
        -----BEGIN OUTSCALE 
    SECTION

    Si l'instance est déjà démarrée, vous devez ajouter le tag EC2 suivant, avant de stopper puis redémarrer l'instance (pas de reboot) :

    osc.fcu.eip.auto-attach:111.33.22.100
      • SECTION-----
        tags.osc.fcu.repulse_server_strict=front80
        -----END OUTSCALE SECTION-----
        
        


      • Anchor
        TagEIP
        TagEIP
        Tags pour gérer les adresses IP associées à une instance :
        Include Page
        INCL:_FR_RC-FCU-Table-UserDataIps
        INCL:_FR_RC-FCU-Table-UserDataIps

        Dans l'exemple suivant, l'External IP 111.33.22.100 est attachée et fixée à l'instance :

        Code Block
        languagetext
        -----BEGIN OUTSCALE SECTION-----
        tags.osc.fcu.eip.auto-attach=111.33.22.100
        -----END OUTSCALE SECTION-----
         

         

    UI Text Box
    sizemedium
    titleImportant
    typenote

      • Tag pour pouvoir utiliser simultanément une section OUTSCALE et une section libre :
        Include Page
        INCL:_FR_RC-FCU-Table-UserDataFilterPrivateSection
        INCL:_FR_RC-FCU-Table-UserDataFilterPrivateSection



    Include Page
    INCL:_FR_RC-

    general

    General-

    panel

    Panel-

    legalmentions

    LegalMentions
    INCL:_FR_RC-

    general

    General-

    panel-legalmentions English
    Panel
    borderColor#FFFFFF
    bgColor#F6F5F5
    borderWidth2
    titleBGColor#E6E6E6
    borderStylesolid
    titleRelated Pages
    French Panel
    borderColor#FFFFFF
    bgColor#F6F5F5
    borderWidth2
    titleBGColor#E6E6E6
    borderStylesolid
    titlePages connexes
  • À propos des instances
  • Configurer une instance avec les user data et les tags Outscale
  • Référence des tags user data

    Panel-LegalMentions