ps-vagabond

Vagabond is a project to help more easily create and manage PeopleSoft PUM environments on your local machine by using Vagrant. Once downloaded and configured, running vagrant up from within your Vagabond instance will...

Download, configure, and start a base OEL or Windows (evaluation) Virtual Machine for use with the PUM
Download the PUM DPK files from Oracle Support
Unpack the DPK setup zip file and run the psft-dpk-setup script on the VM
Copy the psft_customizations.yaml file from the local directory to the VM
Apply the DPK Puppet manifests to build out the environment and start the PUM environment

Prerequisites

You'll need the following hardware and software in order to use Vagabond.

Hardware
- At least 8GB of RAM for the VM (not including host machine memory requirements)
- Minimum of 2 CPU cores
Software
- VirtualBox
- Vagrant
Credentials
- My Oracle Support account and access to download PeopleSoft PUM DPK's

NOTE: If you haven't used Vagrant before, it's highly recommended that you walk through the vagrant project setup guide before getting started.

Windows Users: Setting up ssh client integration with Vagrant can be tricky. You might want to check out Cmder as an alternative to the delivered Windows command shell. PowerShell will probably work, but has not been fully tested.

Setup

Download

To get started, simply download the zipfile and extract the contents to whichever directory you choose. If you need to manage more than one PeopleSoft Application, it is recommended that you create separate Vagabond installations for each application. For example:

E:\vagabond
   ├─ fscm92
   └─ hcm92

Depending on your platform, you can use one of the examples below or do it manually.

Git Example

If you have git installed, this is the preferred method as it will allow future updates to be performed much more easily.

cd E:\pum
git clone https://github.com/psadmin-io/ps-vagabond.git ps-vagabond-hcm
cd ps-vagabond-hcm

PowerShell Example

$baseDirectory = "E:\pum" # Change this to the base directory you want to use
Set-Location -Path $baseDirectory
(New-Object System.Net.WebClient).DownloadFile("https://github.com/psadmin-io/ps-vagabond/archive/master.zip", "$basedirectory\ps-vagabond.zip")
(New-Object -com shell.application).namespace($baseDirectory).CopyHere((new-object -com shell.application).namespace("$basedirectory\ps-vagabond.zip").Items(),16)
Rename-Item "$baseDirectory\ps-vagabond-master" "ps-vagabond-hcm" # Change this to whichever application you're going to be using
Remove-Item "$baseDirectory\ps-vagabond.zip"
Set-Location -Path "$baseDirectory\ps-vagabond-hcm"

WGET Example

cd ~/pum # Change this to the base directory you want to use
wget https://github.com/psadmin-io/ps-vagabond/archive/master.zip --output-document="ps-vagabond.zip"
unzip ps-vagabond.zip
mv ps-vagabond-master ps-vagabond-hcm
rm ps-vagabond.zip

Configuration

Once you've downloaded Vagabond you should have a directory containing the following files:

ps-vagabond
├── LICENSE.md
├── README.md
├── Vagrantfile
├── config
│   ├── PSCFG.CFG.example
│   ├── client.reg.example
│   ├── config.rb.example
│   ├── psft_customizations.yaml.example
├── dpks
├── keys
└── scripts
    ├── banner.ps1
    ├── loadcache.ps
    ├── provision-*.ps1
    ├── provision.sh
    ├── rubyGems.pem

The first thing you'll want to do is copy both the config/config.rb.example and config/psft_customizations.yaml.example files to config/config.rb and config/psft_customizations.yaml. The PSCFG.CFG.example and client.reg.example file is used if you want to apply a PeopleTools Patch when provisioning the PeopleSoft Image.

config.rb (required)

The config.rb file is what Vagabond will use to determine how to go about setting up the base configuration of your virtual machine. Although some of the settings are optional, you'll need to provide your MOS credentials and the Patch ID for the PUM DPK you wish to use. The Patch ID for each application can be found on the PUM Homepage. When copying the Patch ID, be sure to select the "Native OS" one.

##############
#  Settings  #
##############

# REQUIRED >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>

# ORACLE SUPPORT CREDENTIALS
# MOS username and password must be specified in order to
# download the DPK files from Oracle.

MOS_USERNAME='USER@EXAMPLE.COM'
MOS_PASSWORD='MYMOSPASSWORD'

# PATCH ID
# Specify the patch id for the PUM you wish to use
PATCH_ID='23711856'

psft_customizations.yaml (optional)

Additionally, if you wish to change the defaults that are used by the DPK you can use the psft_customizations.yaml file.

(Windows Guest Only) If you make changes to the psft_customizations.yaml file, you can tell Vagabond to re-sync the file. Use the command vagrant provision --provision-with=yaml and the local psft_customizations.yaml file will be copied to $PUPPET_HOME\etc\data\

Custom DPK Modules (optional)

(Windows Guest Only) If you want to deploy and test custom DPK modules with Vagabond, copy your Puppet modules and code to $vagabond_home\config\modules. Vagabond will check if you have code in the modules folder and will copy it to the $PUPPET_HOME folder. You can also run vagrant provision --provision-with=dpk-modules to re-copy the files into the VM.

If you have a custom DPK Role you want to execute, you can set that in the config.rb file.

# CUSTOM DPK ROLE
# Change the DPK Role in site.pp to something custom.
# Use `vagrant provision --provision-with=dpk-modules` to update the site.pp file.
DPK_ROLE = '::io_role::io_tools_demo'

Apply a PeopleTools Patch (optional)

(Windows Guest Only) The Windows version of Vagabond can download and apply a PeopleTools Patch to the PeopleSoft Image. To apply a patch, uncomment two values in the config.rb file:

# PEOPLETOOLS_PATCH
# To apply a PeopleTools Patch to the PeopleSoft Image, you must be using 
# a Windows NativeOS DPK. Change APPLY_PT_PATCH to 'true' and enter the 
# Patch ID for PTP_PATCH_ID.
APPLY_PT_PATCH='true'
PTP_PATCH_ID='26201347' # 8.55.17

Uncommenting the APPLY_PT_PATCH line will tell Vagabond to run additional provisions that apply a PT Patch to a fully build PeopleSoft Image. You must also provide a valid Patch ID for the PeopleTools Patch you want to apply. Vagabond will automatically download the patch files for you. Once the files are downloaded, Vagabond will apply the patch to the database and rebuild the domains on the new PeopleTools version.

Operating System

Vagabond supports the Linux and Windows NativeOS Deployment Packages. By default, Vagabond will use the Linux NativeOS DPK with an Oracle Enterprise Linux virtual machine. To enable a Windows build with Vagabond, uncomment this line in the config/config.rb file.

# OPERATING_SYSTEM
# Which OS to use as the base box for the DPK.  The available options
# are either 'LINUX' (Oracle Enterprise Linux 7.x) or 'WINDOWS'
# If left undefined, it will default to Linux.
OPERATING_SYSTEM = 'WINDOWS'
# One Windows Versions is supported, "2016"
# WIN_VERSION = "2016"

The Windows virtual machine is an evaulation version of Windows 2016 and is only intended for demonstration purposes. You can build your own base Windows VM with a licensed copy of Windows to use for testing and production support.

Usage

Once configured, you simply have to change to the Vagabond instance directory and run vagrant up. Vagrant will then download the box image, start the VM, and begin the provisioning process.

C:\pum_images\hcm92>vagrant up
Bringing machine 'ps-vagabond' up with 'virtualbox' provider...
==> ps-vagabond: Cloning VM...
==> ps-vagabond: Matching MAC address for NAT networking...
==> ps-vagabond: Checking if box 'jrbing/ps-vagabond' is up to date...
==> ps-vagabond: Setting the name of the VM: HCM92
==> ps-vagabond: Clearing any previously set network interfaces...
==> ps-vagabond: Preparing network interfaces based on configuration...
    ps-vagabond: Adapter 1: nat
    ps-vagabond: Adapter 2: bridged
==> ps-vagabond: Forwarding ports...
    ps-vagabond: 22 (guest) => 2222 (host) (adapter 1)
==> ps-vagabond: Running 'pre-boot' VM customizations...
==> ps-vagabond: Booting VM...
==> ps-vagabond: Waiting for machine to boot. This may take a few minutes...
    ps-vagabond: SSH address: 127.0.0.1:2222
    ps-vagabond: SSH username: vagrant
    ps-vagabond: SSH auth method: private key
==> ps-vagabond: Machine booted and ready!
==> ps-vagabond: Checking for guest additions in VM...
==> ps-vagabond: Setting hostname...
==> ps-vagabond: Configuring and enabling network interfaces...
==> ps-vagabond: Mounting shared folders...
    ps-vagabond: /vagrant => C:/pum_images/hcm92
    ps-vagabond: /media/sf_HCM92 => C:/pum_images/hcm92/dpks
==> ps-vagabond: Setting hostname...
==> ps-vagabond: Mounting shared folders...
    ps-vagabond: /vagrant => /Users/dan/vm/hr033-lnx
    ps-vagabond: /media/sf_HR033-LNX => /Users/dan/vm/hr033-lnx/dpks/download
==> ps-vagabond: Running provisioner: storage (shell)...
    ps-vagabond: Running: inline script
==> ps-vagabond: Running provisioner: guestadditions-lnx (shell)...
    ps-vagabond: Running: inline script
==> ps-vagabond: Running provisioner: bootstrap-lnx (shell)...
    ps-vagabond: Running: /var/folders/0k/30qg/T/vagrant-shell20200218-o7cxv7.sh
    ps-vagabond:
    ps-vagabond:
    ps-vagabond:                                       dP                               dP
    ps-vagabond:                                       88                               88
    ps-vagabond:   dP   .dP .d8888b. .d8888b. .d8888b. 88d888b. .d8888b. 88d888b. .d888b88
    ps-vagabond:   88   d8' 88'  `88 88'  `88 88'  `88 88'  `88 88'  `88 88'  `88 88'  `88
    ps-vagabond:   88 .88'  88.  .88 88.  .88 88.  .88 88.  .88 88.  .88 88    88 88.  .88
    ps-vagabond:   8888P'   `88888P8 `8888P88 `88888P8 88Y8888' `88888P' dP    dP `88888P8
    ps-vagabond:                          .88
    ps-vagabond:                      d8888P
    ps-vagabond:  ☆  INFO: Updating installed packages
    ps-vagabond:  ☆  INFO: Installing additional packages
    ps-vagabond:  ☆  INFO: Installing jrbing/ps-extras
    ps-vagabond:  ☆  INFO: Patch files already downloaded
    ps-vagabond:  ☆  INFO: Setup scripts already unpacked
    ps-vagabond:  ☆  INFO: Executing Pre setup script
    ps-vagabond:  ☆  INFO: Executing DPK setup script
    ps-vagabond:  ☆  INFO: Applying fix for psft-db init script
    ps-vagabond:  ☆  INFO: Install psadmin_plus
    ps-vagabond:
    ps-vagabond:  TASK                         DURATION
    ps-vagabond: ========================================
    ps-vagabond:  install_additional_packages  00:00:43
    ps-vagabond:  update_packages              00:05:00
    ps-vagabond:  install_psadmin_plus         00:00:02
    ps-vagabond:  execute_psft_dpk_setup       00:45:47
    ps-vagabond:  generate_response_file       00:00:00
    ps-vagabond:  execute_pre_setup            00:00:00
    ps-vagabond: ========================================
    ps-vagabond:  TOTAL TIME:                  00:51:32
    ps-vagabond:
    ps-vagabond:  ☆  INFO: Cleaning up temporary files
==> ps-vagabond: Running provisioner: cache-lnx (shell)...
    ps-vagabond: Running: /var/folders/0k/30qg/T/vagrant-shell20200218-g0qul8.sh
    ps-vagabond:  ☆  INFO: Downloading Manifests
    ps-vagabond:  ☆  INFO: Fix DPK App Engine Bug
    ps-vagabond:  ☆  INFO: Pre-load Application Cache
    ps-vagabond:
    ps-vagabond:  TASK                         DURATION
    ps-vagabond: ========================================
    ps-vagabond:  fix_dpk_bug                  00:00:07
    ps-vagabond:  load_cache                   00:18:16
    ps-vagabond:  download_manifests           00:00:01
    ps-vagabond: ========================================
    ps-vagabond:  TOTAL TIME:                  00:18:24

C:\pum_images\hcm92>

Since Vagabond is just a set of configuration files and provisioning scripts for Vagrant, all of the delivered Vagrant commands can be used. The following table lists some of the basic commands.

Task	Command
Start the VM	`vagrant up`
Stop the VM	`vagrant halt`
Delete the VM	`vagrant destroy`
Connect to the VM	`vagrant ssh`
Connect to the VM (via RDP)	`vagrant rdp`
Pre-load app cache	`vagrant provision --provision-with=cache-lnx`
Copy your `psft_customizations.yaml` file	`vagrant provision --provision-with=yaml`
Copy custom DPK modules	`vagrant provision --provision-with=dpk-modules`

To view the DPK script output while the instance is building, you can use the vagarnt ssh command to log into the instance.

tail -f /media/sf_*/*/setup/psft_dpk_setup.log

Manually Download DPK Files

If the host running Vagabond does not have interet access, you can download the DPK files manually for Vagabond. Use a tool like getMOSPatch to download the files on your local machine.

Let's assume that you have Vagabond installed to c:\pum\hcm92. Copy the files to the folder c:\pum\hcm92\dpks\download\[PATCH_ID] on the machine running Vagabond.

Next, copy the text below and save it as vagabond.json in the same directory:

{
    "download_patch_files":  "true",
    "unpack_setup_scripts":  "false"
}

The vagabond.json file tracks the download and unzipping status of the DPK files. Setting "download_patch_files": "true" will tell Vagabond to skip the download for that patch. Now you can run vagrant up and Vagabond will build the PeopleSoft Image.

ostracize / ps-vagabond