Configuration Automation - Ping CLI

Run as a Docker container

Ping CLI is available as a Docker image, allowing you to run it in containerized environments without installing it directly on your system.

Before you begin

You must have:

  • Docker installed and running on your system.

  • Basic familiarity with Docker commands.

You can find installation instructions in the Docker documentation.

Pull the Ping CLI Docker image

Pull the latest Ping CLI image from Docker Hub:

docker pull pingidentity/pingcli:latest

To pull a specific version:

docker pull pingidentity/pingcli:1.0.0

Verify the installation

Verify that the Docker image was pulled successfully:

docker run pingidentity/pingcli:latest --version

You should see output similar to:

pingcli version 1.0.0

Running Ping CLI in Docker

Basic usage

Run Ping CLI commands inside the container:

docker run pingidentity/pingcli:latest --help

Interactive shell

To run Ping CLI interactively inside the container:

docker run -it pingidentity/pingcli:latest

Mounting local directories

To work with configuration files stored on your host system, mount a local directory:

docker run -v /path/to/local/config:/app/config pingidentity/pingcli:latest config list

Using Ping CLI in CI/CD pipelines

Docker makes it easy to use Ping CLI in continuous integration and continuous delivery (CI/CD) workflows. Use the image in GitHub Actions, Docker Compose, or other orchestration tools.

Configuration migration in CI/CD

When you upgrade the Ping CLI Docker image and use it for the first time, the tool automatically detects the old configuration format and creates a migration plan. For non-interactive environments, set the following environment variable to auto-approve migration:

docker run -e PINGCLI_CONFIG_MIGRATION_POLICY=yes \
  -v /path/to/local/config:/app/config \
  pingidentity/pingcli:latest pingone groups list

Upgrading the Docker image

To upgrade to a newer version of the Ping CLI Docker image:

docker pull pingidentity/pingcli:latest

Or pull a specific version:

docker pull pingidentity/pingcli:1.0.0

When you run the new image, your configuration files are automatically migrated to the new format on first use. The process is safe and includes automatic backups (stored within the container or mounted volume).

Removing the Docker image

To remove the Ping CLI Docker image from your system:

docker rmi pingidentity/pingcli:latest

Or remove a specific version:

docker rmi pingidentity/pingcli:1.0.0

To remove unused images (including dangling ones):

docker image prune

Next steps

Now that you’re familiar with running Ping CLI in Docker, proceed to: