Deploying a New Linode Using a StackScript

Updated Tuesday, June 2, 2020 by Linode Written by Linode

What are StackScripts?

StackScripts provide Linode users with the ability to automate the deployment of custom systems on top of Linode’s default Linux distribution images. For example, every time you deploy a new Linode you might execute the same tasks, like updating your system’s software, installing your favorite Linux tools, and adding a limited user account. These tasks can be automated using a StackScript that will perform these actions for you as part of your Linode’s first boot process.

All StackScripts are stored in the Linode Cloud Manager and can be accessed whenever you deploy a Linode. A StackScript authored by you is an Account StackScript. While a Community StackScript is a StackScript created by a Linode community member that has made their StackScript publicly available in the Linode Cloud Manager.

In this Guide

This guide will show you how to do the following:

• Deploy a new Linode using an Account StackScript.
• Access the contents of an Account StackScript to view its underlying script and metadata.
• Deploy a new Linode using a Community StackScript.
• Access the contents of a Community StackScript to view its underlying script and metadata.

Note

To learn how to create your own StackScript see the Writing Scripts for Use with Linode StackScripts guide.

Account StackScripts

An Account StackScript is any StackScript that you create. It will be stored in the Linode Cloud Manager where you can access it to use when deploying a new Linode. By default, your Account StackScripts are only visible on your account and can only be used by you to deploy a new Linode.

This section will show you how to deploy a new Linode using an Account StackScript and how to access your Account StackScripts.

Note

To learn how to make your Account StackScript publicly available see the A Tutorial for Creating and Managing StackScripts guide for more details.

Deploy a Linode from an Account StackScript

1. Log into the Linode Cloud Manager.

2. Click on the Create button at the top of the Linode Cloud Manager and select Linode. This will take you to the Linodes Create page.

   

3. Click on the My Images tab to access different sources you can use from which to create a Linode.

4. Viewing the My Images page, click on the Account StackScripts tab. On this page you will be able to see a list of all of your account’s StackScripts.

   

5. From the list, select the StackScript you would like to use to deploy your new Linode instance.

   View this StackScript's Details

   To view the details of a StackScript prior to using it to deploy your Linode, click on its Show Details link.

   

6. In the StackScript Options section, fill in values for your StackScript’s Options. Not all StackScripts are written to accept option values, so your StackScript might not present this section.

   Note

   When writing a script to be used in a StackScript, these option values are made available to users by including user defined fields in your script.

7. From the Select an Image dropdown menu, select the Linux distribution to use. This list will be limited to the distributions your StackScript supports.

8. Choose the region where you would like your Linode to reside. If you’re not sure which to select, see our How to Choose a Data Center guide. You can also generate MTR reports for a deeper look at the route path between you and a data center in each specific region.

9. Select a Linode plan.

10. Give your 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.

11. Create a root password for your Linode in the Root Password field. This password must be provided when you log in to your Linode via SSH. It must be at least 6 characters long and contain characters from two of the following categories:

    • lowercase and uppercase case letters
    • numbers
    • punctuation characters

12. Click Create. You will be directed back to your new Linode’s Summary page which will report the status of your Linode as it boots up.

Access an Account StackScript

1. Log into the Linode Cloud Manager.

2. Click on the StackScripts link in the left-hand navigation menu. You will be brought to the StackScripts page.

   

3. Viewing the Account StackScripts tab, you will see a list of all of your account’s StackScripts.

4. To view the details and contents of an Account StackScript, click on the StackScript you would like to view to access its StackScript detail page.

   

5. If you would like to deploy a new Linode from the Account StackScript you are viewing, click on the Deploy New Linode at the top of the StackScript detail page.

   

   You will be brought to the Linodes Create page which will have your Account StackScript selected. Continue to provide the rest of the required configurations to create your Linode. See step 6 in the Deploy a Linode from an Account StackScript section for details on the remaining configurations.

Community StackScripts

Community StackScripts are any scripts that have been created by a Linode community member and are publicly available via the Linode Cloud Manager. You can deploy a new Linode using any Community StackScript.

This section will show you how to deploy a new Linode using a Community StackScript and how to access the contents of a Community StackScript.

Note

Linode does not verify the accuracy of any Linode Community member submitted StackScripts. Prior to deploying a Linode using a Community StackScript, you should ensure you understand what the script will execute on your Linode.

Deploy a Linode from a Community StackScript

1. Log in to your Linode Cloud Manager account.

2. At the top of the page, click Create and select Linode.

   

3. Click on the One-Click tab to access the Create From options.

4. Viewing the Create From: options, click on the Community StackScripts tab. On this page, you will see a list of all available Community StackScripts.

   

   You can scroll through the list of StackScripts or you can use the Search field to locate the Community StackScript you’d like to use. You can search by StackScript username, label or description. For example, to search for a Community StackScript by username, you can enter username:LinodeApps into the search field.

5. From the list, select the Community StackScript you would like to use to deploy your new Linode instance.

   View this Community StackScript's Details

   To view the details of a StackScript prior to using it to deploy your Linode, click on its Show Details link.

   

6. In the StackScript Options section, fill in values for your StackScript’s Options. Not all StackScripts are written to accept option values, so your StackScript might not present this section.

   Note

   When writing a script to be used in a StackScript, these option values are made available to users by including user defined fields in your script.

7. From the Select an Image dropdown menu, select the Linux distribution to use. This list will be limited to the distributions your StackScript supports.

8. Choose the region where you would like your Linode to reside. If you’re not sure which to select, see our How to Choose a Data Center guide. You can also generate MTR reports for a deeper look at the route path between you and a data center in each specific region.

9. Select a Linode plan.

10. Give your 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.

11. Create a root password for your Linode in the Root Password field. This password must be provided when you log in to your Linode via SSH. It must be at least 6 characters long and contain characters from two of the following categories:

    • lowercase and uppercase case letters
    • numbers
    • punctuation characters

12. Click Create. You will be directed back to your new Linode’s Summary page which will report the status of your Linode as it boots up.

Access a Community StackScript

1. Log into the Linode Cloud Manager.

2. Click on the StackScripts link in the left-hand navigation menu. You will be brought to the StackScripts page.

   

3. Click on the Community StackScripts tab. You will see a list of all available Community StackScripts.

   

   You can scroll through the list of StackScripts or you can use the Search field to locate the Community StackScript you’d like to use. You can search by StackScript username, label or description. For example, to search for a Community StackScript by username, you can enter username:LinodeApps into the search field.

4. To view the details and contents of a Community StackScript, click on the StackScript you would like to view to access its StackScript detail page.

   

5. If you would like to deploy a new Linode from the Account StackScript you are viewing, click on the Deploy New Linode at the top of the StackScript detail page.

   

   You will be brought to the Linodes Create page which will have your Community StackScript selected. Continue to provide the rest of the required configurations to create your Linode. See step 6 in the Deploy a Linode from a Community StackScript section for details on the remaining configurations.

Next Steps

• After deploying a new Linode using a StackScript you can connect to your Linode via SSH and verify that the StackScript has executed as expected. These steps will vary depending on the StackScript that you used when deploying your Linode.

  Note

  Depending on the contents of your StackScript, it may take a few minutes for the script to finish executing.

• To learn how to create your own StackScript see the A Tutorial for Creating and Managing StackScripts guide.

Join our Community

Find answers, ask questions, and help others.

This guide is published under a CC BY-ND 4.0 license.