Before You Begin

This 30-minute tutorial shows you how to fulfill the necessary prerequisites before installing PeopleSoft Cloud Manager on Oracle Cloud Infrastructure.

Background

Use Cloud Manager to deploy PeopleSoft environments in Oracle Cloud Infrastructure Compute (Compute) for demonstration, testing, development, and production. Cloud Manager delivers a way to define your own PeopleSoft environments and save them as deployment templates. These templates can then be used by self-service users to create their own environments either for their development or testing.

PeopleSoft Cloud Manager deploys PeopleSoft environments on Linux VMs and uses a Microsoft Windows VM to install PeopleSoft PeopleTools components.

The tutorials in this series describe processes used by the Cloud Administrator in installing and setting up Cloud Manager on a Compute virtual machine instance. For information about using Cloud Manager to create topologies and templates, provision environments, and other information on using Cloud Manager after installation, see the PeopleSoft Cloud Manager online documentation. To locate the documentation, select Online Help (HTML) or PeopleBooks (PDF) on the PeopleSoft Cloud Manager page on the Oracle Help Center.

Note:

You may see subtle differences in the appearance of the Oracle Cloud Infrastructure Compute user interface as compared to the illustrations in this document. For example, the locations of pages, tabs, buttons, text boxes, links and so on may have changed since this document was published. Nevertheless, the concepts presented in this document are still valid and all steps are mandatory. The Oracle Cloud Infrastructure Compute documentation should have current information on using images and creating instances.

Note:

PeopleSoft Cloud Manager images use the PeopleSoft deployment package (DPK) format. However, be aware that the use of DPK customizations, which can be used with other types of PeopleSoft DPKs, is not supported for PeopleSoft Cloud Manager.

See the PeopleSoft Cloud Manager Home Page, My Oracle Support, Doc ID 2231255.2, for links to other Cloud Manager documentation, and information about known issues.

This is the first tutorial in the Install PeopleSoft Cloud Manager series. Read the tutorials in the order listed. The optional tutorials offer alternate methods for setup.

Fulfill License Requirements

Review the following license requirements:

  • The PeopleSoft Licensing Information User Manuals include details about entitled products, restricted-use licensing grants, and prerequisite requirements that may be needed to use certain Cloud Manager features. To locate the information about Cloud Manager licensing and prerequisites, see the Licensing Information User Manual for your PeopleSoft application in the Oracle Help Center. Select your PeopleSoft application on the left. The license manual is located under Other Documentation. You can find the Cloud Manager details in the PeopleTools section.
  • PeopleSoft Cloud Manager will automate provisioning of the Microsoft Windows environments that will host the PeopleTools Application Designer and Life Cycle Management (LCM) products required for PeopleSoft Update Manager. Your Oracle Cloud IaaS subscription grants the license required for Microsoft Windows 2019. Please see Microsoft Licensing on Oracle Cloud Infrastructure for details.
    Note that the Windows 2019 image must be procured from Oracle Cloud Marketplace.
  • PeopleSoft Cloud Manager provides a tool for migrating on-premises PeopleSoft environments to Oracle Cloud.  This tool requires Oracle Database 18c, 19c,  21c, or 23ai. Customers must possess or obtain an on-premises license for Oracle Database 18c, 19c, 21c, or 23ai Standard or Enterprise Edition.

Prepare to Use COBOL Compilers

When you set up the topology for provisioning PeopleSoft environments in Cloud Manager, you can enable COBOL. To use COBOL for provisioning, you must first obtain a license for one of the supported COBOL compilers, and enter the license information on the Cloud Manager Settings page.

With the current Cloud Manager image, you can use Visual COBOL® 4, 6, 7, or 9 compilers. The support for these compilers differs depending upon the PeopleSoft PeopleTools release of the environment you want to provision.

Oracle is the exclusive reseller of the Rocket Software Visual COBOL compilers for use with PeopleSoft applications. Contact the Oracle  license codes team by sending an email to licensecodes_ww@oracle.com, with the product that you are licensing and the operating system. Include your Company Name, Customer ID, and CSI number (if available).

Note:

The Visual COBOL product was formerly Micro Focus Visual COBOL.

After you specify the license information, to enable COBOL for the environment template successfully, you must use a compiler that is supported for the PeopleTools release that you are provisioning. If you select a COBOL compiler that is not supported for that release, Cloud Manager displays an error message.

You must use the same version of COBOL for every node in a given provisioned environment. Similarly, if you use the lift and shift process, you must use the same version of COBOL for every node that you provision for the shifted environment.

The following table lists the COBOL compilers supported by PeopleTools release:

PeopleTools release Visual COBOL 4 Visual COBOL 6 Visual COBOL 7 Visual COBOL 9
8.56 Supported for PeopleTools 8.56.16 and later
 No
 No No
8.57 Supported for PeopleTools 8.57.06 and later
 Supported for 8.57.06 and later
 No No
8.58 Supported for all PeopleTools 8.58
 Supported for 8.58.03 and later
 No No
8.59 Supported for all PeopleTools 8.59 Supported for all PeopleTools 8.59 Supported for all PeopleTools 8.59.13 and later No
8.60 No Supported for all PeopleTools 8.60 Supported for all PeopleTools 8.60.01 and later Supported for all PeopleTools 8.60.12 and later
8.61 No Supported for all PeopleTools 8.61 Supported for all PeopleTools 8.61 Supported for all PeopleTools 8.61
8.62 No No Supported for all PeopleTools 8.62 Supported for all PeopleTools 8.62

Note:

Visual COBOL 4 is not supported on Oracle Linux 7, because it is not compatible with SELinux.

See Using Visual COBOL with PeopleSoft, My Oracle Support, Doc ID 2523494.1.

See the tutorial Specify Cloud Manager Settings.

Verify Oracle Cloud Infrastructure Accounts and Subscriptions

This documentation assumes you have obtained an Oracle Cloud Infrastructure account. If not, consult the Oracle Cloud Infrastructure documentation.

See Request and Manage Free Oracle Cloud Promotions.

The current Cloud Manager release supports both commercial and Government Cloud accounts in Oracle Cloud Infrastructure. The United States Government Cloud accounts are characterized by the security standards they support. Each commercial and Government Cloud account is assigned to a realm, which a logical collection of regions. Realms are isolated from each other and do not share any data. These accounts are available for Cloud Manager customers:

Account Type Realm
Commercial OC1
US Government Cloud Federal Risk and Authorization Management Program (FedRAMP) authorized OC2
US Government Cloud DISA Impact Level 5 authorized OC3

See Oracle US Government Cloud and Oracle US Defense Cloud.

For information on the regions available for the realms for each type of account, see Regions and Availability Domains.

For all accounts, the following subscriptions are required for Cloud Manager:

  • A subscription to Oracle Cloud Infrastructure Compute is mandatory.
  • A subscription to Oracle Cloud Infrastructure Object Storage is mandatory.
  • A subscription to Oracle Cloud Infrastructure File Storage service is mandatory.
  • A subscription to Oracle Cloud Infrastructure Resource Manager is mandatory.
  • A subscription to Oracle Database Cloud Service is optional.
  • A subscription to Oracle Data Science Service is optional.

Verify Oracle Cloud Account Credentials

If you don't have the following information about your Oracle Cloud Compute account, contact your Oracle Cloud administrator.

See Sign In to the Console in the Oracle Cloud Infrastructure documentation.

  • User name and password
  • URL for the Compute Console
  • Tenancy OCID
  • User OCID
  • Compartment name

Verify Oracle Cloud Account Policies

To obtain the Cloud Manager and PeopleSoft Linux images from the Oracle Cloud Infrastructure Compute console, your user account must belong to a group with the following policies:

  • Allow group <group name> to manage App-catalog-listing in tenancy
  • Allow group <group name> to manage all-resources in compartment <compartment name>
  • Allow group <group name> to use tag-namespaces in tenancy

If you use the Data Science Service, the Data Science setup stack will automatically create extra policies required for the setup. See the tutorial Create Data Science Resources for Auto Scaling in PeopleSoft Cloud Manager (Optional).

For monitoring environments, the following policy is required to allow the user to view the monitoring graph:

allow any-user to manage objects in compartment <compartment_name> where ALL
{ request.principal.type='datasciencemodeldeployment'}

If you use Autonomous Database on Shared Infrastructure (ADB-S), your user account must belong to a group with the following policies:

  • use vcns for the compartment which the VCN is in
  • use subnets for the compartment which the VCN is in
  • use network-security-groups for the compartment which the network security group is in
  • manage private-ips for the compartment which the VCN is in
  • manage vnics for the compartment which the VCN is in
  • manage vnics for the compartment which the database is provisioned or is to be provisioned in

To use Resource Manager, the recommendation is to restrict access to the stacks and stack jobs using roles and policies. See IAM Policies, Manage Stacks and Jobs, in the Oracle Cloud Infrastructure documentation.

For information on creating policies, see How Policies Work in the Oracle Cloud Infrastructure documentation.

Select a Compartment

Decide on the compartment to use for installing Cloud Manager and creating instances. You can use lower-level subcompartments (nested compartments) under the root compartment. Oracle Cloud Infrastructure supports up to 6 levels of subcompartments.

See Managing Compartments, Creating Compartments, in the Oracle Cloud Infrastructure Documentation.

When creating PeopleSoft environments, you can specify different compartments for the various nodes. For example, you can set up the middle tier and Search Server tiers in different compartments in your tenancy.

Generate SSH Keys and API Keys

To install and use the Cloud Manager installation, you must generate both SSH key pairs and API key pairs. The SSH key pair is used to provide secure shell (SSH) connection to an instance. The API signing key pair is needed for authentication when submitting API requests.

See Security Credentials, in the Oracle Cloud Infrastructure Documentation.

To generate SSH keys, you will need either an implementation of the ssh-keygen utility (for Linux) or an application such as PuTTY (for Microsoft Windows), installed on a local computer.

Note that you must use the private SSH key with the same utility that you use to generate it. That is, use the private SSH key that you generate with the ssh-keygen utility when running OpenSSH on the Linux command line. Use a PuTTY-generated private key for access with PuTTY. It is a good practice to use the “.ppk” extension for the PuTTY-generated private key.

For instructions on generating SSH Keys, see Managing Key Pairs on Linux Instances in the Oracle Cloud Infrastructure Documentation.

To generate API signing keys, you will need a bash shell on a Linux or UNIX computer, or a git bash shell on a Microsoft Windows computer.

See the tutorial Generate API Signing Keys for PeopleSoft Cloud Manager.

Prepare to Lift a Database to Oracle Cloud

Use one of these methods to lift a database to Cloud Manager:

  • Recovery Manager (RMAN).

    The Oracle Database Cloud Backup Module (ODCBM) required for the process is included with the Cloud Manager image.

    Note:

    Lift using RMAN is no longer supported. Oracle recommends that you use Zero Downtime Migration to migrate Oracle databases to Oracle Cloud Infrastructure.
  • Zero Downtime Migration (ZDM).

    You can use ZDM to migrate a database from an on-premises environment or from Oracle Cloud Infrastructure Classic to Oracle Cloud Infrastructure Database System. After you migrate the database, you can import it into Cloud Manager.

    See "Using Zero Downtime Migration to Migrate Environment to Cloud Manager" in PeopleSoft Cloud Manager documentation. To locate the documentation, select Online Help (HTML) or PeopleBooks (PDF) on the PeopleSoft Cloud Manager page on the Oracle Help Center.

  • Lift an Autonomous Database

    You can use ZDM to migrate an Autonomous Database on Dedicated Infrastructure (ADB-D) or Autonomous Database on Shared Infrastructure (ADB-S) to Cloud Manager. The ADB-D or ADB-S that you import to Cloud Manager must be on Oracle 19c.

    Note:

    ADB-D was called "Autonomous Transaction Processing Database - Dedicated, or ATP-D," in an earlier Cloud Manager release.

    See Zero Downtime Migration in the Oracle documentation.

Prepare User IDs and Passwords

When you fill out the information for the Cloud Manager stack in Resource Manager, you are asked for several user IDs and passwords. The Cloud Manager image is delivered with default user IDs that are reset by the setup script.

The required user IDs and passwords include the following:

  • User ID and password for a registered My Oracle Support account.
  • CLADM password: The CLADM user account is delivered with Cloud Manager, and is associated with the Cloud Administrator role (PACL_CAD).
  • PeopleSoft Database Access ID and password
  • Database Administrator and password: The Cloud Manager image is delivered with a default password for SYS and SYSTEM users. This will be reset using the value you supply to the Cloud Manager Instance Configuration script.
  • PeopleSoft connect ID and password
  • Oracle WebLogic administrator password
  • PeopleSoft Web Profile password
  • Integration Gateway password

Before installing the installing the Resource Manager stack for PeopleSoft Cloud Manager, you must create a vault, encryption key, and secrets in Oracle Cloud Infrastructure. You enter each password as a vault secret, and then select the name for the secret on the Resource Manager stack form.

See the tutorial Create Vault Resources for Password Management for PeopleSoft Cloud Manager for information on creating a vault, encryption key, and secrets in Oracle Cloud Infrastructure.

Plan and Create the Virtual Cloud Network

See the tutorial Plan the Virtual Cloud Network for PeopleSoft Cloud Manager.

  • The Cloud Manager installation requires a Virtual Cloud Network (VCN) with subnets, gateways, route tables, and security lists. You can create a VCN before you begin the Cloud Manager installation, or you can install it as part of the Cloud Manager stack setup with Resource Manager.
  • If there are more than one subnets that will be used for PeopleSoft deployments, then those subnets must allow communications from the subnet where Cloud Manager is set up.

    The cloud administrator must create security lists for subnets such that it allows Cloud Manager and file server to communicate with instances that will be deployed on other subnets. The security list must be updated to allow ports that Cloud Manager and the file server will use to be able to successfully deploy an environment.

  • Security lists must have rules to allow RDP (port 3389) and SSH (port 22) access.
  • When creating PeopleSoft environments, you can specify different VCNs for the various nodes. For example, you can use different VCNs in different compartments for the middle tier and Elasticsearch tiers.

Review Port Numbers

Cloud Manager is provided with default values for the HTTP, HTTPS, Jolt, and WSL ports. For security reasons Oracle recommends that you do not use the default HTTP or HTTPS port numbers. Before beginning this procedure, decide on your port numbers.

The Cloud administrator sets up a Virtual Cloud Network, including subnets and access to necessary ports. Configure the Oracle Cloud Infrastructure Compute instance to allow access for the HTTP and HTTPS ports that you select, and then supply the same HTTP and HTTPS port numbers when you install Cloud Manager.

See the tutorial Plan the Virtual Cloud Network for PeopleSoft Cloud Manager.

Choose an Oracle Linux Image

Cloud Manager requires an Oracle Linux image for provisioned environments. Choose one of these methods to obtain an Oracle Linux image:

  • Use the Oracle Linux Image Customized for PeopleSoft Cloud Manager on OCI, which is configured for use with Cloud Manager.

    This is a reference image, based on Oracle Linux 8.x, which you can use for a quick start to evaluate Cloud Manager. You can use this image without further modification. If the image suits your organizational requirements, you can continue to use the same image for production. When you fill out the Cloud Manager Infrastructure Settings page, in the Operating System Images section, select the Marketplace option and select one of the Oracle Linux 8.x images from the drop-down list.

    See the tutorial Specify Cloud Manager Settings.

  • You also have the option to create a custom image using a base Oracle Linux platform image.

    In this case, you must carry out additional steps to configure the image to work with Cloud Manager. In addition, you are responsible for determining and obtaining any operating system requirements.

    See the tutorial Create a Custom Linux Image for PeopleSoft Cloud Manager.

Use the guidelines in this table to select an image.

Release for PeopleSoft Provisioned Environment Oracle Linux Image Description
PeopleSoft PeopleTools 8.59, 8.60, 8.61, or 8.62 Oracle Linux image version 8.x Use the Oracle Linux Image Customized for PeopleSoft Cloud Manager
OR
Create a custom image
PeopleSoft PeopleTools 8.58 or 8.59 Oracle Linux image version 7.x Use the Oracle Linux Image Customized for PeopleSoft Cloud Manager
OR
Create a custom image

Prepare to Upgrade PeopleTools for a Provisioned Environment

When using the Upgrade PeopleTools feature in the current Cloud Manager image, users can view compare reports such as DDDAUDIT, SYSAUDIT and Alter Audit. Users can choose to receive email notification when compare reports are available. See the information on Upgrading PeopleTools in PeopleSoft Cloud Manager documentation. To locate the documentation, select Online Help (HTML) or PeopleBooks (PDF) on the PeopleSoft Cloud Manager page on the Oracle Help Center.

The Cloud Manager administrator must complete the following prerequisites to enable email notifications for upgrade compare reports:

  • Create a topic in Oracle Cloud Infrastructure Notification Service.

    Create the topic in the same compartment where you install Cloud Manager. See Managing Topics in the Oracle Cloud Infrastructure documentation.

  • Create a subscription with email protocol for each user that will perform the PeopleTools upgrade.

    The user will receive an email asking them to approve the subscription.

  • Enter the OCID for the topic in the Cloud Manager Infrastructure Settings page.

    See the tutorial Specify Cloud Manager Settings.

  • Create an Object Storage bucket (optional).

    Cloud Manager sets up a default bucket that is used for the reports. You also have the option of creating your own bucket. See Object Storage Buckets in the Oracle Cloud Infrastructure documentation.

    Enter the name for the bucket Cloud Manager Infrastructure Settings page. See the tutorial Specify Cloud Manager Settings.


Choose a Microsoft Windows Image

Cloud Manager requires a Microsoft Windows image to host PeopleSoft client tools such as Change Assistant and Application Designer. You can also create a Microsoft Windows-based node for PeopleSoft Process Scheduler.

After completing the Cloud Manager setup, you will include the Microsoft Windows image Oracle Cloud identification number (OCID) in the Cloud Manager Settings area.

See the tutorial Specify Cloud Manager Settings.

Choose one of the methods outlined here to obtain the Microsoft Windows image.

  • You can use one of the Oracle platform images for Microsoft Windows 2019 without modification. The OCIDs for the latest Oracle platform images are included on the Oracle Cloud web site. For Windows 2019 VM images, go to the following page:

    https://docs.oracle.com/en-us/iaas/images/windows-server-2019-vm/

    Select one of the Windows-Server-2019-Standard-Edition-VM or Windows-Server-2019-Standard-Edition-VM-Gen2 images.

    Select Read More and make a note of the Image OCID for the region where you want to install Cloud Manager.

  • You have the option to create a custom Microsoft Windows image based on an Oracle platform image. Follow the instructions in the tutorial Create a Custom Windows Image for PeopleSoft Cloud Manager in Oracle Cloud Infrastructure.

For information about instance shapes, see Compute Shapes in the Oracle Cloud Infrastructure documentation.

Use File Storage Service for the Repository

Use Oracle Cloud Infrastructure File Storage service to create a file server for the Cloud Manager download repository. After completing the Cloud Manager setup, use the File Server page in the Settings area to create a new File Storage service file system or select a file system that was created for another Cloud Manager instance.

The file system created in File Storage service is a cluster file system for managing general purpose file data stored outside an Oracle Database. The file system is accessed through a mount target, which provides the IP address or DNS name that is used in the mount command when connecting NFS clients to a file system.

For a detailed explanation of the File Storage service concepts, such as mount targets and export paths, see Overview of File Storage in the Oracle Cloud Infrastructure documentation.

Cloud Manager includes three methods for the file system setup. The networking requirements differ for each method.

  • If you choose to create a new file system, it will be created in the same compartment, availability domain, and VCN as the Cloud Manager instance.
  • If you choose to create a new file system on an existing File Storage service mount target, you supply the mount target information.

    You must ensure that the existing File Storage service mount target is in the same availability domain, VCN, and availability domain-specific subnet as the Cloud Manager instance.

    If the existing File Storage service mount target is within a regional subnet, however, you can create the Cloud Manager instance in any of the availability domains spanned by the regional subnet.

  • If you choose to use an existing File Storage service file system, you enter the File Storage service mount target and export path for the file system on the Cloud Manager File Server page.

    You must ensure that the File Storage service mount target associated with this file system is in the same availability domain, VCN, and availability domain-specific subnet as the Cloud Manager instance.

    If the existing File Storage service mount target is within a regional subnet, however, you can create the Cloud Manager instance in any of the availability domains spanned by the regional subnet.

Review the ports required for the file system in the tutorial Plan the Virtual Cloud Network for PeopleSoft Cloud Manager.

Before you create the File Storage service mount target, export path, and file system, verify that your account has sufficient resources, as mentioned in the tutorial Verify Oracle Account Information for Cloud Manager.

See the tutorial Use File Storage Service for PeopleSoft Cloud Manager Repository.

Create a File Storage Service File System for Mid-tier Nodes

When you provision or shift an environment in PeopleSoft Cloud Manager, you can select a File Storage service file system for one or more mid-tier nodes. Note that you cannot use the File Storage service file system that you create for the Cloud Manager repository as the file system for mid-tier nodes in a provisioned environment.

  • You must create the File Storage service file system that you use for the mid-tier nodes outside of Cloud Manager. After you create the file system, you can select it when adding or managing nodes in Cloud Manager.
  • You can use each File Storage service file system for the mid-tier nodes for a single managed environment.
  • The File Storage service file system must not be in use by any other environment, or contain any data. 
  • For the best performance, Oracle recommends that you create the file system in the same Availability Domain as the managed environments.
  • It is not necessary to use the same VCN as the one that you use for Cloud Manager or the managed environment, but you should ensure that you set up any necessary network security rules.

To create a File Storage Service file system, see Creating File Systems in the Oracle Cloud Infrastructure documentation.

Important!

When you select the File Storage service file system for a mid-tier node in Cloud Manager, any existing content in the file system will be deleted.

Use an Oracle Cloud Infrastructure Load Balancer with PeopleSoft Environments

You can now create an Oracle Cloud Infrastructure Load Balancer and use it for mid-tier components such as web server domains and Kibana domains in your Cloud Manager environments.

See the tutorial Create a Load Balancer in Oracle Cloud Infrastructure for PeopleSoft Cloud Manager Environments (Optional).

Next Steps

Verify Oracle Cloud Account Information for PeopleSoft Cloud Manager

Learn More