Preparing the Customization File for a New Single User, New Primary Group, and New Secondary Group

This user customization applies to Linux OS platforms only. If you choose the default initialization when running the DPK setup script, the Puppet framework creates local users and default groups, which are contained in the generated psft_unix_system.yaml file. Use the sample customization file in this section if you do not want to use the default users and groups, and instead want to set up your environment with a new single user assigned to two groups.

See “Using and Maintaining the PeopleSoft Environment,” Using the PeopleSoft Installation, for a list of the default users and permissions.

Note:

After completing the initialization, the system will prompt you to provide a new password for the new user, the first time you log in.

Note:

Review the requirements in Understanding PeopleSoft Environment Customizations and Requirements for Users and Groups Customizations before preparing the customization file.

This customization will create a new single user and a new group, the primary group. The new user is also assigned to a new secondary group. Either the primary group or the secondary group must be named oinstall.

You must specify values for two parameters that are not included in the generated psft_unix_system.yaml file, psft_user and psft_group.

  • groups/psft_group

    • Use the groups/psft_group collection parameter only if you want to create a new group for a single user. The DPK process will create the group. If there is an existing group with the same name, the script will skip it.

    • Specify the same value for groups/psft_group/name and for users/psft_user/gid.

      Use a group name (string), not a GID (number), for both the name in the group collection parameter, and the gid in the users collection parameter.

    • Note that you must use the parameters exactly as given in this documentation. If you try to create a different parameter name or alter the parameter, the DPK process will not recognize it.

  • users/psft_user

    • Use the users/psft_user collection parameter to create a new user and add that user to the new group specified by groups/psft_group/name.

    • Specify the same value for users/psft_user/name and for the scalar parameter psft_runtime_user_name.

    • The new group specified by users/psft_user/gid and groups/psft_group/name is the primary group for the new user.

    • The new group specified by users/psft_user/groups is the secondary group for the new user.

    • Either the primary group or the secondary group must be named oinstall.

    • The single user has all the roles and permissions that the default users would have.

      See “Using and Maintaining the PeopleSoft Environment,” Using the PeopleSoft Installation, for a list of the default users and permissions.

  • users/psft_user/home_dir

    When you run the DPK setup script, it includes a prompt for the users’ home directory. That value is included in the generated psft_unix_system.yaml file. You can accept that same value in this customization file for users/psft_user/home_dir, or you can change it here. If you change it, the DPK process will create the new home directory. Enter the full path to a writable directory.

To prepare the customization file:

  1. Create a psft_customizations.yaml using a standard editing tool, such as vi on Linux, and save it in the same location as the psft_unix_system.yaml file.

    By default, the DPK setup script installs the YAML files in BASE_DIR/dpk/puppet/production/data.

  2. Use the sample below in creating the psft_customizations.yaml file, and modify the values as needed.

    Note:

    Be sure that your final psft_customizations.yaml file includes the indentation shown here. The indentation may be lost if you copy from this documentation and paste into the file.

    In this example, the new single user newuser3 will be created and assigned to the newly created primary group primgrp and the new secondary group oinstall.

    ---
    groups:
      psft_group:
        name: primgrp
        remove: false
    
    psft_runtime_user_name: newuser3
    
    users:
      psft_user:
        name: newuser3
        gid: primgrp
        groups: oinstall
        home_dir: /dpk_base/home/userhome
        password: ENC[PKCS7,xxxxxxxxxxxxxxxx...........]
        remove: false

    In this example, the new single user newuser4 will be created and assigned to the newly created primary group oinstall and the new secondary group secgrp.

    ---
    groups:
      psft_group:
        name: oinstall
        remove: false
    
    psft_runtime_user_name: newuser4
    
    users:
      psft_user:
        name: newuser4
        gid: oinstall
        groups: secgrp
        home_dir: /dpk_base/home/userhome
        password: ENC[PKCS7,xxxxxxxxxxxxxxxx...........]
        remove: false

    Important! Verify that you fulfill the following requirements:

    • Ensure that the file begins with three dashes (---).

    • (Interactive mode) Replace the password sample above with an encrypted password.

      Enter the encrypted password on a single line. Do not include spaces or line feeds. See the instructions later in this documentation to generate the encrypted password.

      See "Encrypting Passwords for Customization Files."

    • (Silent mode) Replace the password sample above with a clear text password.

  3. Save the file.

  4. Continue with the steps in Completing the Customized Deployment.