Metadata-Version: 2.1
Name: jenkins-backup-restore-cli
Version: 1.0.0
Summary: A Jenkins backup and restore python cli tool with arguments.
Home-page: https://github.com/venkatalolla/jenkins-backup-restore.git
Author: Surya Lolla
Author-email: suryasaicharan93@gmail.com
License: MIT
Description: # Python Jenkins Backup Restore Module
        
        Jenkins-backup-restore module takes a backup of the jenkins home directory and restores it.
        
        ####Backup
        
        Following are the list of items that the backup module can do,
        
        1. Look for the JENKINS_HOME env values (or use the default /var/jenkins_home). Export JENKINS_HOME, if does not exists.
        2. Take a backup of the jenkins_home with tar and stores it in current directory (default: /var/jenkins_home)
        3. Move the backup tar to a specific folder locally (optional with flags).
        4. Push the backup tar to a specific bucket in S3 (optional with flags). 
        
        ####Restore
        Following are the list of items that the restore module can do,
        
        1. Look for the binary in the local file system in the specific destination path.
        2. Extract the tar file to JENKINS_HOME path (default: /var/jenkins_home)
        3. Look for the a artifact binary in the s3 given a specific bucket name and download it in the current directory unless a specific artifact destination path is given. (optional with flags)
        4. Extract the tar file to JENKINS_HOME path (default: /var/jenkins_home)
        
        ####Installation
        Run the following command to install the jenkins-backup-restore tool,
        ```
        pip3 install jenkins-backup-restore
        ```
        
        ####Backup and Restore Arguments:
        Once the binary is installed with pip3, use the following command line argument to either take a backup or restore the existing backup.
         
        ```
            --v, --version                      Show program's version number
        
            --cn, --custom-archive-name         Give the backup a custom name
            
            # backup to a local dir command and argument
            backup-local                        Save the archive to a local directory
            -bd, --backup-destination-path,     Local path to store the backup
            
            # backup to s3 command and argument
            backup-s3                           Push the archive to an s3 bucket
            -bb, --backup-bucket-name,          Bucket name to push an archive to s3
            
            # restore archive from a local directory 
            restore-local                        Restore archive from a local directory
            -rs, --restore-source-path           Path to the archive in local directory
            -rd, --restore-destination-path      If destination path is other than the default path (/var/jenkins_home)
            
            # restore archive from an s3 bucket
            restore-s3                           Pull an archive from an s3 bucket to a specific location and restore it
            -rb, --restore-bucket-name           Bucket name to download the archive from
            -adp, --artifact-destination-path    Path to save the downloaded archive from an s3 bucket
        
          {backup,restore}                       use either backup to backup or use restore to restore
        ```
        
        ####Examples
        
        To give a custom name to the backup
        ```
        jenkins-backup-restore backup-local --cn <custom-name.tar.gz> backup
        ```
        > If `--backup-destination-path` not specified, stores in the current directory.
        
        To backup jenkins to local directory,
        ```
        jenkins-backup-restore backup-local --backup-destination-path <custom-dir> backup
        ```
        
        To backup jenkins to an s3 bucket,
        ```
        jenkins-backup-restore backup-local --backup-bucket-name <bucket-name> backup
        ```
        
        To restore an archive from local path,
        ```
        jenkins-backup-restore restore-local --restore-source-path <archive-path> restore
        ```
        
        To restore an archive from an s3 bucket,
        ```
        jenkins-backup-restore restore-s3 --restore-bucket-name <bucket-name> --artifact-destination-path <path-to-download-in-local> restore
        ```
        
Keywords: Jenkins backup and restore cli
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: System :: Recovery Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Description-Content-Type: text/markdown
