Creating a service blueprint
Sample blueprint for the Kubernetes applications
The sample blueprint, Kubernetes Infrastructure Blueprint, represents the Kubernetes infrastructure. You can use this blueprint to create business services to monitor Kubernetes applications, for example, Train Ticket Management System. This application is used to manage train reservations. See the following sample blueprint for the Kubernetes infrastructure:
The sample blueprint for the Kubernetes applications contains the following information:
- Start node—Is a node of Namespace type.
- Default CI rule on the start node—Contains the following information:
- Default filter criteria set on the start node—Indicates that the name of the namespace is added as a variable.
This variable provides you the flexibility to specify the namespace name while creating a service by using the blueprint. According to the specified name, the entire service topology is populated. - Content of the namespace is required and must be included while creating a service by using this blueprint.
- Default filter criteria set on the start node—Indicates that the name of the namespace is added as a variable.
- Link rules—Indicate the relationship rules between different CI kind nodes.
For example, the Collection rule between the Namespace and Deployment nodes indicates that only those deployments that are members of the namespace are considered when a service is created by using the blueprint. - Traversal path and connected nodes—Are associated clusters, deployments, software pods, and hosts.
Use the steps described in the following procedure to create this blueprint.
Before you begin
- Understand the CIs and their relationships in the infrastructure for which you want to create a blueprint.
For example, if you want to create a blueprint for a Kubernetes-based application, understand the namespaces, clusters, and deployments, and relationships between them. - Identify the start node for the blueprint.
For example, determine if the blueprint starts at the hosts, applications, ESXi servers, or network devices.
To create a blueprint by using the available CIs and their relationships
- Log in to BMC Helix Portal and click the BMC Helix Service Modeling tile.
- On the BMC Helix Service Modeling homepage, click Blueprints.
- On the Service Blueprints page, click Create Service Blueprint.
- Specify the name, description (optional), and provider (domain) details for the blueprint.
For example, Kubernetes Infrastructure Blueprint, v1, itbiz.com or com.example. - To add the CIs, perform the following steps:
- On the Select CIs tab, click + Add CIs.
- The Add CIs page displays a list of categories and subcategories, by which you can easily search for the CIs that you want to add.
By default, CIs are displayed for the Host and Host Containers category and the Hosts subcategory. - Search for the required CIs by performing one of the following actions:
- Type the name of the CIs (minimum three characters).
- Select a category and a subcategory.
For example, select the Cloud & Container Orchestration category and the Namespace subcategory to add a namespace CI.
- Select one or more CIs to add them to the blueprint.
- To include the CIs that are related to the selected CI, use the Include Related CIs check box.
If you select only one CI, the check box is selected by default, which indicates that all the related CIs of the selected CI are added. (Optional) Clear the check box if you don't want to add the related CIs.
- Click Add and then click Close.
- (Optional) Set the blueprint display option to Organic. The default setting for this option is Hierarchic.
In the organic view, nodes are placed close to their adjacent nodes, thus saving space. In the hierarchic view, the nodes are distributed into layers. This view facilitates the identification of dependencies and relationships among the nodes.
Click Next Step.
Based on the selected CI in step 5, its CI kind (Namespace) is displayed as the start node. If you have selected the Include Related CIs check box in step 5, its relationship with other CI kinds, which are represented by other nodes, is also displayed.A default rule is added to the start node and link rules are added between different nodes.
- A default CI rule on the start node contains the following information:
- Default filter criteria set on the start node indicates that the name of the namespace is added as a variable.
This variable provides you the flexibility to specify the namespace name while creating a service by using the blueprint. According to the specified namespace, the entire service topology is populated. - Content of the namespace is required and must be included while creating a service by using this blueprint.
- Default filter criteria set on the start node indicates that the name of the namespace is added as a variable.
- Link rules indicate the relationship rules between different CI kind nodes.
For example, the Collection rule between the Namespace and Deployment nodes indicates that only those deployments that are members of the namespace are considered when a service is created by using the blueprint.
- A default CI rule on the start node contains the following information:
- (Optional) Edit the default CI rule, or add more CI kinds, CI rules, and link rules if this blueprint does not meet your blueprint requirements.
For information about adding CI kinds, CI rules, and link rules, see To create a service blueprint from CI kinds.
- To preview the blueprint, click Next Step and select the name for the namespace in the right pane.
The left pane shows the blueprint preview according to the selected namespace. By default, nodes of the same CI kind are grouped. - (Optional) Click Disable grouping by CI Kind to ungroup the nodes.
- Click Save to save the blueprint.
By default, the newly created blueprint is disabled. To create a service by using a blueprint, you need to enable it.
- To enable the blueprint preform the following steps:
- On the Service Blueprints page, click Show disabled.
- Click Actions on the blueprint that you created, and then click Enable.
For more information, see Actions available on service blueprints.
Sample blueprint for the AppDynamics applications
The following figure illustrates a sample blueprint for an AppDynamics application infrastructure. You can use this blueprint to create business services to monitor AppDynamics applications, for example, Retail Outlet. This application is used to manage outlets in a retail chain of restaurants:
The sample blueprint for the AppDynamics applications contains the following information:
Element | Description |
---|---|
Start node | Is a node of Software Cluster type. |
Default CI rule on the start node | Contains the following information:
|
Link rules | Indicate the relationship rules between different CI kind nodes. |
Traversal path and connected nodes | Associated software clusters, software components, software instances, and so on. |
For information about creating this sample blueprint for the AppDynamics applications, see To create a service blueprint by using CI kinds and establishing relationships between them.
Blueprints user interface elements
The following image gives an overview of the key user interface elements on the Service Blueprints page:
Actions available on Service Blueprints page
On the Service Blueprints page, use buttons such as the Show disabled, Import, and Action to perform actions on the blueprints. The following table provides information about these buttons:
Button | Description |
---|---|
Show disabled | By default, only enabled blueprints are displayed. To view the list of both enabled and disabled blueprints, click Show Disabled. |
View | View the blueprint in the View Service Blueprint canvas. |
Edit | Edit an existing blueprint created in BMC Helix Service Modeling. |
List related Services | The services that are currently using a blueprint are displayed. |
Enable | By default, only enabled blueprints are displayed. To enable a blueprint, click Show Disabled, and enable the desired blueprint by using the Actions menu |
Create new Blueprint from | A copy of the blueprint with the suffix, (copy) is created. |
Disable |
|
Export | The blueprint is exported to a JSON file in your default downloads folder. |
Import |
|
Delete |
|
Where to go from here