Clés SSH

Pour accéder et gérer vos serveurs Equinix Metal™ en toute sécurité, ajoutez des clés SSH à votre compte ou projet. SSH est la méthode d'accès par défaut à un serveur Equinix Metal . Des clés SSH sont ajoutées à chaque serveur provisionné. Equinix Metal utilise également des clés SSH pour l'authentification de notre console SOS/OOB.

Génération de clés SSH

Pour utiliser les clés SSH avec Equinix Metal™, vous devez d’abord générer une paire de clés publique et privée sur votre machine locale, puis ajouter votre clé publique à votre compte ou projet Equinix Metal .

Pour générer une paire de clés SSH sur votre machine locale, procédez comme suit:

1. Entrez la commande ssh-keygen dans l'invite de commandes pour générer une paire de clés SSH. La commande ssh-keygen est prise en charge sur Linux, macOS et les versions récentes de Windows.

   ssh-keygen -t ed25519

   Si votre machine locale ou le système d'exploitation de votre serveur Metal ne prend pas en charge les clés Ed25519, utilisez des clés RSA avec une taille de clé minimale recommandée de 2048 bits.

   ssh-keygen -t rsa -b 2048

2. Suivez les instructions pour générer les clés SSH. Appuyez sur Entrée pour sauvegarder les clés et accepter l'emplacement et les noms de clés par défaut. Remarque: Si c'est votre première clé SSH, il est recommandé d'accepter l'emplacement et les noms de clés par défaut.

3. Utilisation d'une phrase secrète: sa saisie n'est pas obligatoire, mais elle offre une sécurité supplémentaire. Si vous choisissez d'utiliser une phrase secrète, vous devrez la saisir à chaque fois que vous utiliserez SSH pour accéder à votre serveur. Si vous ne souhaitez pas utiliser de phrase secrète, appuyez sur Entrée pour la laisser vide.

4. Une fois la génération de clé terminée, les clés SSH publiques et privées sont enregistrées dans le chemin suivant, si vous avez accepté l'emplacement par défaut:

   • /home/<name>/.ssh/<key-name>.pub on Linux
   • /Users/<name>/.ssh/<key-name>.pub on Mac
   • C:\Users\<name>/.ssh/<key_name>.pub on Windows

Vous devrez importer cette clé dans la console Equinix Metal. Pour plus d'informations sur l'ajout de la clé à la console Metal, consultez la section Ajouter votre clé SSH à votre compte. L'autre fichier de clé dans le même répertoire, <key_name>, est votre clé privée. Ne la partagez pas avec personne.

Remarque: Si vous utilisez une version plus ancienne de Windows qui ne comprend pas de serveur et de client SSH intégrés, vous devrez télécharger et configurer une application tierce telle que PuTTY pour [générer des clés et vous connecter en SSH à vos serveurs.

Ajout de votre clé SSH à votre compte

Console

Une fois vos clés SSH créées sur votre machine locale, vous êtes maintenant prêt à ajouter votre clé publique à votre compte Equinix Metal .

Pour ajouter votre clé publique à votre compte Equinix Metal, procédez comme suit:

1. Dans la console, en haut à droite, cliquez sur votre profil utilisateur. Mon profil.

2. Cliquez sur l'onglet Clés SSH pour ouvrir vos clés SSH personnelles associées à votre profil utilisateur.

3. Cliquez sur + Ajouter une nouvelle clé pour ajouter une nouvelle clé SSH à votre compte.

   

4. Sur votre ordinateur local, ouvrez le fichier <key_name.pub> et copiez son contenu.

5. Collez le contenu dans le champ Clé publique.

6. Entrez un nom pour votre clé dans le champ Nommez votre clé.

7. Pour associer la clé à d'autres serveurs, utilisez le champ de texte « Rechercher un périphérique » pour trouver un périphérique ou sélectionnez-le dans la liste. Cette option est également disponible uniquement via la console Equinix Metal.

   Remarque: Si vous avez sélectionné un appareil déjà associé à une clé, un message contextuel s'affiche pour vous informer qu'une clé existe déjà sur ce serveur. Décochez la case correspondant à l'appareil.

8. Cochez la case Tout sélectionner pour associer tous les serveurs de la liste à la clé.

9. Cliquez sur Ajouter une clé SSH. Une fois la clé SSH ajoutée, elle apparaîtra dans la liste des clés SSH de l'onglet Clés SSH.

10. Cliquez sur Modifier pour renommer ou mettre à jour votre clé.

CLI

Vous pouvez ajouter une clé SSH à votre utilisateur avec la commande metal ssh-key create. Entrez la chaîne complète de la clé publique SSH à l'aide de l'option --key et un nom ou une autre description conviviale à l'aide de l'option --label.

metal ssh-key create --key <ssh_public_key> --label <string>

Pour mettre à jour une clé SSH, utilisez la commande metal ssh-key update. Vous pouvez modifier soit la clé --label, soit la clé --key, soit les deux.

metal ssh-key update -i <SSH-key_UUID> --key <ssh_public_key> --label <string>

API

Vous pouvez ajouter une clé publique à votre compte en envoyant une requête POST au point de terminaison /ssh-keys de l'API Equinix Metal.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/ssh-keys" \
-d '{
    "label": "<string>",
    "key": "<ssh_public_key>"
}'

Pour mettre à jour une clé SSH, envoyez une requête PUT au point de terminaison /ssh-keys/{id}. Vous pouvez alors mettre à jour soit la clé "label", soit la clé "key", soit les deux.

curl -X PUT \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/ssh-keys/{id}" \
-d '{
    "label": "<string>",
    "key": "<ssh_public_key>"
}'

Provisionnement des serveurs avec des clés SSH

Par défaut, lorsque vous provisionnez un serveur, toutes les clés SSH de votre compte utilisateur, celles des membres de votre équipe et celles de votre projet sont ajoutées au serveur. Ces clés SSH autorisent l'accès au serveur.

Console

Pour remplacer la valeur par défaut lors du provisionnement d'un serveur, vous devez spécifier les clés SSH auxquelles vous souhaitez que le serveur ait accès.

Pour spécifier les clés SSH, procédez comme suit:

1. Dans la console, allez dans Bare Metals > Déployer > À la demande.

2. Cliquez sur Paramètres facultatifs Clés SSH.

3. Passez en revue les touches Projet, Personnel et Collaborateur et faites votre sélection.

4. Cliquez sur Sélectionner toutes les clés pour autoriser toutes les clés SSH autorisées à accéder au serveur.

Remarque: Si toutes les clés (Projet, Personnel et Collaborateur) sont décochées, toutes les clés seront ajoutées au serveur par défaut. Vous ne pouvez pas faire d'approvisionnement dans la console sans clés SSH. Pour provisionner sans clés SSH, utilisez l’API.

API

Pour personnaliser les clés SSH incluses sur un serveur lors de son provisionnement via l'API, ajoutez les paramètres "user_ssh_keys" ou "project_ssh_keys" à votre requête POST adressée au point de terminaison projects/{id}/devices. Ces paramètres remplaceront le comportement par défaut qui consiste à ajouter toutes les clés SSH au serveur et n'ajouteront que les clés SSH spécifiées.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/devices" \
-d '{
    "metro": "<metro_code>",
    "plan": "<server_type>",
    "operating_system": "<os_code>",
    "user_ssh_keys": [
        <uuid>
    ],
    "project_ssh_keys": [
        <uuid>
    ]
}'

Paramètres corporels notables:

• "user_ssh_keys" - An array containing a list of UUIDs of your user account's SSH keys and team members SSH keys used to authorize access to this server. These keys will also appear in the device metadata. The users must be members of the project or organization.
• "project_ssh_keys" - An array containing a list of UUIDs of the Project's SSH keys used to authorize access to this server. These keys will also appear in the device metadata.

Vous pouvez également ajouter à un serveur des clés SSH publiques non chargées et gérées par Equinix Metal en utilisant le paramètre "ssh_keys" dans votre requête POST adressée au point de terminaison projects/{id}/devices. Ces clés sont ajoutées au serveur en même temps que celles définies par "project_ssh_keys" et "user_ssh_keys", ou en plus du comportement par défaut qui consiste à ajouter toutes les clés SSH disponibles.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/devices" \
-d '{
    "metro": "<metro_code>",
    "plan": "<server_type>",
    "operating_system": "<os_code>",
    "ssh_keys": [
        {
            "key": "<ssh_public_key>",
            "label": "<string>"
        }
    ]
}'

Paramètre corporel notable:

• "ssh_keys" - An array of SSH key objects that will be added to the server to authorize SSH access to it. These keys will also appear in the device metadata.

Par défaut, si aucune clé SSH n'est spécifiée ("user_ssh_keys", "project_ssh_keys" et "ssh_keys" sont toutes des listes vides ou omises), toutes les clés SSH utilisateur disponibles, les clés SSH du projet et les clés SSH des membres de l'équipe seront incluses.

Provisionnement sans clés SSH

Pour provisionner un serveur sans clés SSH, vous devez inclure explicitement le paramètre "no_ssh_keys" dans votre requête POST au point de terminaison projects/{id}/devices.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/devices" \
-d '{
"metro": "<metro_code>",
"plan": "<server_type>",
"operating_system": "<os_code>",
"no_ssh_keys": true
}'

Paramètre corporel notable:

• "no_ssh_keys" - Boolean that overrides default behavior of attaching user, team member, and Project SSH keys to a server and provisions it without any authorized SSH access. Set the "no_ssh_keys" to true in the body of the request.

Clés SSH après provisionnement

Pour afficher les clés disponibles provisionnées sur un serveur, procédez comme suit:

Console

1. Dans la console, accédez à Serveurs Bare Metals > Gérer.

2. Sélectionnez le serveur que vous souhaitez afficher.

3. Cliquez sur l'onglet Clés SSH pour afficher les clés SSH.

   

CLI

Les clés SSH ajoutées à un serveur lors de sa mise en service peuvent être récupérées depuis l'interface de ligne de commande (CLI) avec la commande [metal device get](../libraries/cli.md#metal-device-get) et l'option --output pour spécifier le format de sortie JSON. La liste se trouve dans l'objet ssh-keys de la réponse.

metal device get -i <device_id> -o json

API

Vous pouvez également obtenir les clés SSH d'un serveur à partir de l'API en envoyant une requête GET au point de terminaison /devices/{id}/ssh-keys.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/devices/{id}/ssh-keys"

Vous pouvez ajouter des clés SSH à votre compte en tout temps en suivant les instructions de la section Ajouter votre clé SSH à votre compte. Cependant, les clés ajoutées à votre compte ou à vos projets via la console ou l'API ne sont PAS automatiquement ajoutées aux serveurs. Equinix Metal n'exécute aucun agent ni processus sur les serveurs provisionnés pour effectuer cette action. Pour accorder l'accès, vous devez ajouter les clés SSH directement sur le serveur.

Si vous ajoutez une clé que vous souhaitez utiliser avec des serveurs provisionnés, cochez l'option permettant d'associer la nouvelle clé à des serveurs spécifiques ou à tous les serveurs lors de son ajout à la console. Cela n'autorise pas l'accès SSH direct au serveur, mais permet d'utiliser la nouvelle clé SSH lors de la connexion et de l'utilisation de la console SOS/OOB (../resilience-recovery/serial-over-ssh.mdx). Vous pouvez ensuite utiliser la console SOS/OOB pour ajouter votre nouvelle clé SSH aux clés autorisées sur le serveur.

Cette option est également disponible uniquement via la console Equinix Metal .

Connexion avec SSH

Pour vous connecter en SSH à votre serveur, exécutez la commande suivante:

ssh root@<your_public_ipv4>

Remarque: l’authentification par mot de passe SSH est désactivée par défaut sur les serveurs Equinix Metal .

Suppression des clés SSH

Console

Vous pouvez supprimer les clés SSH de votre compte dans la console Equinix Metal, depuis votre profil utilisateur, sous l'onglet « Clés SSH ». Cliquez sur « Supprimer » à côté de la clé à supprimer. Cette clé SSH ne sera pas ajoutée aux serveurs que vous provisionnerez ultérieurement.

CLI

Vous pouvez supprimer une clé SSH de votre compte utilisateur avec la commande metal ssh-key delete.

metal ssh-key delete --id <SSH-key_UUID>

La clé SSH ne sera ajoutée à aucun futur serveur que vous provisionnerez.

API

Dans l'API, les clés SSH peuvent être supprimées de votre compte en envoyant un DELETE au point de terminaison /ssh-keys/{id}.

curl -X DELETE \
-H 'X-Auth-Token: <API_TOKEN>' \
"https://api.equinix.com/metal/v1/ssh-keys/{id}"

La clé ne sera plus ajoutée aux serveurs au moment de la mise à disposition.

Remarque: Les clés supprimées de votre compte ou de vos projets via la console ou l’API ne sont PAS automatiquement supprimées des serveurs. Equinix Metal ne conserve aucun agent ni processus sur les serveurs provisionnés pour effectuer cette action. Pour révoquer l'accès, vous devez supprimer manuellement les clés SSH du serveur.