Blueprints are a saved and repeatable workflow that bundles components like Templates, Packages, and other Blueprints together. Blueprints should adhere to the following best practices for increased maintainability and a consistent user deployment experience.
See also the KB articles on
- Templates Best Practices
- Packages Best Practices
- Differentiating the Template, Package and Blueprint components
Workflow Components to Consider
When deploying new servers as part of a Blueprint make careful consideration of the following components:
- Always patch servers to the latest patch level (include the Linux Update or Perform Windows Update)
- If you have a demo mode or application available include a parameter to optionally install and configure as part of your Blueprint (as opposed to handling this out of band or of creating multiple Blueprints with largely matching functionality)
- Attach public IP addresses only on services that will receive inbound Internet traffic. Most customers access the cloud environment via secured private connectivity and don't see the public addresses. If your Blueprint is an Internet connected service that should be accessible to the Internet at large then skip this step
When to use Packages versus Blueprints
Simple Blueprints can be built that include only a package with no other components. Comparing the two deployment steps side by side we see the following experiences:
- Navigate to the Server Group.
- Select Package to execute and server(s) on which to execute.
- Complete deploy data collector.
- Can execute the same package on multiple servers within a single execution stream
- Easiest approach for adding capabilities to an existing server
- Always immediately clear this package will add capabilities to an existing server (vs. building a new server with the specified capabilities)
- Select Blueprint from library and click deploy.
- Select the existing server on which to execute.
- Complete deploy data collector.
Blueprints Are Stateless
If your deployment workflow involves multiple servers, such as deploying a new cluster, some mechanism external to Blueprints is needed to facilitate connection and initiation activities across the different servers. Common patterns for resolving this:
Deploying a "cluster"
If you only need to define a "master" server - see the Master and Slave Node Blueprint Example Package on Github. In this pattern the "master" is selected by the deploying user at deploy time from a drop down menu. Make careful use of the "Global" variable type as referenced in Blueprints Script and Software Package Management.
Adding to Existing Environment
If you are adding capacity to an existing environment the most common pattern is a drop down form where you can select an existing asset which the new server is able register with.
Caching Package Parameters
The parameter types and other metadata is embedded within the Blueprint definition. Changes to parameter names, types, etc. in an included package will not be reflected until the Blueprint is edited and republished.
General Blueprint Structure
Blueprints allow tasks, such as executing scripts or modifying system virtual hardware, to be executed either as part of a server build or after the server-build completes (Add Server vs. Tasks & Order pages). Best practices are to execute tasks within the Add Server page wherever possible.
If your state needs are more advanced, such as requiring key exchange, automated registering of new assets, self-discovery, etc. we recommend investigating the bpbroker toolset which was specifically created to support this workflow.
Adding a Public IP Address
Lumen Cloud includes an operation to add a public IP address to any server as part of the Blueprint deployment. Take note that this operation adds both an additional private IP address then NATs a new public IP to the server. In most scenarios what you really want is to execute the script package Create/Update Public IP NAT to Primary Private IP Address. If using the add public ip address task then the following behavior will result:
- Inbound requests to the public IP will always function as expected
- Egress traffic sourcing from the server will not come from the new public IP address. Egress traffic will appear to source from the public IP associated with the primary server IP address (this can only be configured via the control portal). If no public IP is associated with the primary server IP address then the traffic will be NATed behind a shared public IP address associated with a number of hosts in the datacenter.
|Scenario||Ingress Public IP||Egress Public IP|
|Default Deployment - No public IP, single default private IP||-||Shared public IP|
|Add public IP from control - Server has one private IP and a static NAT to the primary private IP||Static NAT to private IP address||Static NAT to private IP address|
|Add public IP from Blueprint - Server has two private IPs and a static NAT to the secondary IP||Static NAT to secondary private IP address||Shared public IP|