IBM Support

Cloud Pak for Security: How to Backup and restore YAML configuration

How To


Summary

How to back up and restore YAML files in IBM Cloud Pak for Security?

Objective

This Technical Note is to provide information on performing YAML configuration backups for IBM Cloud Pak for Security (CP4S), it does not provide information on backing up Red Hat OpenShift or generic Linux Operating System files. For 3rd party applications, refer to their documentation for backup procedures. 

Steps

Important: Before any changes or updates are made to any YAML files, a backup of the files is required. Before any edits to YAML configuration, backup Cloud Pak for Security. Any edits to YAML have the possibility of planned outages, and PODs restarting. Plan changes during a scheduled maintenance window. If needed, a backup is to facilitate the restoration of data. 
  1. Before any YAML change, backup Cloud Pak for Security during your teams' scheduled maintenance.
  2. Backup YAML configuration: 
    oc get -o yaml pod > FILE
    Note: where FILE is the fully qualified file and location. 
  3. Modify YAML file as needed from the Red Hat OpenShift Web Console's YAML Editor, or from CLI: 
     oc edit (RESOURCE/NAME | -f FILENAME) [options]
    Information: Verify desktop editors are replacing tab key presses with equivalent spaces.
    Warning: YAML is sensitive to spaces, new lines, and special characters. Some YAML changes can replicate through an environment and have unintended consequences.
     

Additional Information

If a restore is needed, you can use one of the following backout instructions:

Document Location

Worldwide

[{"Type":"MASTER","Line of Business":{"code":"LOB24","label":"Security Software"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Product":{"code":"SSTDPP","label":"IBM Cloud Pak for Security"},"ARM Category":[{"code":"a8m3p0000000rbnAAA","label":"Administration Task"}],"ARM Case Number":"","Platform":[{"code":"PF025","label":"Platform Independent"}],"Version":"All Versions"}]

Document Information

Modified date:
08 March 2023

UID

ibm16958110

Page Feedback