Creating Public Blueprint Packages

Updated by Bryan Friedman on Oct 20, 2014
Article Code: kb/945


Lumen Cloud offers users the ability to create packages as a way to consistently run specific scripts or executables on one or more servers. These packages also provide the user with a method of defining a given set of parameters that allow for the gathering of information at deployment time so that it may be passed to the script to be used during the execution. (Read about [Blueprints Script and Software Package Management](../../blueprints/blueprints-script-and-software-package-management/) for more information on how to create packages in general.) These scripts can be executed directly against one or more servers, or they may be included [tasks that are run as part of a Blueprint definition](../../blueprints/how-to-execute-a-blueprint/).

These packages are very often specific to a function that may only be applicable to a particular set of users. As such, packages are generally created in the context of a single account and marked as either Private (only visible to users in the account where it was created) or Private Shared (visible to users in the account where it was created and all sub-accounts underneath it). However, if a package is created that could be useful for other users and accounts, it may be published as a Public package so all users are able to utilize it. In this case, there are some additional considerations to be addressed and steps to be followed.

Public Package Considerations

Lumen Cloud users are encouraged to submit packages as public if they feel they are appropriate for public consumption and potentially useful for other customers. When creating packages that are intended to be published as publicly available, be sure to take the following items into consideration:

  1. Naming - There is a preferred naming convention to follow for packages that will be made public. The following form should be used when naming packages intended to be public:

    on (x of #) []
    Example: Install Active Directory Domain Services on Windows (1 of 2) [Primary Node]

    • is usually "Install" or some other word that describes the primary action the package is doing.
    • is the name of the software.
    • should generally be either "Linux" or "Windows" or in some cases, the specific version of Linux (RedHat, Ubuntu) or Windows (2008, 2012) if other similar packages exist for different versions.
    • (x of #) is optional but should be included if the package is used as part of a series of packages that should be run a specific order.
    • is also optional but can be included if there is a short piece of additional information that is helpful in describing better what the package does. It should be surrounded by square brackets [ ] and put at the end of the name.
  2. Parameters - Any time a package is created it should use parameters as much as possible to provide flexibility so that it may be used in many environments. This is particularly true for packages that will become public. Avoid using anything hardcoded (IP addresses, server names, passwords, etc.) and make things as configurable as possible through the use of parameters. Also, keep in mind that your package will be replicated to all Lumen Cloud DCs, so there also should be no DC-specific dependencies built in.

  3. Licensing - Be aware of the licensing requirements for any software included in the package. Of course, using free or open source keeps this easy, but if you are using commercial software, be sure the package includes licensing validation.

  4. Maintenance - If possible, the package script should be written in a way that it does not need to be updated frequently as new software versions become available. At the very least, every effort should be made to write it so it is as easy/trivial as possible to update it for new versions (or new OS templates) as needed.

  5. Testing - Public packages are definitely not built for one-time use, so testing them should of course be more rigorous than quick throwaway packages. Consider all possible OS template versions that it will (or will not) work on and, if possible, write scripts in a way that they can be repeatedly deployed, even on the same server, and end up with the same result.

How to Publish a Public Package

  1. After creating the package and taking all of the above considerations into account, follow the instructions outlined in the article about Blueprint Script and Software Package Management to publish the package. For the final step, be sure to select "Public" as the visibility choice. After a package is published with public visibility, it is put into a "pending" state and must be approved by a Lumen Cloud Administrator before it is available for public use. (Users in the account where it was created will still be able to use it in existing Blueprints while it is in a pending state.)

  2. Send an e-mail to with the subject of "Package Approval" and be sure to include your account alias, the name of the package in the request, and a brief description of what it is and how to use it (if not clear from the package definition).

  3. After reviewing and testing the package, if there are no issues found, the package will be approved by a Lumen Cloud Administrator. Once approved, it will appear in the public packages library to be used on servers and in Blueprint definitions.