trial-license-cleaner

NAME

trial-license-cleaner - removes Trial licenses from nodes running IBM-ICP4D OEM portworx builds, thus resetting the license SKU back to OEM.

SYNOPSIS

trial-license-cleaner [options] px-node

Description

The tool is designed primarily to be ran proactively, to check the licenses before each px-2.3.1.1 to px-2.5.0.1 cluster upgrade, but it could also be used interactively to clean up Trial licenses on already upgraded px-2.5.0.1 clusters.

The tool has the following usage:

Usage: trial-license-cleaner [options] px-node

SSH options:
  -l <user>         Specifies the user to log in as on the remote machine  (default: $LOGNAME)
  -i <pkey-file>    Selects a file from which the identity (private key) for public key authentication is read
  -passwd <secret>  Specify password to log in as on the remote machine (hint: use '-passwd ask' for interactive password prompt)
  -p <port>         Specify ssh service port  (default: 22)

Misc options:
  -d <dir>          Specifies portworx binaries directory (default "/opt/pwx")
  -E <dir>          Specifies portworx configuration directory (default "/etc/pwx")
  --restart         Restart portworx services where license modified  (warn: all nodes in parallel)
  -v                Verbose output
  -h, --help        Print this help
  -V                Print version

EXAMPLES:
  trial-license-cleaner -l root -i $HOME/.ssh/id_rsa_deploy pxnode.company.com
  trial-license-cleaner -l root -passwd ask http://pxnode.company.com:9001

Requirements

The tool does not need to “run locally” on the node running Portworx, but will require remote access to nodes in the portworx cluster. Therefore:

For the tool to operate correctly, two conditions need to be met:

1. Tool requires SSH access to all the hosts running Portworx, and
2. Require network access to a (single) node running portworx REST service.

Required SSH access

The remote user needs to be able to run the sudo commands on the remote nodes of the portworx cluster.

The supported SSH-access methods:

• [default] will try to use $HOME/.ssh/id_rsa private SSH key
  • for this to work successfully, the id_rsa must not be password-protected
    (note, the tool will not interactively prompt for the password to unlock the private SSH key)
• [default] will try to utilize “ssh-agent”
  • for this access to work, the SSH-agent needs to run on the environment, and the SSH keys need to be added into it via ssh-add $HOME/.ssh/id_rsa_locked command
  • this access supports password-protected private SSH keys (they will be “unlocked” and managed by ssh-agent)
• -i <ssh-private-key> can be used to point to a private SSH key we want to use for the SSH access
  • note, using this method turns off “default” SSH access
• -passwd <password> can be used to specify the SSH password
  • note, one can use -passwd ask to be interactively prompted for password
  • note, using this method turns off “default” SSH access

Required access to Portworx REST service

The tool requires network access to one Portworx node from the cluster, therefore at last one node needs to be running Portowrx service. The node IP or hostname is added as the last parameter to the command.

By default, the tool will target Portworx REST service running on http://pxnode-hostname-or-ip:9001, but alternative ports can be specified like http://pxnode-hostname-or-ip:17001 for “moved” port-ranges (i.e. custom Portworx installations, or OpenShift 4.3).

Known Limitations

• the tool does not automatically discover Portworx installations running on non-default network port (:9001)
  • hint: one can pass full endpoint as parameter, to target a different port (e.g. trial-license-cleaner -v http://pxnode-hostname-or-ip:17001)
• the tool does not support custom SSL certificates to access Portworx KVDB (key-value database)
• the tool also does not support custom username/password to access Portworx KVDB
• if --restart option provided, all Portworx nodes where license got corrected will be restarted; however, the restart will happen in parallel