This is documentation for the current major version Apprenda 7.
Documentation for older versions are also available.

Component-Level Configuration

This page describes the component-level configuration options available to your applications. The settings described on this page can be found on the Configure>Components page.

To view or change settings for individual application components, select specific category of application component (Databases, Java Web Applications, Web Services, Web Sites, Windows Services) from the Application Tier dropdown menu. After that selection is made, select a specific application component from the Component dropdown menu to the right.

Available setting options will vary depending on what type of component is selected. For example, some settings may only be available for Java Web Application components, and not available for Database components. All component settings can be changed at any point in the application version's Lifecycle. Current settings will be selected or displayed in input fields. After updating any desired settings, click the Save button to the lower right, or click the Cancel button next to it to revert any changes you don't want to keep.

General

An application's Current Resource Policy, along with that policy's Allocated CPU and Allocated Memory settings, can be viewed here, and the Resource Policy assigned to the component can be updated by clicking the arrow to the right of the policy name (this arrow directs to the Policies sub-tab under the application version's Scale tab, where Resource Policy and Storage Quota settings can be updated).  Java Web Application components will also have the option of selecting the Java Runtime Version the component should use.

Java Web Application components viewed here will offer several additional configuration options. You are able to select the Deployment Container that will host deployed instances of the component. The available container choices will depend on configurations made by your Platform Operator, and may include Tomcat 6, Tomcat 7, JBoss EAP 6, or other Tomcat or JBoss versions added by your Platform Operator. JMX monitoring can also be enabled or disabled.

The Platform also supports custom Log4j formatting for Java Web Application components. The desired format should be specified in the Log Pattern field. Any change made in this field will take immediate effect and does not require you to redeploy existing components. The conversion characters with their respective data types can be found at http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/PatternLayout.html 

While the conversion characters are able to pull in specific fields, you are not limited to only conversion characters, and can make your own messages including or excluding conversion characters as you see fit. The default value is %-6r [%15.15t] %-5p %c - %m%n

Security

Credentials

Specific run-as Credentials the Platform should use when deploying instances of the selected application component can be set here. If no credentials are set, the Platform-wide default settings for the component type will be used.  For Java Web App components, enter the User Name for deployments to Linux machines and the associated Platform-defined Token for that User Name. For a user interface, .NET service, and Windows Service component types, enter the Domain, User Name, and Password for the account to be used for workload deployment to Windows machines.

To set or change the token/password, click the Set or Change the Token/Password for this User Name. Note that passwords are not required for a User, however if you click this option, but do not enter a password before clicking save, the Platform will attempt to save an empty string as the password. If you decide to not set or update a password, you can click on the Cancel Token/Password changes option, which will appear in place of the Set or Change the Token/Password for this User Name option, before saving. This will only update the User Name.

Trusted Certificates for Java Web Applications

Java Web Application components will also have the option of adding any Trusted Certificates that may be needed for the app component to establish SSL connections to a host.  Click the "Add" button in order to select a certificate file on the local machine or enter a URL for the certificate file location.

Deployment

The configuration options in this section relate to deployment concerns for an application component. You can set Custom Properties or environment variables for your application here.

Custom Properties

Custom Properties are tags (usually defined by the Platform Operator) that you can apply to individual application components. Depending on the rules your Platform Operator has configured for Platform behavior, the way you apply Custom Property tags to an application or component may affect how that object is hosted on the Platform. Custom Properties will not affect the object's behavior, only how the Platform will manage the object. 

You may or may not be able to edit a Custom Property depending on Operator-defined settings. Platform Operators can also determine if a Custom Property is required for deployment, in which case Developers must set a value for the property before the Platform can deploy the application.

In this section, any Custom Properties that are required or for which values have been set will always be visible. It's also possible that no Custom Properties are available for an application or component. See more about Custom Properties and how they affect the Platform.

To view all available Custom Properties, click Show Unused/Unrequired Properties to toggle visible. To hide any unused properties, click Hide Unused/Unrequired Properties link that appears in the same place when all properties are shown.

To edit a Custom Property value, click the associated pencil icon. Depending on the Platform settings in place for that Custom Property, you may be able to select multiple values for the property, or enter a custom value in the input field. You might also be limited to a single value choice selected from a dropdown menu.

Environment Variables

As of Platform version 7.1, you can also set environment variables for WCF services, Windows Services, Java Web Applications, Linux Services (including Docker), in this section. Note that environmental variables are not supported for .NET UIs. Additionally, you are not able to change environment variables for Kubernetes Pods in this section. Environment variables for Kubernetes components must be set at the container level in the Pod spec file. See the Kubernetes documentation for more on setting environment variables for containers.

Any defined environment variables for a supported component type are shown in this section. From this section you are to add, edit, or remove environment variables. Changes to environment variables will affect all future deployments of the component. Any currently deployed workload will not be affected, and must be re-deployed to enable the changes.

The input box accepts XML definitions of your environment variables. All variables must be placed within the <environmentVariables></environmentVariables> tags.

To add a new environment variable, click into the editor and begin making your changes. If you click + Add New Value below the input box, the definition of a new environment variable will be created for you in the input box. Click Save (or Cancel to revert your changes).

To edit or remove an environment variable, click into the editor and make the desired changes to the variable definition. Click Save when you are finished (or Cancel to revert your changes).