24 Setting Up the WebLogic Self Service Portal

This chapter describes the procedure to set up the Middleware Self Service Portal for WebLogic as a Service. It contains the following sections:

24.1 Setting Up the WebLogic Self Service Portal

The EM_SSA_ADMINISTRATOR can configure and set up the Middleware Cloud Self Service Portal by creating middleware pools, setting up quotas, defining request settings, configuring the load balancer, creating service templates, and configuring chargeback.

Figure 24-1 diagram shows the initial setup and the relationship between the various entities involved in setting up the Cloud Middleware Self Service Portal.

Figure 24-1 Setting Up WebLogic as a Service

Setting Up MWaaS (Physical Hosts)

Prerequisites

To set up the WebLogic as a Service, follow these steps:

  1. Set up one or more PaaS Infrastructure zones. See Section 11.2.2.1, "Creating a PaaS Infrastructure Zone" for details.

  2. Create a Middleware Pool. See Section 24.2, "Creating a Middleware Pool".

  3. Optionally, you can configure an external load balancer. See Section 24.3, "Creating a Load Balancer Configuration".

  4. Configure request settings. See Section 24.4, "Configuring Request Settings".

  5. Define quotas for each self service user role. See Section 24.5, "Setting Up Quotas".

  6. Create service templates. You can create service templates that can be used to provision an instance of a service in a set of selected zones. You can create physical or virtual service templates. See Section 24.6, "Creating a WebLogic Service Template".

  7. Optionally, you can configure the Chargeback Service. See Section 24.7, "Configuring Chargeback".

24.2 Creating a Middleware Pool

A Middleware Pool contains a set of resources that can be used to provision a service instance within a PaaS Infrastructure Zone. You must create separate Middleware pools in the PaaS Infrastructure Zone for each WebLogic version of Middleware Home.

Note:

A middleware pool must be configured only if you setting up MWaaS for the physical flow scenario. See Section 24.1, "Setting Up the WebLogic Self Service Portal".

To create a Middleware Pool, follow these steps:

  1. Log in to Enterprise Manager as a user with the EM_SSA_ADMINISTRATOR role.

  2. From the Enterprise menu, select Cloud, then select Cloud Home. The Cloud Home page appears.

  3. From the Oracle Cloud menu, select Setup, then select Getting Started. The common tasks that need to be performed before setting up a specific service family is displayed. Click the Setup link next to Middleware service family in the left panel.

  4. Select WebLogic from the service type drop down list.

  5. Click Middleware Pools. The existing middleware pools are listed on the Middleware Pools page.

  6. Click Create. The Create Middleware Pool: General page appears. Enter a name and description for the Middleware Pool. Select the PaaS Infrastructure Zone in which the middleware pool is to be created.

    Note: You can also navigate to this page by selecting Resource Providers from the Cloud Home menu. The Resource Provides Home page appears. Click Create and select Middleware Pool as the type of the resource provider to be created to launch the Create Middleware Pool wizard.

    Figure 24-2 Create Middleware Pool: General

    Create Software Pool: General
  7. Click Next. The Create Middleware Pool: Members page appears. Select the Operating System and Platform from the drop down list.

  8. Click Add to add one or more hosts to the middleware pool. Click Next.

    Note:

    The hosts you select must have the correct Oracle Home version. If the correct Oracle Home version is not present, service instance creation will fail.
  9. The Create Middleware Pool: Placement Constraints page appears. The placement constraints are used to set maximum limits on resource utilization for each host. In the Maximum Number of Java Servers (per host) field, enter the maximum number of Java Server instances that can be running on each host in the pool. Click Next.

  10. Specify the characteristics and target properties such as Middleware Home Base Directory, Lifecycle Status, Cost Center, and so on. Click Next.

  11. Review the information and click Submit to create the middleware pool. The newly created pool middleware pool can now be used to create the Middleware Service Template.

24.3 Creating a Load Balancer Configuration

Load Balancer Configurations are used to configure and route web traffic to middleware service instances. You can configure external pre-configured load balancers such as Oracle HTTP Server (OHS), Oracle Traffic Director (OTD) or a third party load balancer. If you want to configure a third party load balancer, you must use a custom script to update the load balancer configuration. For more details on this script, see Section 24.3.1, "Creating a Custom Script". A Middleware Pool or a Deployment Plan can be associated with only one of the load balancer configurations.

Note:

Setting up the Load Balancer Configuration is an optional step.

Prerequisites

  • The external load balancer being configured must be installed on an Enterprise Manager monitored host and is used to route Web traffic to one or more MWaaS service instances. When a MWaaS service instance is created, updated (scaled up or scaled down), or deleted, the load balancer configuration is automatically updated.

  • To route HTTPS Web traffic, you must do the following:

    • Create an OTD configuration (This is required only if you are configuring an Oracle Traffic Director type of load balancer).

    • Create or install a certificate.

    For more details configuring SSL authentication, refer to the Oracle Traffic Director Administrator's Guide and the Oracle HTTP Server Administrator's Guide.

To configure a load balancer, follow the steps below:

  1. Log into Enterprise Manager as an user with the EM_SSA_ADMINISTRATOR role.

  2. From the Enterprise menu, select Cloud, then select Cloud Home. The Cloud Home page appears.

  3. From the Oracle Cloud menu, select Setup, then select Getting Started. The common tasks that need to be performed before setting up a specific service family is displayed. Click the Setup link next to Middleware service family in the left panel.

    Note:

    You can use a different navigation path to reach this page. From the Cloud Home menu, select Setup, Service Settings, then click Middleware.
  4. Select WebLogic from the service type drop down list and click the Load Balancer Configuration link.

  5. Click Create to create a new load balancer configuration.

    Figure 24-3 Load Balancer Configuration: General

    Load Balancer Configuration: General
  6. Enter the following details:

    • Name of the load balancer configuration.

    • Select the type of load balancer being configured. This can be Oracle HTTP Server (OHS), Oracle Traffic Director (OTD), or a Third Party Load Balancer.

    • Select the host on which the load balancer is installed. This must be an Enterprise Manager monitored host.

    • Specify the Routing Protocol (HTTP, HTTPS, or both) and the Routing Port Range.

      Note:

      If you are configuring the Oracle HTTP Server, the Routing Port is required only for the http Routing Protocol. In this case, the port you specify must be the default port of the default virtual host.
    • Select the Monitoring Agent (Management Agent) and specify the Named Credentials.

  7. Click Next. The Create Load Balancer Configuration: Properties page appears.

    Figure 24-4 Create Load Balancer Configuration: Properties

    Create Load Balancer Configuration : Properties

    If you have selected the Load Balancer Type as:

    • Oracle HTTP Server: Enter the following details:

      • Instance Home: The directory in which the configuration data and binary files pertaining to Oracle HTTP Server instance is stored.

      • Component Name: The component in the specific instance that is to be configured.

    • Oracle Traffic Director: Enter the following details:

      • Oracle Home: The directory in which the Oracle Traffic Director binaries are installed.

      • Admin Protocol: Specify the protocol (HTTP or HTTPS) to be used by the Oracle Traffic Director Administration Server to forward requests. By default, this is HTTPS.

      • Admin Listen Port: Specify the Administration Server listen port number.

      • SNMP Port: The SNMP port configured for Oracle Traffic Director. The default port number is 11161.

      • Instance Node: Specify the Oracle Traffic Director Instance node name.

      • Configuration Name: This field is optional and is required only if you have selected the HTTPS or HTTP and HTTPS Admin Protocol. If you select the HTTP Admin Protocol, and do not specify a value in this field, the OTD Configuration Name is created as config1 by default. If the OTD Configuration has already been created, it must be a managed target in Enterprise Manager.

      • Certificate Name: This field is optional. If you selected the HTTPS or HTTP and HTTPS Admin Protocol, enter the name of the self signed certificate.

      • Virtual Server Name: The name of the virtual server. If the virtual server does not exist, a virtual server with the name specified here will be created. In this release, host patterns are not defined for each virtual server in the configuration.

      • Privileged Named Credentials: Specify the Named Credentials for the Administration Server.

    • Third Party Load Balancer: Select a script to configure the load balancer.

  8. Click Next. The Create Load Balancer Configuration: Targets page appears.

  9. Click Add to add one or more middleware pools (See Section 24.2, "Creating a Middleware Pool") with which the load balancer will be associated.

    Note:

    A Middleware Pool can be associated with only one load balancer configuration.
  10. Click Next. Review the configuration and click Submit to create the Load Balancer Configuration. The newly created load balancer configuration appears in the Load Balancer Configurations table. Click the Load Balancer Name link in the table to view the load balancer configuration details. This shows the targets associated with the load balancer configuration and middleware service instances that are using the configuration.

24.3.1 Creating a Custom Script

You can use a custom script to configure the load balancer. This script must be present in the Software Library as a directive. The directive must follow these guidelines:

  • LBR_Work_Directory: Specifies the directory in which the lbr.properties file will be staged. The name-value pairs present in the lbr.properties file are extracted by the custom script and these values are used to configure the load balancer.

  • The following properties must be present in the lbr.properties file:

    • THIRDPARTY_ROUTING_PROTOCOL: This can be http, https, or both.

    • THIRDPARTY_ROUTING_HTTP_PORT: Enter the http port number.

    • THIRDPARTY_ROUTING_HTTPS_PORT: Enter the https port number.

    • LBR_HOST: The host on which the load balancer is installed.

    • UNIQUE_URI_REFERENCE: The value specified here is used to create routing rules.

    • CONFIGURATION_ACTION: The actions that can be performed are:

      • CREATE: To create a service instance.

      • ADD_SERVERS: To scale up or add one or more servers.

      • DELETE_SERVERS: To scale down or delete one or more servers.

      • REMOVE: To delete a service instance.

  • HTTP_WLS_MANAGED_SERVER_PORT_LIST: A comma separated host:port (Managed Servers) list where port is a http port. For example, abc:123, xyz:456.

  • HTTPS_WLS_MANAGED_SERVER_PORT_LIST: A comma separated host:port (Managed Servers) list where port is an SSL port. For example, abc:123, xyz:456.

24.4 Configuring Request Settings

You can configure the request settings by specifying when a request can be made, its duration, and so on. To configure the request settings, follow these steps:

  1. Log into Enterprise Manager as a user with the EM_SSA_ADMINISTRATOR role.

  2. From the Enterprise menu, select Cloud, then select Cloud Home. The Cloud Home page appears.

  3. From the Oracle Cloud menu, select Setup, then select Getting Started. The common tasks that need to be performed before setting up a specific service family is displayed. Click the Setup link next to Middleware service family in the left panel.

    Note:

    You can use a different navigation path to reach this page. From the Cloud Home menu, select Setup, Request Settings, then select Middleware, and click WebLogic.
  4. Select WebLogic from the service type drop down list and click Request Settings.

  5. You can specify the following parameters to set the global settings or settings for a specific role.

    • FutureReservationLength: How far in advance a request can be scheduled.

    • MaximumArchiveRetention: Period after which the requests are automatically archived.

    • DefaultRetirementPeriod: The maximum period for which the service instance can be retained.

    • Service Instance Share Settings: You can choose to share the service instance with other users or roles by selecting either of the following checkboxes.

      • Enable SSA User to share service instances with other Users

      • Enable SSA User to share service instances with Roles

      Note: By default, service instances are not shared with users or roles.

    See Section 11.2.3, "Configuring Request Settings" for details on how to set these parameters.

  6. Click Apply.

24.5 Setting Up Quotas

Quota is the aggregate amount of resources that can be granted to each self service user belonging to a certain role. This quota applies only to the service instances provisioned through the Middleware Self Service Portal. Each service instance that is provisioned including new service requests and scale up of existing service instances is subject to the quota set by the user. When the self service user has used up his allocated quota, he cannot make new service requests until a higher quota is allocated or his existing service instances have been reclaimed.

To define a quota, follow these steps:

  1. Log into Enterprise Manager as a user with the EM_SSA_ADMINISTRATOR role.

  2. From the Enterprise menu, select Cloud, then select Cloud Home. The Cloud Home page appears. From the Oracle Cloud menu, select Setup, then select Getting Started.

    Note:

    You can use a different navigation path to reach this page. From the Cloud Home menu, select Setup, Quotas, then click Middleware.
  3. Click on the Setup link next to the Middleware Service family and select the WebLogic service type from the drop down list.

  4. Click the Quotas link and then click Create.

    Note:

    Quota validation ensures that a request is executed only if the user's current usage is within the limits specified for the roles to which the user belongs. Only the direct roles are considered for the quota determination, and not nested ones.
  5. In the Create Quota window, select the Role Name for which the quota is to be granted. Specify the quota limits for the role as follows:

    • Memory: The maximum memory that can assigned to the instances owned by a specific user.

    • Java Servers: The number of Java Servers that can be owned by a user at any point in time.

    Note:

    Only users that have the Cloud Self Service Portal privileges (users belonging to the EM_SSA_USER_BASE role) are displayed in the Select Roles dialog box.

24.6 Creating a WebLogic Service Template

A service template can be used to provision an instance of a service into a set of selected PaaS Infrastructure zones.

Prerequisites

  • Set up and enable MWaaS as described in Section 13.2, "Getting Started with Middleware as a Service".

  • A PaaS Infrastructure Zone must have been created.

  • A middleware provisioning profile (see Section 13.2.1, "Creating Provisioning Profiles") with appropriate values must be present in the Software Library.

  • A middleware pool must have been created.

  • The Oracle Home version in the profile or deployment procedure and the middleware pool must be the same.

  • Named Credentials must be created. If Named Credentials are used, the user creating the service template must be the owner of the Named Credentials.

To create a WebLogic Service Template, follow these steps:

  1. Log into Enterprise Manager as a user with the EM_SSA_ADMINISTRATOR role.

  2. From the Enterprise menu, select Cloud, then select Cloud Home. The Cloud Home page appears. From the Oracle Cloud menu, select Setup, then select Getting Started.

    Note:

    You can use a different navigation path to reach this page. Select Service Templates from the Oracle Home menu, click Create and select WebLogic service type.
  3. Click on the Setup link next to the Middleware Service family and select the WebLogic service type from the drop down list.

  4. Click the Service Templates link. You can create service templates that can be used to provision an instance of a service in a set of selected zones. Click Create.

  5. Enter a name and description for the service template. The description must be unique and provide information on the type of servzice template being created.

  6. In the Provisioning Profile field, click the Search icon and select a Middleware Provisioning profile. The Middleware Provisioning Profile you select can contain either of the following:

    • One cluster with one or more WebLogic Servers. You can scale up or scale down by adding or deleting WebLogic servers to this cluster.

    • One WebLogic Server. In this case, the Scale Up and Scale Down options are not available.

  7. Click Next. In the Create Service Template: Characteristics page, specify the characteristics that will be used to tag and identify the target properties. Service instances created from the template will have the characteristics.

  8. Click Next. The Resource Providers page appears:

  9. Click Add to select the Middleware Pool into which that the service instances can be provisioned. The PaaS Infrastructure Zone with which the middleware pool is associated is displayed.

    Note:

    • The Middleware Pool that you select must contain Oracle homes with the same WebLogic Server version as specified in the Middleware Provisioning Profile or the Middleware Configured Deployment Procedure you have selected in the Create Service Template: Name page.

    • If the Enable Load Balancer field is set to 1 in the Create New Service Template: Configuration page, when you click Search, only middleware pools associated with a load balancer configuration are displayed. If there are no middleware pools associated with load balancer configurations, the list will be blank.

  10. Click Next. The Configuration page appears. Enter the following details:

    • WebLogic Administration Credentials

      • WebLogic Username: Enter a value of minimum 8 characters as the name of the user logging into the WebLogic server. This is a mandatory field.

      • WebLogic Password: Enter a value of minimum 8 characters as the password for the WebLogic server user. This is a mandatory field.

    • Prescript and Postscript for Service Instance Creation and Deletion: Select the scripts that are to be executed before and after a service instance has been created or deleted. See Requesting a Middleware Service for details.

      The scripts must meet the following guidelines:

      • Directive that is created should be a PERL directive.

      • An input parameter named INPUT_FILE_LOCATION must be defined.

      • The path to the location of a property file must be specified in the INPUT_FILE_LOCATION parameter.

      • The property file contains information about the service instance and the domain.

    • Service Settings

      • Topology: This field is automatically set based on the profile you have selected in the Create Middleware Service Template for Physical: General page.

      • Expose WebLogic and FMW Console URLs to SSA User: If you select Yes, the users the users with the EM_SSA_USER role will have access to the WebLogic Admin Console and Fusion Middleware Control for each service instance created using this service template.�

        Note:

        This field must be set to Yes only if the EM_SSA_USER needs to have complete control over the WebLogic Server and Fusion Middleware Control consoles. The EM_SSA_USER will then be able to perform all configuration changes and life cycle management operations from each console.
      • Enable Load Balancer: Select Yes to enable the load balancer configuration for all the service instances that are created with this service template.

    • Port Range Start - End: Enter the port range for the WebLogic Server. The default start range is 1024 and the end range is 65000.

    • Placement Parameters

      • Expected Memory Consumption: Specify the memory required for each additional WebLogic Server instance. This parameter must be specified (cannot be left blank) and the value must match the -Xmx value specified in the profile. For example, if the profile specifies -Xmx512m, the memory required value must be set to 0.5. Similarly, a profile value of -Xmx1024m would need a memory required value of 1, and so on. Refer to the Note in Section 13.2.1, "Creating Provisioning Profiles" for more details.

      • Expected CPU Consumption: Specify the CPU required for each additional WebLogic Server instance.

      • Distribute Java Servers on Available Hosts: Select Yes to distribute Java servers uniformly on all available hosts or No to place as many Java servers as possible on a selected host before moving to the next available host.

        If this flag is set to Yes, service instances provisioned will have their managed servers set up and uniformly distributed on different hosts. This ensures high availability of the service even when one host is down because the Java Servers on other hosts will be contributing to this service. If only one host is available, all servers will be provisioned on the same host.

    • Server Startup Arguments

      • Managed Server Startup Arguments: Specify the memory and Java arguments required to start the managed server. These arguments are used to control the memory size of the JVM server and create multiple templates with the same profile. For example, you can specify -Xms1280m -Xmx1280m -XX:PermSize=128m -XX:MaxPermSize=256m -Dweblogic.security.SSL.ignoreHostnameVerification=true.

    • Resource Management Script Parameters

      • Resource Management Script: Specify the script for dynamic management of resources which allows you to increase or decrease the size of the middleware pool. This script must be present in the Software Library as a directive. For more details on the script parameters, see Section 24.6.1, "Resource Management Script"

      • Host for Executing Resource Management Script: Select the host on which the resource provisioning script is be executed.

      • Named Credential for Host: Specify the named credentials for the selected host.

  11. Click Next. The Create Service Template: Roles page appears. Click Add to select the self service user roles to which this service template will be available. All users belonging to the selected role can use this service template.

  12. Click Next. The Create Middleware Service Template: Review page appears. Review the information entered so far and click Submit. The newly created service template will appear in the Middleware Cloud Self Service Portal Setup: Service Templates page. You can click on the Service Template Name link to view additional details.

    To edit an existing MWaaS service template, follow these steps:

    1. Click Edit in the Service templates page to launch to the Edit Service Template wizard.

    2. In this mode, you can modify the description, user name, password, and port range of the WebLogic Server instance being provisioned, add or remove PaaS Infrastructure Zones, Software Pools into which the template is being deployed, and add or remove users who can use this template.

24.6.1 Resource Management Script

The Resource Management Script specifies the location of the property file which contains a list of name value pairs. The content of the file varies based on the Create, ScaleUp, ScaleDown, and Delete operations.

24.6.1.1 Create Operation

The content of the file for the Create operation are:

ACTION=CREATE

ZONE_NAME=<value>

POOL_NAME=<value>

NUMBER OF SERVERS BEFORE THIS REQUEST=<value>

NUMBER OF SERVERS REQUESTED=<value>

NUMBER OF SERVERS POSSIBLE WITH AVAILABLE RESOURCES=<value>

NUMBER OF SERVERS NEEDED=<value>

MAXIMUM SERVERS ALLOWED PER HOST=<value>

MIDDLEWARE_HOME=<value>

EXPECTED CPU UTILIZATION IN PERCENTAGE=<value>

EXPECTED MEMORY CONSUMPTION IN GB==<value>

24.6.1.2 Scaleup Operation

The content of the file for the Scaleup operation are:

ACTION=SCALEUP

ZONE_NAME=<value>

POOL_NAME=<value>

NUMBER OF SERVERS BEFORE THIS REQUEST=<value>

NUMBER OF SERVERS REQUESTED=<value>

NUMBER OF SERVERS POSSIBLE WITH AVAILABLE RESOURCES=<value>

NUMBER OF SERVERS NEEDED=<value>

MAXIMUM SERVERS ALLOWED PER HOST=<value>

MIDDLEWARE_HOME=<value>

DOMAIN_NAME=<value>

EXPECTED CPU UTILIZATION IN PERCENTAGE=<value>

EXPECTED MEMORY CONSUMPTION IN GB==<value>

24.6.1.3 Scaledown Operation

The content of the file for the scaledown operation are:

ACTION=SCALEDOWN

ZONE_NAME=<value>

POOL_NAME=<value>

NUMBER OF SERVERS BEFORE THIS REQUEST=<value>

NUMBER OF SERVERS BEING REMOVED=<value>

HOSTS FROM WHERE SERVERS BEING REMOVED=<value>

MIDDLEWARE_HOME=<value>

DOMAIN_NAME=<value>

24.6.1.4 Delete Operation

The content of the file for the Delete operation are:

ACTION=SCALEDOWN

ZONE_NAME=<value>

POOL_NAME=<value>

NUMBER OF SERVERS BEFORE THIS REQUEST=<value>

NUMBER OF SERVERS BEING REMOVED=<value>

HOSTS FROM WHERE SERVERS BEING REMOVED=<value>

MIDDLEWARE_HOME=<value>

DOMAIN_NAME=<value>

24.7 Configuring Chargeback

Click the Chargeback tab to add the middleware pools to the Chargeback Application. On this page, you can determine chargeback zones, services, items, and prices. After Chargeback is set up, you can view charges and plan details.

You can configure chargeback and metering data based on the configuration and monitoring metrics collected from associated targets such as the host, managed server, and the PaaS Infrastructure Zone. The charge plans are based on the host, WebLogic (domain, cluster, and server), PaaS Infrastructure Zone, and configuration such as the WebLogic Domain version, OS version, vendor, and so on.

For details on setting up the Chargeback Service, see Chapter 33, "Chargeback Administration".