This repository hosts a collection of tools aimed at enhancing the management and operation of OpenShift clusters. Among these tools, the ocp-resources-bkp.py script is a key utility designed to facilitate the backup of OpenShift resources.
The ocp-resources-bkp.py script automates the process of backing up various OpenShift resources. It is designed to be run within an OpenShift cluster environment, leveraging the cluster's access permissions to retrieve and store resource definitions.
- Backup Flexibility: Allows for the backup of specific resources across all namespaces or within specified ones.
- Automation Friendly: Designed to be easily integrated into CI/CD pipelines or scheduled backup routines using cron jobs.
- Comprehensive Coverage: Capable of backing up a wide range of OpenShift resource types, ensuring a broad protection scope.
- OpenShift CLI (
oc) installed and configured to communicate with your cluster. - Python 3.x environment for executing the script.
- Appropriate permissions to access and backup resources within the cluster.
To use the script, ensure you have the necessary permissions to access the resources you intend to backup. Run the script from a terminal or integrate it into your automation tools with the following command:
python ocp-resources-bkp.pyYou can also indicate the resources to backup inside a custom config file.
python ocp-resources-bkp.py -c config-infra.ymlThe script will create files with the resources manifests inside the /tmp/backups_OCP directory.
The script can be customized to target specific resources or namespaces by modifying the relevant sections of the code. Parameters such as resource types and namespace names can be adjusted to fit your backup requirements.
For integrating this script into a CI/CD pipeline or a scheduled task:
- CI/CD Pipeline: Add the script execution as a step in your pipeline, ensuring that the environment where the pipeline runs has oc CLI access to the OpenShift cluster.
- Cron Job: Schedule the script to run at regular intervals by adding a cron job on a system with the necessary access and environment to execute the script.
Contributions to enhance the functionality or extend the coverage of backup resources are welcome. Please submit pull requests or create issues to discuss potential improvements.