niveussolutions / apigee-x-backup-tool

Apigee Backup tool

APIGEE - Backup Tool

Supports both Apigee x and Apigee hybrid , does not support Apigee Edge

The tool can backup Apigee Api Proxies, Shared flows, Api Products etc

NOTE: The Script is tested and works fine on Linux(ubuntu) and nodejs version >16

Prerequisite

1. Download gcloud

2. Install nodejs

3. Clone the repository

4. Create a directory where you want to backup all apigee objects

Getting Started

There are 2 ways you can run the apigee-backup-script.

1. Using npm scripts
2. As a cli tool

Using npm scripts

Refer Documentation

As a cli tool

This tool is published to npm registry. Can be installed as a global npm package and used as a cli tool - https://www.npmjs.com/package/@niveus/apigee-backup-tool

Usage: apigee-backup-tool [options] [command]

CLI tool to backup  apigee resources like api proxies, shared flows, Api
products etc

Options:
  -V, --version              output the version number
  -h, --help                 display help for command

Commands:
  config [options] <action>  configure organization name and backupFolderPath
  backup [options] <type>    Backup a specific apigee resource
  login                      Login to google cloud - Runs 'gcloud
                             application-default login' command
  all
      Back up following Apigee resources
          1. Api Proxy
          2. Shared Flow
          3. Api Products
          4. Developers
          5. Developer Apps
          6. Custom Reports
          7. Flow Hooks
          8. Target Servers

  api-proxy [options]        Backup all revisions of all Api Proxies
  shared-flow [options]      Backup all revisions of all Shared Flows
  api-product [options]      Backup all Api Products
  developer [options]        Backup all App Developers
  developer-app [options]    Backup all developer Apps
  flow-hook [options]        Backup all Flow Hooks
  custom-report [options]    Backup all Custom Reports
  target-server [options]    Backup all Target Server
  help [command]             display help for command

apigee-x-backup-tool's Issues

Dockerize the tool

Unable to login

Hi,

Everything installed correctly, however I am stuck on login command:

root@promus-1-vm:~# apigee-backup-tool login

..
...

Nothing happens here?

Any idea?

implement cli prompts using Inquirer.js

Remove dependency on gcloud

Improve code coverage

Write unit tests

Update project dependencies to latest versions

improve cli help

add jsdocs

https://github.com/jsdoc/jsdoc

implement retry mechanism for failed requests

Remove env argument from backupAll command

Remove env dependency in backupAll command. backupAll should backup resources for all environments without having to explicitly specifying the name of the environment

Implement Config profiles

Easily switch between gcp account and apigee organization using config profiles.

apigee-backup-tool config set --name profile-name --orgName org-name --backupFolderPath /test/

add --name option as shown above

implement apigee-backup-tool config use --name profile-name command to switch between various profiles

Current process - use login command and update config file to switch between accounts and organizations

Enable Backup of individual resources

Enable Backing up individual resource like api proxy, shared flows, api products etc

improve documentation

improve github and npm documentation and publish docs to github pages

Cross platform support

Make sure the tool runs on different platforms / OS

Migrate to typescript

improve cli tool

https://clig.dev/#introduction
https://medium.com/jit-team/guidelines-for-creating-your-own-cli-tool-c95d4af62919
https://github.com/lirantal/nodejs-cli-apps-best-practices

Expose the tool as a CLI tool

Use commander to expose it as a CLI tool

add change log

https://blog.logrocket.com/automatically-generate-and-release-a-changelog-with-node-js/
https://keepachangelog.com/en/1.1.0/
https://github.com/github-changelog-generator/github-changelog-generator
https://www.freecodecamp.org/news/a-beginners-guide-to-git-what-is-a-changelog-and-how-to-generate-it/
https://github.com/metcalfc/changelog-generator

Implement Github actions

1. Run eslint, prettier
2. Publish to npm registry
3. Create Docker image and publish to docker hub

Pre-commit hook using husky

run eslint and prettier precommit using husky

add commit lint

https://commitlint.js.org
https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13

Implement backup of specific apigee resource using its name

Allow backup of specifc apigee proxy and shared flow using its name and revision
Allow backup of specific api product, dev , app etc using its name