Skip to content

Get Started

You can quickly deploy Docker images of Ping Identity products. We use Docker, Docker Compose, and Kubernetes to deploy our Docker images in stable, network-enabled containers. Our Docker images are preconfigured to provide working instances of our products, either as single containers or in orchestrated sets.

Prerequisites

  • Docker
  • Docker Compose (included with Docker Desktop on Mac and Windows)
  • Your terminal configuration is set to use the Bash shell.

    Default Shell

    With Apple macOS Catalina, the Z shell (zsh) is the default shell, rather than Bash. To set your default terminal shell to Bash, enter: chsh -s /bin/bash.

  • You've installed the ping-devops utility.

Product license

You'll need a product license to run our Docker images. You can use either:

  • An evaluation license obtained with a valid DevOps user key. See DevOps Registration for more information.

  • Although you'll first need to complete your DevOps Registration, you can subsequently use a valid product license available with a current Ping Identity customer subscription.

Set Up Your Devops Environment

  1. Open a terminal and create a local DevOps directory named ${HOME}/projects/devops.

    Parent Directory

    We'll use this as the parent directory for all DevOps examples referenced in our documentation.

  2. Configure your DevOps environment:

    ping-devops config
    
    1. Respond to all Docker configuration questions, accepting the defaults if you're not sure. You can accept the (empty) defaults for Kubernetes. Settings for custom variables aren't needed initially.

    2. All of your responses are stored as settings in your local ~/.pingidentity/devops file. Allow the configuration script to source this file in your shell profile (for example, ~/.bash_profile).

  3. To display your DevOps environment settings, enter:

    ping-devops info
    
  4. You can use the ping-devops utility to run a quick demonstration of any of our products in your Docker environment.

    a. To display information about the containers or stacks available using the ping-devops utility, enter:

    ping-devops docker info
    

    b. To display information about one of the listed containers or stacks, enter:

    ping-devops docker info <name>
    

    Where <name> is one of the listed container or stack names.

  5. To start one of the containers or stacks, enter:

    ping-devops docker start <name>
    

    Where <name> is one of the listed container or stack names.

    The initial run will ensure dependencies are met (such as, Docker or Docker Compose).

  6. When you're done:

    To stop the container or stack, enter:

    ping-devops docker stop <name>
    

    To remove the container or stack and all associated data, enter

    ping-devops docker rm  <name>