Skip to content

Commit

Permalink
New docs for Placement Groups service (#6943)
Browse files Browse the repository at this point in the history
* New docs for Placement Groups service

* Final fixes for review

* Fixes after review

* Missed fixes

* Another missed fix

* Resized images, minor fixes to formatting, updated modified date

---------

Co-authored-by: Matthew Wildman <[email protected]>
  • Loading branch information
Vernholio and wildmanonline authored Jun 20, 2024
1 parent 1493967 commit b28cf5b
Show file tree
Hide file tree
Showing 16 changed files with 384 additions and 128 deletions.
1 change: 1 addition & 0 deletions docs/products/compute/compute-instances/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Linode bundles the following services with all Compute Instances:
- Domain management through our [DNS Manager](https://www.linode.com/products/dns-manager/)
- Seamless firewall management with [Cloud Firewalls](https://www.linode.com/products/cloud-firewall/)
- Private Layer 2 networks with [VLANs](https://www.linode.com/products/vlan/)
- Physical placement of your Compute Instances in a data center with [Placement Groups](/docs/products/compute/compute-instances/guides/placement-groups/)
- Metrics and monitoring through the [Cloud Manager](https://www.linode.com/products/monitoring/) and [Longview](/docs/products/tools/longview/) (free plan)
- Reusable deployment scripts through [StackScripts](https://www.linode.com/products/stackscripts/)

Expand Down
3 changes: 2 additions & 1 deletion docs/products/compute/compute-instances/guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Guides
title_meta: "Guides and Tutorials for Compute Instances"
description: "A collection of guides to help you start deploying Compute Instances and using them to host your web applications and Cloud workloads"
modified: 2024-01-03
modified: 2024-06-20
tab_group_main:
weight: 30
aliases: ['/products/compute/shared-linodes/guides/','/products/compute/shared-cpu/guides/','/products/compute/gpu/guides/','/products/compute/dedicated-cpu/guides/','/products/compute/high-memory/guides/']
Expand All @@ -22,6 +22,7 @@ aliases: ['/products/compute/shared-linodes/guides/','/products/compute/shared-c
- [Access Your Desktop Environment Using Glish (Linode Graphical Shell)](/docs/products/compute/compute-instances/guides/glish/)
- [Reset Root Password](/docs/products/compute/compute-instances/guides/reset-root-password/)
- [Clone a Compute Instance](/docs/products/compute/compute-instances/guides/clone-instance/)
- [Physically Group Compute Instances to Meet Your Needs](/docs/products/compute/compute-instances/guides/placement-groups)
- [Initiate a Cross Data Center Migration](/docs/products/compute/compute-instances/guides/migrate-to-different-dc/)
- [Configure Email Alerts for Resource Usage on Compute Instances](/docs/products/compute/compute-instances/guides/resource-usage-email-alerts/)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Linode's cloning feature allows you to duplicate a Compute Instance's disks (and
This process copies all disks and configuration profiles to a newly created Compute Instance on your account.

{{< note >}}
Before continuing, it's recommended to power off the instance you would like to clone. This helps prevent data corruption.
Before continuing, you should power off the instance you want to clone. This helps prevent data corruption.
{{< /note >}}

1. Log in to the [Cloud Manager](https://cloud.linode.com).
Expand All @@ -30,15 +30,17 @@ Before continuing, it's recommended to power off the instance you would like to
1. Under **Select Linode to Clone From**, search for and select the instance you wish to clone. If the selected instance is running, **Power Off** appears to the right.

1. To help prevent data corruption during cloning, click **Power Off**.

{{< note >}}
If you're using a mobile device, available instances appear as cards without the Power Off option. To power off an instance from a mobile device, go to the instance's details page.
{{< /note >}}

1. Complete the remainder of the form. Enter a label and select the region, the plan, and other options for the new Compute Instance.

{{< note >}}
The plan's storage must be greater than the combined disk size of the original instance. If you wish to select a plan with less storage, you may need to [resize your disks](/docs/products/compute/compute-instances/guides/disks-and-storage/) before cloning.
- The plan's storage must be greater than the combined disk size of the original instance. If you wish to select a plan with less storage, you may need to [resize your disks](/docs/products/compute/compute-instances/guides/disks-and-storage/) before cloning.

- If the target Compute Instance is in a [placement group](/docs/products/compute-instances/guides/placement-groups), the clone isn't automatically included in the same placement group. You need to specify a placement group to include it in. The target placement group needs to have capacity to include a cloned Compute Instance and it needs to be in the same data center as the clone.
{{< /note >}}

1. Click the **Create Linode** button to start the cloning process. Cloning a Compute Instance can be much longer than creating a new instance based on a distribution image or custom image. The length of time depends on the size of the disks, among other factors. To keep track of the cloning progress, a status bar is displayed above the original Compute Instance with the percentage of completion.
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Copying a Disk to a Different Account"
title_meta: "How to Copy a Disk to a Different Account"
description: "Review this guide to find out how to copy a disk of a Linode from one Linode account to another."
published: 2020-06-01
modified: 2022-03-28
modified: 2024-06-20
keywords: ["disk", "migration", "moving to different accounts"]
tags: ["linode platform","cloud manager"]
image: copying_a_disk_to_a_differnet_account_smg.png
Expand All @@ -13,7 +13,7 @@ aliases: ['/migration/copy-disk-image-different-account/','/linode-platform/mana
You can copy a disk of a Linode from one Linode account to another. This is a great way to prepare a disk for another Linode customer and transfer it from one individual account to another individual account. Or if you have multiple Linode accounts, this guide provides instructions to consolidate all the disks in one account.

{{< note >}}
If you are copying a disk of a Linode that hosts applications, then ensure that you complete the backup and migrate steps for the respective applications.
If you're copying a disk from a Linode that hosts applications, then ensure that you complete the backup and migrate steps for the respective applications.
{{< /note >}}

## Preparing the Receiving Linode
Expand All @@ -23,18 +23,20 @@ You need to prepare the *receiving* Linode before initiating the transfer. First
### Creating a New Receiving Linode

1. Log in to the [Cloud Manager](https://cloud.linode.com) with the username and password you created when signing up.

1. Click **Create** at the top of the page and select **Linode**.

1. Click **X** to not choose any **Image** in the **Choose a Distribution** section of the [Distributions](/docs/products/compute/compute-instances/guides/distributions/) tab.

![Creating a receiving Linode](image-selection.png)

1. Choose the region where you would like the Linode to reside. If you're not sure which to select, see our [How to Choose a Data Center](/docs/products/platform/get-started/guides/choose-a-data-center/) guide. You can also generate [MTR reports](/docs/guides/diagnosing-network-issues-with-mtr/) for a deeper look at the route path between you and a data center in each specific region.
1. Choose the region where you would like the Linode to reside. If you're not sure which to select, see our [How to Choose a Data Center](/docs/products/platform/get-started/guides/choose-a-data-center/) guide. You can also generate [MTR reports](/docs/guides/diagnosing-network-issues-with-mtr/) for a deeper look at the route path between you and a data center in each specific region.

1. Select a Linode plan.
1. Select a Linode plan.

1. Give the Linode a label. This is a name to help you easily identify it within the Cloud Manager's Dashboard. If desired, assign a tag to the Linode in the **Add Tags** field.

1. Skip the **Root Password** and **SSH Keys** fields, as they are disabled when creating an empty Linode.
1. Skip the **Root Password** and **SSH Keys** fields, as they are disabled when creating an empty Linode.

1. Click **Create Linode**. The system directs you to the *Linodes* page that reports the status of the Linode as it boots up.

Expand All @@ -46,25 +48,31 @@ To hold the files transferred from the other Linode, create two new disks labele

1. Go to the **Storage** tab and click **Add a Disk** in the **Disks** section. The **Add Disk** window appears.

![Adding a disk](add_disk.png)
![Creating a receiving Linode](add_disk.png)

1. Type a descriptive name such as `copy` for the disk in the **Label** field.

1. Select `ext4` in the **Filesystem** dropdown field.

1. Set the size of the disk in the **Size** field. The size of the disk must be large enough to hold the contents of the disk that you want to copy.

1. Click **Add** to create the disk.
1. Repeat the steps to create a disk labeled `swap` and select `swap` in the **Filesystem** dropdown field.
Ensure that the size of the `swap` disk is the same as that of the `swap` disk of the disk that you want to copy.

1. Repeat the steps to create a disk labeled `swap` and select `swap` in the **Filesystem** dropdown field. Ensure that the size of the `swap` disk is the same as that of the `swap` disk of the disk that you want to copy.

The system creates disks to hold the files from the disk of other account.

### Booting into Rescue Mode

Start the receiving Linode in rescue mode:

1. Select the Linode that is receiving the disk. The Linode's dashboard appears.
1. Select the Linode that is receiving the disk. The Linode's dashboard appears.

1. Select the **More Options Ellipsis** and click the **Rescue** button.
1. Set the **/dev/sda** field to `copy` and **/dev/sdb** to `swap`.
1. Click **Reboot into Rescue Mode**.

1. Set the **/dev/sda** field to `copy` and **/dev/sdb** to `swap`.

1. Click **Reboot into Rescue Mode**.

### Access the Linode in Rescue Mode

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
39 changes: 25 additions & 14 deletions docs/products/compute/compute-instances/guides/create/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,27 @@ title: "Create a Compute Instance"
title_meta: "Create a Compute Instance on the Linode Platform"
description: "Learn how to create a new Compute Instance, including choosing a distribution, region, and plan size."
published: 2022-04-19
modified: 2024-05-21
modified: 2024-06-20
keywords: ["getting started", "deploy", "linode", "linux"]
aliases: ['/guides/creating-a-compute-instance/','/products/compute/dedicated-cpu/guides/deploy/']
---

This guide walks you through creating a Compute Instance (also frequently called a *Linode*) through the Cloud Manager. Whether this is your first time using Linode or if you're a long time user, you should carefully consider each step in the process to make sure you're getting the most of your Linode services.

1. [Open the Create Form in the Cloud Manager](#open-the-create-form-in-the-cloud-manager)
1. [Choose a Distribution, App, or Image](#choose-a-distribution-app-or-image)
1. [Select a Region](#select-a-region)
1. [Choose an Instance Type and Plan](#choose-an-instance-type-and-plan)
1. [Set the Label and Add Tags](#set-the-label-and-add-tags)
1. [Create a Password and Add SSH Keys](#create-a-password-and-add-ssh-keys)
1. [Assign to a VPC](#assign-to-a-vpc)
1. [Assign to a Cloud Firewall](#assign-to-a-cloud-firewall)
1. [Assign to a VLAN](#assign-to-a-vlan)
1. [Configure Additional Options](#configure-additional-options)
1. [Add User Data](#add-user-data)
1. [Deploy the Instance](#deploy-the-instance)
1. [Getting Started After Deployment](#getting-started-after-deployment)
- [Open the Create Form in the Cloud Manager](#open-the-create-form-in-the-cloud-manager)
- [Choose a Distribution, App, or Image](#choose-a-distribution-app-or-image)
- [Select a Region](#select-a-region)
- [Choose an Instance Type and Plan](#choose-an-instance-type-and-plan)
- [Set the Label and Add Tags](#set-the-label-and-add-tags)
- [Create a Password and Add SSH Keys](#create-a-password-and-add-ssh-keys)
- [Assign to a VPC (Optional) {#assign-to-a-vpc}](#assign-to-a-vpc-optional-assign-to-a-vpc)
- [Assign to a Cloud Firewall (Optional) {#assign-to-a-cloud-firewall}](#assign-to-a-cloud-firewall-optional-assign-to-a-cloud-firewall)
- [Assign to a VLAN (Optional) {#assign-to-a-vlan}](#assign-to-a-vlan-optional-assign-to-a-vlan)
- [Assign to a Placement Group (Optional) {#assign-to-a-placement-group}](#assign-to-a-placement-group-optional-assign-to-a-placement-group)
- [Configure Additional Options](#configure-additional-options)
- [Add User Data](#add-user-data)
- [Deploy the Instance](#deploy-the-instance)
- [Getting Started After Deployment](#getting-started-after-deployment)

## Open the Create Form in the Cloud Manager

Expand Down Expand Up @@ -130,6 +131,16 @@ Add this Compute Instance to a secure private network. VLANs are available at no
In most cases, it's recommended to use a VPC over a VLAN. VPCs operate on a higher network layer and come with more IP addressing and IP routing functionality. Additionally, you can further segment out network traffic through subnets, each of which has its own CIDR range. Review [these differences](/docs/products/networking/vpc/#difference-between-private-network-options-vpcs-vlans-and-private-ips) to learn more.
{{< /note >}}

## Assign to a Placement Group (Optional) {#assign-to-a-placement-group}

![Creating a receiving Linode](create-instance-pg.png)

Add this Compute Instance to a Placement Group to manage its physical location in a data center ("region"). Placement Groups can be set up to group your compute instances close together to help with performance, or further apart to support high availability. Placement Groups are available at no additional cost, but they're not available in all regions. See [Work with Placement Groups](/docs/products/compute-instances/guides/placement-groups) to learn more.

{{< note >}}
If you don't have an existing Placement Group, you can click **Create Placement Group** to create a new one. This takes you to a separate interface, outside creating your compute instance. For ease of use, create your compute instances in a supported region, then later create a Placement Group and assign your compute instances to it.
{{< /note >}}

## Configure Additional Options

The following features and services can be configured during the Compute Instance's creation or at any point after.
Expand Down
26 changes: 9 additions & 17 deletions docs/products/compute/compute-instances/guides/failover/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Configure Failover on a Compute Instance"
description: "This guide discusses how to enable failover on a Linode Compute Instance through using our IP Sharing feature with software such as keepalived or FRR."
published: 2022-03-23
modified: 2024-02-20
modified: 2024-06-20
keywords: ['IP failover','IP sharing','elastic IP']
aliases: ['/guides/ip-failover/']
tags: ["media"]
Expand Down Expand Up @@ -53,11 +53,8 @@ Within Linode's platform, failover is configured by first enabling [IP Sharing](
| Washington, DC (USA) | **Supported** | BGP-based (new) | [lelastic](/docs/products/compute/compute-instances/guides/failover/#configure-failover) / [FRR](/docs/products/compute/compute-instances/guides/failover-bgp-frr/) | 17 |

{{< note >}}
If a data center is marked as *undergoing network upgrades*, customers may encounter issues enabling IP Sharing and configuring failover. For Compute Instances that already have IP Sharing enabled, this feature should still function as intended. Once the network upgrades are completed, IP Sharing will be supported through the new method (BGP). Review documentation on our [planned network infrastructure upgrades](/docs/products/compute/compute-instances/guides/network-infrastructure-upgrades/) to learn more about these changes.
{{< /note >}}

{{< note >}}
IP failover for VLAN IP addresses is supported within every data center where VLANs are available. This feature does not depend on Linode's IP Sharing feature and depends on ARP-based failover software, such as keepalived.
- If a data center is marked as *undergoing network upgrades*, customers may encounter issues enabling IP Sharing and configuring failover. For Compute Instances that already have IP Sharing enabled, this feature should still function as intended. Once the network upgrades are completed, IP Sharing will be supported through the new method (BGP). Review documentation on our [planned network infrastructure upgrades](/docs/products/compute/compute-instances/guides/network-infrastructure-upgrades/) to learn more about these changes.
- IP failover for VLAN IP addresses is supported within every data center where VLANs are available. This feature does not depend on Linode's IP Sharing feature and depends on ARP-based failover software, such as keepalived.
{{< /note >}}

## IP Address Failover Methods
Expand All @@ -75,18 +72,13 @@ IP failover for VLAN IP addresses is supported within every data center where VL
The instructions within this guide enable you to configure failover using IP Sharing and the [lelastic](https://github.com/linode/lelastic) tool, a Linode provided tool based on GoBGP that automates much of the configuration. While lelastic enables many basic implementations of failover, you may want to consider using FRR or any other BGP client if your implementation is more advanced. See [Configuring IP Failover over BPG using FRR](/docs/products/compute/compute-instances/guides/failover-bgp-frr/).

{{< note >}}
If your data center supports the legacy method (ARP), use the [Configuring IP Failover using keepalived](/docs/products/compute/compute-instances/guides/failover-legacy-keepalived/) guide instead. That guide should also be used when setting up failover for VLAN IP addresses.
- If your data center supports the legacy method (ARP), use the [Configuring IP Failover using keepalived](/docs/products/compute/compute-instances/guides/failover-legacy-keepalived/) guide instead. That guide should also be used when setting up failover for VLAN IP addresses.
- If you've included your compute instances in a [placement group](/docs/products/compute/compute-instances/guides/placement-groups/), the group needs to use **Anti-affinity** as its Affinity Type, which spreads them out in a data center. The opposite Affinity Type, **Affinity** physically places compute instances close together, sometimes on the same host. This defeats the purpose of fail over.
{{< /note >}}

To configure failover, complete each section in the order shown:

1. [Create and Share the Shared IP Address](#create-and-share-the-shared-ip-address)
1. For *each* Compute Instance:
- [Add the Shared IP to the Networking Configuration](#add-the-shared-ip-to-the-networking-configuration)
- [Install and Configure Lelastic](#install-and-configure-lelastic)
1. [Test Failover](#test-failover)
To configure failover, complete each section that follows.

### Create and Share the Shared IP Address
### 1. Create and Share the Shared IP Address

1. Log in to the [Cloud Manager](https://cloud.linode.com/).

Expand All @@ -106,7 +98,7 @@ To configure failover, complete each section in the order shown:
When IP Sharing is enabled for an IP address, all connectivity to that IP address is immediately lost *until* it is configured on [Lelastic](#install-and-configure-lelastic), [FRR](/docs/products/compute/compute-instances/guides/failover-bgp-frr/), or another BGP routing tool. This is not an issue when adding a new IP address, but should be considered if you are enabling IP Sharing on an existing IP address that is actively being used.
{{< /note >}}

### Add the Shared IP to the Networking Configuration
### 2. Add the Shared IP to the Networking Configuration

Adjust the network configuration file on *each* Compute Instance, adding the shared IP address and restarting the service.

Expand Down Expand Up @@ -175,7 +167,7 @@ Adjust the network configuration file on *each* Compute Instance, adding the sha

Since the loopback interface is not used, you must also add the `-allifs` option to the lelastic command (discussed in a separate section below).

### Install and Configure Lelastic
### 3. Install and Configure Lelastic

Next, we need to configure the failover software on *each* Compute Instance. For this, the [lelastic](https://github.com/linode/lelastic) utility is used. For more control or for advanced use cases, follow the instructions within the [Configuring IP Failover over BPG using FRR](/docs/products/compute/compute-instances/guides/failover-bgp-frr/) guide instead of using lelastic.

Expand Down
Loading

0 comments on commit b28cf5b

Please sign in to comment.