Manual Chapter : CE file for application management
Applies To:Show Versions
BIG-IQ Centralized Management
CE file for application management
When you create a new service catalog template, you specify a set of objects that can be used to create an application service. Later, when you use this service catalog template to create an application service, you can specify values for the objects that are defined as editable. Properties the template defines as not editable are not visible when you create an application service, but are included using the default values specified in the service catalog template. This allows you to maintain a consistent environment. When you use this template to create a service catalog template application service, BIG-IQ deploys the objects to your managed BIG-IP devices.
BIG-IQ provides user interface screens that help you to create and edit Application Services 3 Extension (AS3) templates. A finished template is actually the body of a JSON declaration that the AS3 service can use to deploy applications to your managed devices. But the BIG-IQ user interface builds the JSON body for you, so you don't need to learn to create well-formed JSON to create an AS3 application service.
You create a new device template to specify a base configuration to create devices in a service scaling group (SSG). When you deploy the SSG, BIG-IQ uses the device template settings to create new virtual devices in your cloud environment. Not all objects are required in every environment. The table lists the object types that you can configure along with details about how the SSG uses those details.
When you specify the properties for an AS3 class that requires a block of text (for example, a certificate, a private key, or an iRule), you must use extra care to make sure that BIG-IQ can process the text that you provide. If you must type this text, do not use the backslash character (for example:
\nas a new line or
\ras a return). AS3 does not process text that contains these characters. If you find these characters in text that you need to use, you can:
- Copy the body text to a text editor.
- Replace any instances of\nor\rwith an actual new line (press the Return or Enter key to get a new line).
- Remove any instances of\(For example\”10”\becomes“10”).
- Copy the resulting text string and paste it in the text box.
One potentially common scenario that requires moving or merging application services occurs when you use an API to create an AS3 application service. The AS3 API creates these services as components of an application named
Unknown Applications. You can organize these API-created services (using the
Mergebutton) to organize these services into the application that works best for you.
You cannot merge or move an application service to an application created with a different template type. That is, a service catalog application service cannot be a part of an AS3 application, and vice versa. Further, a legacy application service cannot be part of an application created with either type of template.
You cannot use this work flow to make substantive changes to a legacy application (one that uses virtual servers previously deployed to a managed device). Except for enabling, disabling or forcing offline virtual servers, pools, or pool members, you make changes to legacy applications by editing the virtual server settings. Refer to
Managing Virtual Serversin the
BIG-IQ Centralized Management: Local Traffic and Network Implementationsguide on
- At the top of the screen, clickApplications, then, on the left, clickAPPLICATION TEMPLATES.The screen lists the AS3 and service catalog templates defined on this BIG-IQ.
- At the top of the screen, clickApplicationsthen, on the left, clickAPPLICATIONS.The screen lists the applications currently defined on this device.
- In the list of applications, click the name of the one that you want to add an application service to.The screen displays the list of application services defined for this application.
- At the top of the screen, clickApplicationsthen, on the left, click .
- At the top of the screen, clickApplicationsthen, on the left, click .
- Under Service Catalog Templates, clickCreate.The Create Service Template screen opens to General Properties.
- Under AS3 Templates, clickCreate.
- ClickCreate.The New Cloud Environment screen opens.
- ClickCreate.The New Cloud Provider screen opens.
- ClickCreate.The Create Application Service screen opens.
- ClickCreate.The Create Application Services screen opens and, because you are editing an existing application, theGroupingandApplication Namesettings are disabled.
- Decide whether you want to add a service to an existing application or to create a new application and application service.To add a service to a new application:
To add a service to an existing application:
- For Grouping, selectNew Application.
- ForApplication Name, type a name for the new application.
- You can type aDescriptionto identify the new application.
- For Grouping, selectPart of an Existing Application.
- FromApplication Name, select the name of the application to which you want to add this application service.
- You can type aDescriptionto identify the application.
- If you manage version 15.0.1 or later BIG-IP devices, make sure that the virtual servers that deploy with this application use an HTTP profile compatible with the BIG-IP devices in your SSG.The default HTTP profile included in version 15.0.1 BIG-IP devices use a value (Sustain) for the Response Chunking and Request Chunking parameters that is not compatible with the devices that deploy in an SSG. If you manage version 15.0.1 devices, you must make sure to specify virtual servers that use an HTTP profile that is compatible with the devices in an SSG.If you manage some BIG-IP devices that run version 15.0.1, but you also manage some devices that run a version earlier than 15.01:Use a version of HTTP profile compatible with the earlier versions so you can deploy an application to the SSG.
If you manage only BIG-IP devices running versions earlier than 15.0.1,You need to create an HTTP profile that is compatible with the devices that run on an SSG, and make sure you use that HTTP profile when you deploy an application to the SSG.
- On the Edit Template screen, under LOCAL TRAFFIC, selectHTTP Profiles.
- From the select list about half way down the screen, select HTTP Profiles.
- Select the check box for an HTTP profile that is compatible with BIG-IP versions earlier than 15.0.1.
- ClickAdd Selected.
- On the Edit Template screen, under LOCAL TRAFFIC, select HTTP Profiles.
- For Request Chunking, select theOverridecheck box and then specify a value other thanSustain.
- For Response Chunking, select theOverridecheck box and then specify a value other thanSustain.
- ClickSave & Close.
- Specify property values for the remaining objects that deploy with this application service.
- When you have configured the objects that you want to include in this application, clickCreate.BIG-IQ creates the application with the application service you defined, then deploys it to the target you specified.
- Use theApplication NameandDescriptionsettings under Application Properties to identify this application.
- Select the template you want to use to create an application from, and then clickCreate Application.
- Use theApplication Service NameandDescriptionsettings under General Properties to identify the application service.
- For theTemplate Type, select the service catalog template you want to use to create this application from.
- For theTemplate, select the service catalog template you want to use to create this application from.You must use one of these following templates:
- A custom template cloned from either of these two templates.
- At the top of the screen, clickDevicesthen, on the left, click .
- Type aNameand (optional)Descriptionfor the service catalog template you are creating.Once you define the name, you can either save the template and define the default objects for this template later, or you can define them now. This workflow continues on, showing you how to import objects that already exist on devices managed by this BIG-IQ. For details about other ways to define objects, refer toCreate a service catalog template starting with a clone of an existing templateorCreate a service catalog template by manually specifying objectsonsupport.f5.com.
- Type a briefDescriptionfor the service catalog template you are creating, to help identify it when you want to use it later.
- On the left, underPROPERTIES, expand , and then select any object type.For example, you could expandLOCAL TRAFFIC, and then clickVirtual Servers.The screen lists any objects defined for this template along with buttons you can use to import or create new objects.
- On the left, underPROPERTIES, expandLOCAL TRAFFICorSECURITY POLICIESand then select any object type.For example, you could expandLOCAL TRAFFIC, and then clickVirtual Servers.Until you configure at least one virtual server for this template, you cannot select any security policies to attach to the virtual servers in this template.
- On the left, underProperties, expandLocal TrafficorSecurityand then select the object type you want to edit.For example, you could expandLocal Traffic, and then clickVirtual Servers.You can edit the settings for this template either manually or by importing existing objects.
- Click the name of the AS3 template that you want to edit.You cannot edit a published template. If the template has been published, but has not been used to deploy an application, you can unpublish it to make it writable. If the template has been used to deploy an application, you have two options:
The properties area displays the list of currently defined services for the selected template.
- Make a clone of the published template and make your changes to the clone. For details, refer toClone an AS3 templateonsupport.f5.com..
- Use theSwitch to templatebutton to change the template that the application uses. For details, refer toChange the template for a deployed applicationonsupport.f5.com..
- Specify theTenantname for this template.
If you have deployed configuration objects to BIG-IP devices and you plan to use this template to deploy application services to those same devices, do not choose aTenantname that might match the name of partitions on which your previously deployed configuration objects reside. For more detail on how AS3 uses the tenant name and guidelines for using this control effectively, see AS3 tenant name details.
- To allow the name to be specified when this template is used to deploy an application service, selectEditable.
- To specify the name here, clear theEditablecheck box and type a name for theTenant.
- Review the classes defined in the template you selected, and revise any values that need to be tailored to your specific requirements.
- To add or remove classes defined in this template, on the left, underPROPERTIES, clickAdd/Remove.
- Select or clear check boxes for the classes that you want to add or remove from this template, until all of the objects your application service needs are included. Then clickSaveto display the new list of classes below the template Properties on the left.For detailed AS3 class definitions and descriptions of what each property controls, refer to schema-reference.html#service-https.The AS3 JSON schema defines default values for each class property. You can either leave a property at the default, or specify a new default value. You can also specify which property values can be seen and revised when this template is used to create an application service
- For each class you added, decide which properties you want to specify, and which properties must be specified when this template is used to deploy an application service.When you use this template to create an application service, BIG-IQ uses your specifications to define the class properties that make up the AS3 declaration that deploys the application service. If you do not specify values for a property, the declaration uses default values from the AS3 JSON schema.
Some AS3 classes support a different set of property fields depending on the type of schema used to parse the AS3 class definition. For these classes, you can choose the type of schema (Basic SchemaorAdvanced Schema). Each schema type uses a different set of fields to specify the class. For these class properties you can toggle between the schema types to display the set of fields needed to specify the AS3 class to meet your business needs.As you specify property values for each class, the JSON Detail area displays the AS3 declaration for that class as you have defined it.When you configure properties that need to have a new value specified each time you use this template to deploy an application service, make sure they areEditable. Then, when you (or your designate) deploy this application service, it's obvious which properties to supply values for: If it is visible, supply a value.Templates often create objects that are used by other objects that are created in the same template. However, when you use these objects in your template, you need to use care. If you specify a name for an object, and also allow it to be edited, then when the application deploys, BIG-IQ looks for the name specified in the template. However, if you made the object editable, the person deploying the application service could edit that name to something else, in which case BIG-IQ will not find that object and the deployment fails. To ensure successful application deployment, the best practice is to leave editable objects in the template un-named so that the application deployer can use the name that best suits their need at the time.
- To specify a default value and make sure that BIG-IQ uses that value for that property, specify a value for that property, but do not selectEditable.
- To specify a default value but allow it to be changed when the template is used to deploy an application, specify a value for that property and selectEditable.
- To leave the default property value as is, but allow it to be specified during deployment, selectEditable, but do not specify a default value for that property.
- When you are ready to use a template to create an application, select it and clickPublish.BIG-IQ changes this template to read-only status, so you can use it to create a new application service that deploys to your BIG-IP devices.
- If you are ready to use this template to create an application service, clickPublish & Close.BIG-IQ changes this template to read-only status, so you can use it to create a new application service that deploys to your BIG-IP devices.
- If you are done with this template, but not ready to use it to create a new application service, clickSave & Close.
- Blank StepBIG-IQ creates the application and deploys the application service to the target you specified.
When you to deploy an AS3 application service, BIG-IQ creates or updates the configuration objects defined by that service on the managed device you targeted. You can view these objects, as they perform their function as part of an application service, on the application services dashboard.
Before you can view these newly-deployed objects on the Configuration tab, you must rediscover and re-import services for each service impacted by the deployment. Keep in mind that objects deployed with AS3 are view-only on the Configuration tab. To make changes to these objects, you make changes to the AS3 application.