feat(aps): add ssh troubleshooting (#3311)

* feat(aps): add * wording * Apply suggestions from code review Co-authored-by: fvallee-scw <[email protected]> * Apply suggestions from code review Co-authored-by: Rowena Jones <[email protected]> * Update bare-metal/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx Co-authored-by: Rowena Jones <[email protected]> * Apply suggestions from code review Co-authored-by: Jessica <[email protected]> --------- Co-authored-by: fvallee-scw <[email protected]> Co-authored-by: Rowena Jones <[email protected]> Co-authored-by: Jessica <[email protected]>
scaleway · Jun 12, 2024 · fac8bcc · fac8bcc
1 parent 86c309d
commit fac8bcc
Show file tree

Hide file tree

Showing 11 changed files with 74 additions and 30 deletions.
diff --git a/bare-metal/apple-silicon/how-to/connect-to-mac-mini.mdx b/bare-metal/apple-silicon/how-to/connect-to-mac-mini.mdx
@@ -15,11 +15,11 @@ categories:
 
 This page shows how to connect to your [Mac mini](/bare-metal/apple-silicon/concepts/#mac-mini) via [VNC](/bare-metal/apple-silicon/concepts/#vnc) and [SSH](/console/account/concepts/#ssh-key).
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
-- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) added to your account
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 ## How to connect via VNC

diff --git a/bare-metal/apple-silicon/how-to/create-mac-mini.mdx b/bare-metal/apple-silicon/how-to/create-mac-mini.mdx
@@ -7,19 +7,19 @@ content:
   paragraph: This page explains how to create a Mac mini
 tags: mac-mini mac-mini apple-silicon
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
 This page shows how to create your first [Mac mini](/bare-metal/apple-silicon/concepts/#mac-mini) with the Scaleway console.
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
-- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) added to your account
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
 
 <Message type="important">
   Due to license constraints, the minimum lease for Apple silicon is 24 hours. As a result, the earliest you can delete a Mac mini is 24 hours after the start of its lease.

diff --git a/bare-metal/apple-silicon/how-to/delete-mac-mini.mdx b/bare-metal/apple-silicon/how-to/delete-mac-mini.mdx
@@ -7,18 +7,18 @@ content:
   paragraph: This page explains how to delete a Mac mini
 tags: mac-mini mac-mini-m1 m1 apple-silicon
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
 This page shows how to delete your [Mac mini](/bare-metal/apple-silicon/concepts/#mac-mini).
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 <Message type="important">

diff --git a/bare-metal/apple-silicon/how-to/reboot-mac-mini.mdx b/bare-metal/apple-silicon/how-to/reboot-mac-mini.mdx
@@ -7,18 +7,18 @@ content:
   paragraph: This page explains how to reboot a Mac mini
 tags: mac-mini mac-mini m1 apple-silicon reboot
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
 This page shows how to reboot your [Mac mini](/bare-metal/apple-silicon/concepts/#mac-mini) from the Scaleway console. This is useful if your Mac mini is unreachable, or you want to reboot it remotely.
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 1. Click **Apple silicon** in the **Bare Metal** section of the side menu. A list of your Mac minis displays.

diff --git a/bare-metal/apple-silicon/how-to/reinstall-mac-mini.mdx b/bare-metal/apple-silicon/how-to/reinstall-mac-mini.mdx
@@ -7,18 +7,19 @@ content:
   paragraph: This page explains how to reinstall a Mac mini
 tags: reinstall mac-mini mac-mini apple-silicon 
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
 This page shows how to reinstall your [Mac mini](/bare-metal/apple-silicon/concepts/#mac-mini) from the Scaleway console. This is useful if your Mac mini is not reachable, or you want to start from scratch on the machine.
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 1. Click **Apple silicon** in the **Bare Metal** section of the side menu. A list of your Mac minis displays.

diff --git a/bare-metal/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx b/bare-metal/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx
@@ -0,0 +1,39 @@
+---
+meta:
+  title: Resolving SSH connection issues to Scaleway Mac mini
+  description: Learn how to fix SSH connection problems with Scaleway Apple silicon Mac mini by uploading your SSH key and rebooting the device.
+content:
+  h1: Resolving SSH connection issues to Scaleway Mac mini
+  paragraph: Learn how to fix SSH connection problems with Scaleway Apple silicon Mac mini by uploading your SSH key and rebooting the device.
+tags: ssh ssh-key connection
+dates:
+  validation: 2024-06-12
+  posted: 2024-06-12
+categories:
+  - bare-metal
+---
+
+This documentation addresses an issue faced by users who are unable to connect to their Mac Mini via SSH.
+This problem typically arises because the user's SSH key has not been uploaded to the Mac Mini.
+It can also happen after multiple authentication failures while trying to access the VNC server because of default fail2ban security policies.
+This guide provides the necessary steps to resolve this issue by connecting to the Scaleway console and rebooting the Mac Mini from the Apple silicon section.
+
+<Message type="note">
+The reboot **must** be carried out via the console, and not via any other method, in order to resolve the problem.
+</Message>
+
+
+<Macro id="requirements" />
+
+- A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
+- A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
+
+1. Click **Apple silicon** in the **Bare Metal** section of the side menu. A list of your Mac minis displays.
+2. Click the Mac mini you want to configure. Your Mac mini information page displays.
+3. Scroll down to the **Reboot Mac mini** section. Click **Reboot** to reboot the Mac mini.
+    <Message type="tip">
+      Ensure you have [generated and uploaded your SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) before rebooting your Mac mini.
+    </Message>
+4. Click **Reboot Mac mini** to confirm. The Mac mini reboots and your SSH key will be uploaded during the boot process. Banned host lists are reset as well.
diff --git a/bare-metal/apple-silicon/troubleshooting/cant-connect-using-vnc.mdx b/bare-metal/apple-silicon/troubleshooting/cant-connect-using-vnc.mdx
@@ -7,16 +7,16 @@ content:
   paragraph: This page suggests solutions for when you cannot establish a remote VNC connection to your Mac mini
 tags: remote vnc connection apple-silicon error 
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2023-04-07
 categories:
   - bare-metal
 ---
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 VNC (Virtual Network Computing) is a system that lets users remotely access and control another computer's desktop.

diff --git a/bare-metal/apple-silicon/troubleshooting/filevault-preventing-system-boot.mdx b/bare-metal/apple-silicon/troubleshooting/filevault-preventing-system-boot.mdx
@@ -7,16 +7,16 @@ content:
   paragraph: This page explains how to prevent FileVault from stopping your system from booting
 tags: filevault boot booting 
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 Apple FileVault is a disk encryption feature. Ensure that FileVault is **not enabled** on your Mac mini. If enabled, it will prevent your system from booting.

diff --git a/bare-metal/apple-silicon/troubleshooting/need-package-manager.mdx b/bare-metal/apple-silicon/troubleshooting/need-package-manager.mdx
@@ -7,17 +7,17 @@ content:
   paragraph: This page explains how to use Homebrew to manage the packages installed on your Mac mini and to install additional software.
 tags: package-manager manager mac-mini-m1 mac-mini
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
-- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) added to your account
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 [Homebrew](https://brew.sh/) is a package manager for macOS. It allows you to manage the packages installed on your Mac mini and provides a way to install additional software on your machine.

diff --git a/bare-metal/apple-silicon/troubleshooting/need-to-update-os.mdx b/bare-metal/apple-silicon/troubleshooting/need-to-update-os.mdx
@@ -7,17 +7,17 @@ content:
   paragraph: This page explains how to update the OS on your Mac mini
 tags: update mac-mini mac-mini-m1 os operating-system
 dates:
-  validation: 2024-02-29
+  validation: 2024-06-12
   posted: 2021-05-26
 categories:
   - bare-metal
 ---
 
-## Requirements
+<Macro id="requirements" />
 
-- Be the [Owner](/identity-and-access-management/iam/concepts/#owner) of the Organization in which the actions will be performed, or an IAM user with the [necessary permissions](/identity-and-access-management/iam/concepts/#permission)
 - A Scaleway account logged into the [console](https://console.scaleway.com)
-- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) added to your account
+- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization
+- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/)
 - A [Mac mini](/bare-metal/apple-silicon/how-to/create-mac-mini/)
 
 To update the Operating System installed on your Mac mini, you can use the `softwareupdate` tool.

diff --git a/menu/navigation.json b/menu/navigation.json
@@ -1003,6 +1003,10 @@
                   {
                     "label": "I can't connect to my Mac mini through a remote VNC connection",
                     "slug": "cant-connect-using-vnc"
+                  },
+                  {
+                    "label": "I can't connect to my Mac mini through a remote SSH connection",
+                    "slug": "cant-connect-using-ssh"
                   }
                 ],
                 "label": "Troubleshooting",