CliQr is now part of Cisco Learn More About Cisco

Service Properties

Overview

A service is a mid-tier building block for an application. The concept of services is natural to the CloudCenter platform.  The concept of services like Tomcat, NginX, MongoDB, and so forth existed within the internal CloudCenter platform and exposes them via the Topology Modeler. The list of CloudCenter-supported services are available in the Services page.

You can Define a Custom Service or use a CloudCenter-supported Service to model/deploy applications using one or more of the following options:

General Settings

This section is unique based on how the service was defined. The user-editable parameters (defined for each service) are displayed in this section.

Icon

You must configure the information explained in this section to ensure that the application is functioning.

Properties

Description

Name

A descriptive name for this service.

Base Image

The Base OS Images in which you are installing this service.

Minimum number of nodes

The minimum number of nodes (VMs) in this cluster.

If the number of active VMs (nodes) is lower than the number specified in this field, then the application may not function as designed.

Maximum number of nodes

The maximum number of nodes in this cluster.

Once the number specified in this field is reached, then the application cannot be scaled.

Number of Volumes

Number of persistent data storage volumes for Web Server. 

See Multiple Volumes for additional context.

Default Volume Size

Persistent data storage for Web Server. Persistent Storage is defined by default for database tiers, but can be assigned manually to any tier

See Multiple Volumes for additional context.

App Package

Application package file (the binaries for the web server). The file is in relative path from http://env.cliqrtech.com/.

See Model Using Application Packages for additional context.

App Config files

This field is specific to the web server. Application config files that contain system Parameters and Macros that may need to be modified at deployment time. The config file uses a relative path from the web app root folder, for example, webinfo.conf. If you are configuring multiple files, separate each file in the list using a semicolon.

See Configuration Files and Parameter Substitution for additional context.

Deploy Folder

This field is specific to the web server. When you deploy an web server application, use this field to specify the /service/var/www/html root path where the folder must be created. For example, if your folder is called Doc, then this folder is created as /apache/var/www/html/Doc.

The app binaries are unzipped in this folder before deployment.

Scaling Policy

See Policies for additional context. 

If you are in Governance mode, the Scaling Policy can only be applied using System Tags.

Associate Tags

You can associate system tags with application profiles and application deployments, either at the tier level or globally. You also can use system tags to add system tag matching rules to aging policies, scaling policies, security profiles, and deployment environments.

See System Tags for additional context.

External Initialization

Defines the scripts to be run before (pre) and after (post) the start of the Service or pre/post stopping of the service when the application is rebooted, suspended, or terminated.

External Initialization scripts are run at the same time as their equivalent service initialization scripts, but are run from an isolated container on Docker (see Dedicated Docker Registry Installation).

See External Service for additional details on this section.

Icon

You must configure the information explained in this section:

  • If your deployment uses external services, to ensure that the application is functioning.
  • To ensure that the node is functioning.

Properties

Description

VM Pre-Prevision ScriptScript executed before the application VM is provisioned.
VM Pre-Initialization ScriptScript executed before the application VM service is initialized.
VM Post-Start ScriptScript executed after the application VM service is started.
VM Pre-Terminate ScriptScript executed before the application VM is terminated.
VM Post-Terminate ScriptScript executed after the application VM is terminated.

Node Initialization & Clean Up

Icon

You must configure the information explained in this section to ensure that the application is functioning.

See Deployment Lifecycle Scripts for additional details on this section.

Icon

Each node initialization and clean up script is run once for each VM function.

Properties

Description

Initialization script

Downloaded and executed at deployment time. See Deployment Lifecycle Scripts > Lifecycle Action Script Definition.

Cleanup script

Downloaded and executed at the time of deployment termination. See Deployment Lifecycle Scripts > Lifecycle Action Script Definition.

Resume Script

Downloaded and executed when the VM is suspended and restarted. See Deployment Lifecycle Scripts > Lifecycle Action Script Definition.

Deploy Packages

External packages required for each VM are bundled and referenced as an application content package in the application profile. For example, php5 sendmail. See the following pages for additional details:   

Sudo command list

Specify a list of semicolon separated commands to allow additional SUDO access to certain scripts if using the Linux OS. For example, SUDO ALL (to allow the user to run at the root level).

Service Initialization

This section defines the scripts to be run before (pre) and after (post) the start of the Service or pre/post stopping of the service when the application is rebooted, suspended, or terminated.

Once the node initialization is complete, CloudCenter downloads the Bundle Store to the VM and unzips the file in the specified location. See Deployment Lifecycle Scripts for additional details.

Icon

You must configure the information explained in this section to ensure that the application is functioning.

Icon

Service initialization actions at the application tier level are not called automatically. You must call them explicitly from within the service scripts.

This behavior is different from other initialization actions (like external initialization and node initialization actions) that are called automatically.

Properties

Description

Pre-Start ScriptScript executed before the service is started.
Post-Start ScriptScript executed after the service is started.
Pre-Stop Script Script executed before the service is stopped.
Post-Stop ScriptScript executed after the service is stopped.

Firewall Rules

Firewall rules are applied to both the OS firewall and the Cloud Security Groups. The default firewall rule for a service are automatically displayed in this section if it is the top tier for the app or at any tier level if microsegmentation is enabled. If service-level microsegmentation is enabled, you can restrict any firewall rule to any tier by specifying the tier name or IP for the source. See Security and Firewall Rules for additional context.

As soon as you connect the service in the Topology Modeler, the IP column in the Firewall Rules section automatically updates to display the Apache service tier name. You can choose to keep the preconfigured firewall definition or add additional Firewall rules as required. 

PropertiesDescription
IP Protocol

Defines the protocol to be used by VMs running this service.

  • TCP: Transmission Control Protocol
  • UDP: User Datagram Protocol
From Port

The initial port number of the port range to use for the inbound firewall rule (or security rule).

To PortThe final port number of the port range to use for the inbound firewall rule (or security rule).
IP/CIDR/TIERThe default CIDR for the application tier defaults to 0.0.0.0/0.

Custom Parameters

Once the Node initialization is complete, the application is capable of functioning as configured. Once the node is up, the utility files can be sourced in the script.

Icon

To add additional parameters that are specific to each step or tier, provide the following information for each parameter. See Using Parameters for additional context.

Properties

Description

Parameter NameIdentifies the name for this custom parameter.
Display NameIdentifies the display details for this custom parameter.
Help TextIdentifies the help text required when using this custom parameter.
TypeSee Using Parameters > Parameter Type.
Default ValueIdentifies a default value, if provided, for this custom parameter.
User Option ChecksSee Granular Control for User-Defined Parameters.

Hardware Specification

Identifies the hardware specification for each application tier. This section provides the ability to filter the instance type based on your minimum hardware provisioned for your deployment.

Properties

Description

CPUs NeededSee Hardware Requirements.
MemorySee Hardware Requirements.
Network InterfacesSee IP Allocation Mode. 

Scratch Disk Storage (Local Storage )

See Manage Instance Types.
Provision Hardware ServerSee Provision Bare Metal Hardware Servers.

Environment Variables

Environment variables help servers find the directory to install files, the location to store temporary files, and the settings to find the user profile(s).

This section is similar to Custom Parameters for N-Tier applications. The only difference is that you can define the type for Custom Parameters (type is not configurable for Environment Variables).

Properties

Description

NameIdentifies the name for this environment variable.
ValueIdentifies a value for this environment variable.

User Options

  • Visible
  • Editable
  • Optional

See the following pages for additional context:

Migration

You can set migration parameters that your application may need here. The migration for the Database tier will be done automatically, if the scripts are not specified. See Deployment Lifecycle Scripts for additional context.

Properties

Description

Pre Migrate ScriptScript is executed before the backup.
Backup ScriptBackup Script writes the backup files to a Backup Folder.
Backup Location

Location (path) where the application files are backed up/restored.

This is a required field for any application requiring data backup.

Restore ScriptRead from the backup files in the Backup folder. The Restore Script runs after the service is started and the Post-Start Script has run, except in case of the Database tier, where the Post-Start Script runs after the Restore Script.
Post Migrate ScriptScript executed after the restore is run.

Upgrade

You can upgrade an existing deployment by specifying the upgrade scripts for each tier. Specify the upgrade parameters in the sequence to be executed. See Deployment Lifecycle Scripts for additional context.

Properties

Description

Upgrade Type

Define upgrade scripts for the node:

  • Auto: Upgrade the tier with latest package and any backup/restore content (if specified).
  • Advance: Allow additional scripts and steps during the upgrade process. You can specify scripts for each step separately.
  • None: Exclude the Node/Tier from upgrading.
Pre Upgrade ScriptScript is executed before the upgrade.
Post Upgrade ScriptScript is executed after the upgrade.

Other References

TaskReference Link
Model a new application profileSee New Application Profile.
Model an applicationSee New Application.
Understand the Topology ModelerSee Topology Modeler.
Understand application modelingSee Application Lifecycle Management.
Understand script lifecycle flowSee Deployment Lifecycle Scripts.
List of supported servicesSee Services.
Add a New ServiceSee Define a Custom Service.
Manage Services and ScriptsSee Service Administration.
ParametersSee Using Parameters.
  • No labels