Scaling Up or Scaling Out Middleware Deployment Procedure

The process of increasing a cluster's capacity by adding additional server instances to the cluster on an existing machine, or adding machines to the cluster to host the new server instance, is called Scaling up. Scaling Up and Scaling Out Managed Server can be achieved through the command line using EM CLI commands available in Enterprise Manager 13c.

In this use case, the Instance GUID of the SCALEUP procedure is retrieved, which in turn is used to retrieve the input properties file of this instance of the procedure. After making necessary updates to the properties file, like adding another user-friendly so on, the procedure is submitted with the updated properties file as the input:

Here is the step-by-step process:

  1. To retrieve the GUID of the Deployment Procedure, run the following command:
    ./emcli get_procedures | grep SCALEUP_       

The output appears in the following format:
<proc_guid>, <procedure_type>, <Procedure_name>, <Dsplay name>, <version>, <Parent procedure name>

For example:
./emcli get_procedure | grep SCALEUP
B35E10B1F154B4EEE040578CD78179DC, FMW Provisioning, SCALEUP DP, Scale up/Scale out Middleware, 2.0, ORACLE
  2. Use the Instance GUID retrieved in the previous step to get input properties of an instance of the procedure:
    ./emcli get_instance_data -instance=<instance_guid> -exec=<execution_guid>

For example:

emcli get_instance_data -instance=B35E10B1F140B4EEE040578CD78179DC > instanceData.properties
A properties file with the name instanceData.properties is created.

    Note:

    This step is valid only if the instances of the procedure is available, which means that the procedure should have been submitted at least once in the past. If you have never submitted the procedure, then you may see an error message as follows:

    Instance with GUID=<guid> is not found in repository. Please make sure the value is correct and try again.

  3. Use an editor to open the generated properties file instanceData.properties, and update the existing values in the properties file.

    For example, here is a sample properties file used with the values updated. For information about these parameters, see Table A-2. 

    COHERENCE_ENABLED=false
DOMAIN_TARGET_NAME=/Farm03_base_domain/base_domain
ONLINE_MODE=true
DOMAIN_TYPE=General
TEMPLATE=template.jar
TEMPLATE_NAME=mytemplate
APPS_ARCHIVE=apps.zip
ADMIN_HOST_NAME=example.com
ADMIN_LISTEN_ADDRESS=10.240.34.37
ADMIN_LISTEN_PORT=7002
ADMIN_PROTOCOL=t3
ADMIN_WLS_USERNAME=weblogic
ADMIN_WLS_PASSWORD=<password>
ADMIN_WORK_DIR_LOC=/tmp/scaleUpSrc
FARM_PREFIX=Farm03
OMS_WORK_DIR_LOC=/tmp
ARCHIVE_FILE_NAME=archive.jar
CLONING_JAR_NAME=cloningclient.jar
SESSION_TS_LOC=/20151013122409043
REF_PREREQ_ZIP=prereq.zip
REF_SIZE_FILE=sizeprereq
IS_CLONE=false
IS_PLAIN=true
NOT_WINDOWS=true
USE_OWNER_CREDENTIALS=true
APPS_LIST_FILE_NAME=files.list
PREREQ_ONLY_DP=false
COMPUTE_SKIP_CLONE=true
USE_EXISTING_HOME=false
IS_OHS_EXIST=false
IS_CUSTOM_LOCAL_DOMAIN=false
IS_SERVER_MIGRATION=false
WLS_VERSION=10.3.6.0
IS_EXEC_PREREQ=false
CONFIGURE_JOC=false
ADMIN_HOST.0.name=example.com
ADMIN_HOST.0.type=host
ADMIN_HOST.0.normalHostCreds=NAME:<password>:user1
ADMIN_HOST.0.SERVER_ADDRESS=example.com
ADMIN_HOST.0.IS_SERVER_MIGRATABLE=false
ADMIN_HOST.0.ORACLE_HOME=n/a
ADMIN_HOST.0.SERVER_PORT=19030
ADMIN_HOST.0.DOMAIN_HOME_ADMIN_HOST=/scratch/oracle_wls/mwBase/domains/base_domain
ADMIN_HOST.0.MIDDLEWARE_HOME=/scratch/oracle_wls/mwBase/middleware
ADMIN_HOST.0.TLOG_DIR=/scratch/oracle_wls/mwBase/domains/base_domain/servers/Managed_Server1/tlogs
ADMIN_HOST.0.CLUSTER_NAME_ADMIN_HOST=Cluster_1
ADMIN_HOST.0.JDK_LOC=/ade_autofs/gd29_3rdparty/nfsdo_generic/JDK7/MAIN/LINUX.X64/150608.1.7.0.85.0B015/jdk7/jre
ADMIN_HOST.0.SSL_PORT=0
ADMIN_HOST.0.EX_PATTERN=*.mem
ADMIN_HOST.0.MS_OVERRIDE_PORT=0
ADMIN_HOST.0.CLONE_MODE=true
ADMIN_HOST.0.WORK_DIR_LOC_ADMIN_HOST=/tmp/scaleUpSrc
ADMIN_HOST.0.MACHINE_NAME_ADMIN_HOST=Machine_1
ADMIN_HOST.0.WLS_HOME_ADMIN_HOST=/scratch/oracle_wls/mwBase/middleware/wlserver_10.3
ADMIN_HOST.0.SOURCE_SERVER_NAME=Managed_Server_1
ADMIN_HOST.0.SERVER_NAME_ADMIN_HOST=Managed_Server1
DEST_MANAGED_SERVERS.0.name=example.com
DEST_MANAGED_SERVERS.0.type=host
DEST_MANAGED_SERVERS.0.normalHostCreds=NAME:<password>:user1
DEST_MANAGED_SERVERS.0.START_SERVER_REQUIRED=true
DEST_MANAGED_SERVERS.0.JOC_PORT=9988
DEST_MANAGED_SERVERS.0.WLS_HOME_DEST_MANAGED_SERVERS=/scratch/oracle_wls/mwBase/middleware/wlserver_10.3
DEST_MANAGED_SERVERS.0.MACHINE_NAME=Machine_1
DEST_MANAGED_SERVERS.0.SERVER_NAME_DEST_MANAGED_SERVERS=Managed_Server1
DEST_MANAGED_SERVERS.0.JRE_LOC=/usr/local/packages/jdk7
DEST_MANAGED_SERVERS.0.START_NM=false
DEST_MANAGED_SERVERS.0.START_MS_USE_NM=true
DEST_MANAGED_SERVERS.0.NM_LISTEN_ADDRESS=example.com
DEST_MANAGED_SERVERS.0.CLUSTER_NAME_DEST_MANAGED_SERVERS=Cluster_1
DEST_MANAGED_SERVERS.0.DOMAIN_HOME_DEST_MANAGED_SERVERS=/scratch/oracle_wls/mwBase/domains/base_domain
DEST_MANAGED_SERVERS.0.NM_LISTEN_PORT=5558
DEST_MANAGED_SERVERS.0.FMW_HOME_DEST_MANAGED_SERVERS=/scratch/oracle_wls/mwBase/middleware
DEST_MANAGED_SERVERS.0.WORK_DIR_LOC_DEST_MANAGED_SERVERS=/tmp/scaleUpDest
DEST_MANAGED_SERVERS.0.MS_PORT_DETAILS=19030:Listen Port
DEST_MANAGED_SERVERS.0.DEST_MANAGED_SERVER_LISTEN_ADDRESS=example.com

    Table A-2 describes the parameters used in the aforementioned example.

    Table A-2 Description of the Parameters Used in a Properties File for Scaling Up or Scaling Out a WebLogic Server

    Parameter Description

    COHERENCE_ENABLED

    If set to True, then Coherence is configured through deployment procedure. If set to False, then Coherence is not configured through deployment procedure.

    DOMAIN_TARGET_NAME

    Name of the domain target.

    ONLINE_MODE

    If set to True, then the scaleup operation is done when other servers and applications are up and running. If set to False, then the scaleup operation is done when other servers and applications are not up and running.

    DOMAIN_TYPE

    Domain type. For wls, the value is General. For SOA, the value is soa.

    TEMPLATE

    Server template jar file name. For example, template.jar.

    TEMPLATE_NAME

    Server template name. For example, mytemplate.

    APPS_ARCHIVE

    Applications archive file name. For example, apps.zip.

    ADMIN_HOST_NAME

    Name of the host where the administration server is running.

    ADMIN_LISTEN_ADDRESS

    Administration Server Listen Address. (HostName/IP Address where Admin Server is running).

    ADMIN_LISTEN_PORT

    Administration Server Listen Port.

    ADMIN_PROTOCOL

    Type of protocol used by the administration server.

    ADMIN_WLS_USERNAME

    User name to connect to the Weblogic domain.

    ADMIN_WLS_PASSWORD

    Password to connect to the Weblogic domain.

    ADMIN_WORK_DIR_LOC

    Absolute path to the working directory of the administration server.

    FARM_PREFIX

    Farm prefix of the domain where you want to add a server.

    OMS_WORK_DIR_LOC

    Absolute path to the working directory of the OMS.

    ARCHIVE_FILE_NAME

    Archive file name. For exaple, archive.jar.

    CLONING_JAR_NAME

    Cloning client jar name. For example, cloningclient.jar.

    SESSION_TS_LOC

    Session time stamp. For example, /20151013122409043.

    REF_PREREQ_ZIP

    Prerequisite zip file name. For example, prereq.zip.

    REF_SIZE_FILE

    Reference prereq size file. For example, sizeprereq.

    IS_CLONE

    Set to False by default.

    IS_PLAIN

    Set to True, if domain is a plain wls.

    NOT_WINDOWS

    Set to False, if domain is present on the Windows box. Set to True, if domain is not present on the Windows box.

    USE_OWNER_CREDENTIALS

    Set to True to set the same owner's credentials.

    APPS_LIST_FILE_NAME

    Set the value to files.list. files.list that contains the list of all the applications running on the server.

    PREREQ_ONLY_DP

    Prerequisite mode. If set to true, then the deployment procedure only runs the

    prerequisite checks and pauses for you to examine the checks.

    COMPUTE_SKIP_CLONE

    By default, set to True, and therefore skips cloning. Set to false to avoid skipping cloning.

    USE_EXISTING_HOME

    Set to True, if the server is created on the same host where the middleware home is already present. Else, set to False and create mwh.

    IS_OHS_EXIST

    Set to True, if the domain is OHS frontended. Else, set it to False.

    IS_CUSTOM_LOCAL_DOMAIN

    Set to True if custom local domain exists. Default value is False.

    IS_SERVER_MIGRATION

    Set to True if the server is migratable. Set it to False if the server is not migratable.

    WLS_VERSION

    Version of the Oracle WebLogic Server.

    IS_EXEC_PREREQ

    Set to True if OUI (product specific) prerequisite needs to be executed on destination server host. Else, set it to False.

    CONFIGURE_JOC

    Set to True if Java object cache needs to be configured on the scaling up server. Else, set it to False.

    ADMIN_HOST.0.name

    Administration Server host name.

    ADMIN_HOST.0.type

    Administration Server host type.

    ADMIN_HOST.0.normalHostCreds

    Administration Server host login credential.

    ADMIN_HOST.0.SERVER_ADDRESS

    .Administration Server host address.

    ADMIN_HOST.0.IS_SERVER_MIGRATABLE

    Set to True if the Administration Server host is migratable. Set to False if the Administration Server host is not migratable.

    ADMIN_HOST.0.ORACLE_HOME

    Administration Server Oracle Home location.

    ADMIN_HOST.0.SERVER_PORT

    Administration Server listen port.

    ADMIN_HOST.0.DOMAIN_HOME_ADMIN_HOST

    Domain home location present in Administration Server host.

    ADMIN_HOST.0.MIDDLEWARE_HOME

    Middleware home location present in Administration Server host.

    ADMIN_HOST.0.TLOG_DIR

    TLOG directory location present in Administration Server host.

    ADMIN_HOST.0.CLUSTER_NAME_ADMIN_HOST

    Cluster name present in the Administration Server host.

    ADMIN_HOST.0.JDK_LOC

    Absolute path to the JDK home on the Administration Server host.

    ADMIN_HOST.0.SSL_PORT

    SSL listen port, if SSL is configured on Administration Server.

    ADMIN_HOST.0.EX_PATTERN

    Value is '*.mem.

    ADMIN_HOST.0.MS_OVERRIDE_PORT

    Managed server override port, if SSL is configured on the Administration Server.

    ADMIN_HOST.0.CLONE_MODE

    Set to True, if the server scaling up is cloned from another server. Else, set to False.

    ADMIN_HOST.0.WORK_DIR_LOC_ADMIN_HOST

    Working directory location of the Administration Server host.

    ADMIN_HOST.0.MACHINE_NAME_ADMIN_HOST

    Machine name present in the Administration Server host.

    ADMIN_HOST.0.WLS_HOME_ADMIN_HOST

    Weblogic home of the Administration Server host.

    ADMIN_HOST.0.SOURCE_SERVER_NAME

    Set to True, and then specify the source server name.

    ADMIN_HOST.0.SERVER_NAME_ADMIN_HOST

    Server name of the Scaling up Server.

    DEST_MANAGED_SERVERS.0.name

    Destination managed server host name.

    DEST_MANAGED_SERVERS.0.type

    Destination managed server type.

    Value is host.

    DEST_MANAGED_SERVERS.0.normalHostCreds

    Destination managed Server host login credential.

    DEST_MANAGED_SERVERS.0.START_SERVER_REQUIRED

    Set to True if the server needs to be started after adding it to the domain. Else, set to False.

    DEST_MANAGED_SERVERS.0.JOC_PORT

    Set the Java Object Cache port number to 9988, if it needs to be configured for the destination managed server.

    DEST_MANAGED_SERVERS.0.WLS_HOME_DEST_MANAGED_SERVERS

    WebLogic home for the destination managed server.

    DEST_MANAGED_SERVERS.0.MACHINE_NAME

    Name of the destination managed server machine.

    DEST_MANAGED_SERVERS.0.SERVER_NAME_DEST_MANAGED_SERVERS

    Name of the destination managed server.

    DEST_MANAGED_SERVERS.0.JRE_LOC

    Absolute path to the JDK home on the destination host.

    DEST_MANAGED_SERVERS.0.START_NM

    If destination managed server is associated with a existing Machine in running state, then START_NM is set to False. If destination managed server is associated with a new machine, then set to True and start the machine.

    DEST_MANAGED_SERVERS.0.START_MS_USE_NM

    If destination managed server is associated with a machine, then set to True. Else, set to False.

    DEST_MANAGED_SERVERS.0.NM_LISTEN_ADDRESS

    Listen address of node manager of the machine that is associated with the destination managed server.

    DEST_MANAGED_SERVERS.0.CLUSTER_NAME_DEST_MANAGED_SERVERS

    If destination managed server is a part of the cluster, you specify the cluster name.

    DEST_MANAGED_SERVERS.0.DOMAIN_HOME_DEST_MANAGED_SERVERS

    Domain Home Location.

    DEST_MANAGED_SERVERS.0.NM_LISTEN_PORT

    If destination managed server is associated with a machine, you specify the node manager listen port.

    DEST_MANAGED_SERVERS.0.FMW_HOME_DEST_MANAGED_SERVERS

    Middleware home of the destination managed server.

    DEST_MANAGED_SERVERS.0.WORK_DIR_LOC_DEST_MANAGED_SERVERS

    Working directory location of destination managed server host.

    DEST_MANAGED_SERVERS.0.MS_PORT_DETAILS

    Destination managed server listen port.

    DEST_MANAGED_SERVERS.0.DEST_MANAGED_SERVER_LISTEN_ADDRESS

    Destination managed server listen address.
  4. Submit the procedure with the generated properties file as the input:
    ./emcli submit_procedure -input_file=data:<input_properties_file> -procedure=<proc_guid> -instance_name=<optional_DP_Instance_Name>

./emcli submit_procedure -input_file=data:instanceData.properties -procedure=B35E10B1F140B4EEE040578CD78179DC