Hybrid Manager CLI - edbctl

edbctl is a command line tool to manage Hybrid Manager (HM) resources and perform database cluster operations.

Prerequisites

To use edbctl, you must download the package from pgai-platform repository.

Set up the pgai-platform repository.

Setting up the repository is a one-time task. If you have already set up your repository, you don't need to perform this step.

To determine if your repository exists, enter this command:

dnf repolist | grep pgai-platform

If no output is generated, the repository isn't installed.

To set up the pgai-platform repository:

1. Go to repositories page.

2. Select the button that provides access to the repository.

3. Select the platform and software that you want to download.

4. Follow the instructions for setting up the repository.

Use this command to install the edbctl package:

<package-manager> install edbctl

Where <package-manager> is the package manager used with your operating system.

For example, to install edbctl on RHEL 8 platform:

sudo dnf -y install edbctl

After installing the package, configure an access key using the credential command. These credentials allows you to access the supported HM resources and manage them using the edbctl CLI. The CLI supports various commands for managing projects, clusters, backups, credentials, and more.

Examples

edbctl credential import-access-key --name user1 --access-key baak_xyz --address http://localhost:8080
edbctl config set context_project "Adaptable Chameleon"

Options

Use the edbctl --help or -h command to find the complete list of commands available for operations using edbctl:

edbctl --help

Usage:
  edbctl [options]
  edbctl [command]

Management Commands:
  credential        Manage authentication credentials.
  project           Manage projects associated with the database clusters.
  cluster           Manage database cluster resources.
  backup            Manage cluster backups.

Configuration Commands:
  config            Manages configuration settings for edbctl tool
  help              Help about any command
  completion        Generate the autocompletion script for the specified shell

Setup Commands:
  image             Asset management commands
  operator          Operator management commands
  image-pull-secret Pull Secret management commands

Options:
  -h, --help      help for edbctl
  -v, --version   version for edbctl

Use "edbctl [command] --help" for more information about a command.

More information

• edbctl credential — Manage authentication credentials.
• edbctl image — Asset management commands
• edbctl image-pull-secret — Pull secret management commands.
• edbctl operator — Operator management commands.
• edbctl project — Manage projects associated with the database clusters.
• edbctl cluster — Manage database cluster resources.
• edbctl backup — Manage cluster backups.
• edbctl config — Manage configuration settings for edbctl tool.