Skip to content

Commit 353763f

Browse files
RoRoJnerda-codesjcirinosclwybene2k1
authored
feat(apple-silicon): add private networks feature (#4138)
* feat(apple): start pn doc * feat(apple-silicon): finish private networks doc * fix(apple): improve wording * Apply suggestions from code review Co-authored-by: nerda-codes <87707325+nerda-codes@users.noreply.github.com> Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> * fix(apple): clarify PN info * fix(apple): closing tag * fix(apple): correct plural * fix(apple): add config details * fix(pn): fix after rebase * fix(pn): last links * fix(as): doc best practices * Apply suggestions from code review --------- Co-authored-by: nerda-codes <87707325+nerda-codes@users.noreply.github.com> Co-authored-by: Jessica <113192637+jcirinosclwy@users.noreply.github.com> Co-authored-by: Benedikt Rollik <brollik@scaleway.com>
1 parent 96e12aa commit 353763f

File tree

12 files changed

+168
-10
lines changed

12 files changed

+168
-10
lines changed

faq/apple-silicon.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,3 +44,6 @@ Certain operations are restricted by default MDM configuration profiles:
4444
## Do I pay for my Mac mini when I am not using it?
4545
Yes, you pay for your Mac mini as long as it is assigned to your account. You must explicitly delete it in the console or via the CLI to stop charges. For deletion instructions, see [How to delete Mac mini](/apple-silicon/how-to/delete-mac-mini/).
4646

47+
## Are Mac minis compatible with Private Networks?
48+
Yes, you can now activate the Private Networks feature on your Mac mini, and attach it to a Private Network so that it can securely communicate with other Scaleway resources. For full details, see the [Mac mini Private Networks documentation](/apple-silicon/how-to/use-private-networks/).
49+

menu/navigation.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -896,6 +896,10 @@
896896
"label": "Connect to a Mac mini using SSH",
897897
"slug": "connect-to-mac-mini-ssh"
898898
},
899+
{
900+
"label": "Use Private Networks",
901+
"slug": "use-private-networks"
902+
},
899903
{
900904
"label": "Install a package manager",
901905
"slug": "install-package-manager-mac-mini"

pages/apple-silicon/concepts.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,10 @@ Apple silicon as-a-Service is tailored for developing, building, testing, and si
2424

2525
The Mac mini is a physical hardware designed by Apple, powered by the [Apple silicon](#apple-silicon) chip. It is the basis for Scaleway's [Apple silicon as-a-service](#apple-silicon-as-a-service) offer.
2626

27+
## Private Networks
28+
29+
Private Networks allow your Mac mini to communicate in an isolated and secure network with other Scaleway resources. This is an optional-billed feature for Mac mini. Find out [how to attach your Mac mini to a Private Network](/apple-silicon/how-to/use-private-networks/).
30+
2731
## Region and Availability Zone
2832

2933
<Macro id="region-and-az" />
101 KB
Loading
80.1 KB
Loading
2.39 KB
Loading

pages/apple-silicon/how-to/create-mac-mini.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ This page shows how to create your first [Mac mini](/apple-silicon/concepts/#mac
3636
- Mac mini M4, M2 pro, and M2 are available in PARIS 1
3737
- Mac mini M1 are available in PARIS 3
3838
- Choose a macOS version. Note that if you choose a macOS other than the one installed by default, there will be a delay of about 1 hour before the Mac mini is made available.
39+
- Choose whether to activate the **Private Networks 1 Gbps** feature. This lets you attach your Mac mini to one or more Scaleway Private Networks in a [VPC](/vpc/), enabling secure communication with other attached resources.
3940
- Enter a **Name** for your Mac mini, or leave the randomly-generated name in place.
4041
- Verify the **Estimated cost** for your Mac mini based on your chosen specifications.
4142
4. Click **Create Mac mini** to finish. The installation of your Apple silicon is launched, and you are informed when it is ready.
Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
---
2+
meta:
3+
title: How to use Private Networks with your Mac mini
4+
description: Learn how to get the most from the Private Networks 1Gbps feature for your Mac mini. Find out how to activate the feature, attach your Mac mini to Private Networks, and enable secure communication with your other Scaleway resources.
5+
content:
6+
h1: How to use Private Networks with your Mac mini
7+
paragraph: Learn how to get the most from the Private Networks 1Gbps feature for your Mac mini. Find out how to activate the feature, attach your Mac mini to Private Networks, and enable secure communication with your other Scaleway resources.
8+
tags: mac-mini mac-mini apple-silicon private-network vpc
9+
dates:
10+
validation: 2025-01-28
11+
posted: 2021-05-26
12+
categories:
13+
- bare-metal
14+
---
15+
16+
Private Networks allow your Mac mini to communicate in an isolated and secure network with other Scaleway resources. This is an optional-billed feature for Mac mini.
17+
18+
When the feature is activated, each Mac mini can be connected to one or several Private Networks, letting you build your own network topologies. Private Networks’ built-in DHCP server manages the allocation of private IP addresses for Mac mini servers (and other resources) when they are attached to the network.
19+
20+
For full information about Scaleway Private Networks and VPC, see our [dedicated documentation](/vpc/) and [best practice guide](/vpc/reference-content/getting-most-private-networks/).
21+
22+
<Macro id="requirements" />
23+
24+
- A Scaleway account logged into the [console](https://console.scaleway.com)
25+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
26+
- A [Mac mini](/apple-silicon/how-to/create-mac-mini/)
27+
28+
## How to enable the Private Networks feature
29+
30+
Before you can attach your Mac mini to a Private Network, you must enable the feature. This can be done during [Mac mini creation](/apple-silicon/how-to/create-mac-mini/) or afterwards. These instructions show how to enable the feature after the creation of the Mac mini.
31+
32+
1. Click **Apple silicon** in the **Bare Metal** section of the side menu. The Apple silicon splash page displays.
33+
2. Click the Mac mini you want to enable Private Networks on. The Mac mini's **Overview** page displays.
34+
3. In the **Private Networks feature** panel, use the <Icon name="toggle" /> toggle button to enable the feature.
35+
A pop-up displays, asking you to confirm that you want to enable Private Networks, and showing the estimated cost.
36+
4. Click **Enable Private Networks**.
37+
38+
Private Networks are enabled, and you are returned to your Mac mini's **Overview** page.
39+
40+
<Message type = "tip">
41+
When the feature is activated, you can attach your Mac mini to up to 8 different Private Networks. You are charged the same overall price for the feature, you are not billed per Private Network.
42+
</Message>
43+
44+
## How to disable the Private Networks feature
45+
46+
You can disable the Private Networks feature at any time after activating it.
47+
48+
1. Click **Apple silicon** in the **Bare Metal** section of the side menu. The Apple silicon splash page displays.
49+
2. Click the Mac mini you want to disable Private Networks on. The Mac mini's **Overview** page displays.
50+
3. In the **Private Networks feature** panel, use the <Icon name="toggle" /> toggle button to disable the feature.
51+
A pop-up displays, asking you to confirm that you want to disable Private Networks.
52+
4. Click **Disable Private Networks**.
53+
54+
Private Networks are disabled, and you are returned to your Mac mini's **Overview** page. Any Private Networks previously attached to the Mac mini are now detached.
55+
56+
## How to attach a Mac mini to a Private Network
57+
58+
1. Click **Apple silicon** in the **Bare Metal** section of the side menu. The Apple silicon splash page displays.
59+
2. Click the Mac mini you want to attach to a Private Network. The Mac mini's **Overview** page displays.
60+
3. Click the **Private Networks** tab.
61+
4. Click **+ Attach to a Private Network**. A pop-up displays.
62+
5. Select the Private Network you want to attach the Mac mini to. It will be automatically assigned private IPv4 and IPv6 addresses on this network. The ability to use specific reserved IP addresses for the attachment is planned for the future.
63+
6. Click **Attach to Private Network**.
64+
65+
The Mac mini is attached to the Private Network, and you are returned to the **Private Networks** tab. The IPv4 and the IPv6 addresses for the Mac mini on the Private Network are displayed, along with the ID of the VLAN interface that was created.
66+
67+
Once you have attached the resource, some manual configuration of the network interface is required. See the next section for full details.
68+
69+
## How to configure the VLAN interface on your Mac mini for Private Networks
70+
71+
You must configure the virtual network interface on each Mac mini you have attached to a Private Network. Traffic from the public internet and traffic from a Private Network will pass through the same network interface of the Mac mini. We must therefore separate the traffic by adding a VLAN interface.
72+
73+
To configure the interface, you must connect to your Mac mini, either via SSH or the remote desktop and carry out the instructions given.
74+
75+
### Via SSH and networksetup
76+
77+
1. Make a note of your Mac mini's **VLAN ID**. You can view this in the Scaleway console, in the **Private Networks** tab of the Mac mini in question.
78+
2. [Connect to your Mac mini via SSH](/apple-silicon/how-to/connect-to-mac-mini-ssh/).
79+
3. Use the following command to bring up the interface. Ensure you replace `<VLAN_ID>` with the VLAN_ID from step one.
80+
```
81+
sudo networksetup -createVLAN pn en0 <VLAN_ID>
82+
```
83+
4. Check that the interface has been brought up with the following command:
84+
```
85+
sudo networksetup -listVLANs
86+
```
87+
You should see a response similar to the following:
88+
```
89+
VLAN User Defined Name: pn
90+
Parent Device: en0
91+
Device ("Hardware" Port): vlan0
92+
Tag: 3548
93+
```
94+
95+
No configuration is required for your Mac mini's IP address on the Private Network, as this is automatically managed by Scaleway DHCP. You can view the IP address in the Scaleway console, in the Mac mini's **Private Networks** tab.
96+
97+
<Message type="tip">
98+
If you have any issues with bringing up the VLAN interface or the IP address, the following commands may be helpful.
99+
100+
To delete the VLAN, so you can attempt re-creation;
101+
```
102+
sudo networksetup -deleteVLAN pn en0 <VLAN_ID>
103+
```
104+
To renew the DHCP lease:
105+
```
106+
sudo ipconfig set en0 BOOTP && sudo ipconfig set en0 DHCP
107+
```
108+
</Message>
109+
110+
### Via remote desktop
111+
112+
1. Make a note of your Mac mini's **VLAN ID**. You can view this in the Scaleway console, in the **Private Networks** tab of the Mac mini in question.
113+
2. [Access the Mac mini's remote desktop](/apple-silicon/how-to/access-remote-desktop-mac-mini/).
114+
3. Go to **System Settings** > **Network**, then click **...v** and select **Manage Virtual Interfaces** from the menu that displays.
115+
<Lightbox src="scaleway-m1-network.webp" />
116+
4. Click **+** > **New VLAN** to add a new virtual interface.
117+
<Lightbox src="scaleway-m1-vlan.webp" />
118+
5. Enter a **VLAN name** of your choice, the VLAN ID from step 1 in the **Tag** field, and **Ethernet** as the interface. Click **Done**.
119+
120+
The VLAN interface is created. You can check its status in the **Network** tab, and see its full details by clicking on it.
121+
122+
<Lightbox src="scaleway-m1-vlan-details.webp" />
123+
124+
No configuration is required for your Mac mini's IP address on the Private Network, as this is automatically managed by Scaleway DHCP.
125+
126+
## How to detach a Mac mini from a Private Network
127+
128+
1. Click **Apple silicon** in the **Bare Metal** section of the side menu. The Apple silicon splash page displays.
129+
2. Click the Mac mini you want to detach from a Private Network. The Mac mini's **Overview** page displays.
130+
3. Click the **Private Networks** tab.
131+
4. Click the unlink icon <Icon name="unlink" /> next to the Private Network you want to detach from the Mac mini.
132+
A pop-up displays, asking you to confirm that you want to detach the resource.
133+
5. Click **Detach resource**.
134+
135+
The Mac mini is detached from the Private Network, and you are returned to the **Private Networks** tab. You can reattach it at any time.

pages/apple-silicon/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ meta:
44
description: Dive into Scaleway Apple silicon with our quickstart guides, how-tos, tutorials and more.
55
---
66

7+
<Alert
8+
sentiment="info"
9+
title="Mac mini is now compatible with Private Networks"
10+
>
11+
You can now activate the Private Networks feature on your Mac mini, and attach it to up to eight Private Networks so that it can securely communicate with your other Scaleway resources. See the [dedicated documentation](/apple-silicon/how-to/use-private-networks/) for full details.
12+
</Alert>
13+
714
<ProductHeader
815
productName="Apple silicon"
916
productLogo="appleSilicon"

pages/vpc/how-to/attach-resources-to-pn.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Up to 512 resources can be attached to each Private Network, and each resource c
2222
The following resource types can be attached to a Private Network:
2323
- Instances
2424
- Elastic Metal servers
25+
- Apple silicon (Mac mini)
2526
- Load Balancers
2627
- Public Gateways
2728
- Managed Databases for PostgreSQL and MySQL
@@ -76,13 +77,16 @@ The following resource types can be attached to a Private Network:
7677
You can also attach a resource to a Private Network from the resource's own section of the console. Follow the relevant steps below:
7778
- [Instance](/instances/how-to/use-private-networks/#how-to-attach-instances-to-an-existing-private-network)
7879
- [Elastic Metal server](/elastic-metal/how-to/use-private-networks/#from-the-elastic-metal-section-of-the-console)
80+
- [Apple silicon](/apple-silicon/how-to/use-private-networks/)
7981
- [Managed Database for PostgreSQL and MySQL](/managed-databases-for-postgresql-and-mysql/how-to/connect-database-private-network/)
8082
- [Load Balancer](/load-balancer/how-to/use-with-private-network/)
8183
- [Public Gateway](/public-gateways/how-to/configure-a-public-gateway/#how-to-attach-a-public-gateway-to-a-private-network)
8284

8385
Note that for Kubernetes Kapsules and Managed Databases for Redis™, you can only attach the resource to a Private Network at the time of creating the resource itself.
8486
</Message>
8587

88+
For Elastic Metal servers and Apple silicon Mac minis, manual configuration of the network interface is required. This is not required for Instances or other types of resources. See the relevant documentation for [Elastic Metal](/elastic-metal/how-to/use-private-networks/#how-to-configure-the-network-interface-on-your-elastic-metal-server-for-private-networks) or [Apple silicon](/apple-silicon/how-to/use-private-networks/) for full instructions.
89+
8690
## How to view the resource's IP address
8791

8892
When you attach a resource to a Private Network, it gets a private IPv4 address on that network (and also an IPv6 address, if supported by the resource). Private IPs are assigned from the CIDR block defined at the time of the Private Network's creation, either via auto-assignment or specification of a particular [reserved IP](/ipam/how-to/reserve-ip/).
@@ -101,15 +105,14 @@ Refer to our documentation on [IPv4](/vpc/how-to/create-private-network/#how-to-
101105

102106
<Message type="important">
103107

104-
When you attach an Instance or Elastic Metal server to a legacy Private Network on which you [have not activated DHCP](/vpc/reference-content/vpc-migration/#dhcp-activation-on-pre-existing-private-networks), no IP address is configured or shown on the screen shown above.<br /><br />
108+
When you attach a resource to a legacy Private Network on which you [have not activated DHCP](/vpc/reference-content/vpc-migration/#dhcp-activation-on-pre-existing-private-networks), no IP address is configured or shown on the screen shown above.<br /><br />
105109

106110
You will need to carry out manual configuration to set the IP address on the resource, or activate DHCP.<br /><br />
107111

108112
We strongly recommend that you [activate DHCP on the Private Network](/vpc/how-to/activate-dhcp/) to let us automatically handle IP address management. <br /> <br />
109113

110114
If you do not see an IP address in the screens above for your resource, and you think you should, check out our [troubleshooting](/vpc/troubleshooting/resource-attached-no-ip/) guide. <br /> <br />
111115

112-
Note that in any case, for Elastic Metal servers, some [manual configuration is required](/elastic-metal/how-to/use-private-networks/#how-to-configure-the-network-interface-on-your-elastic-metal-server-for-private-networks) even after activating DHCP. This is not required for Instances or other types of resources.
113116
</Message>
114117

115118
## How to access a resource on a Private Network via its hostname (DNS)

0 commit comments

Comments
 (0)