cloudiam/ciam-cli repository overview

⁠ciam-cli

A convenient way to manage your Cloud-IAM deployment

Prepare your deployment configuration file:

$ cat > ~/.ciam-cli/.env << EOF
DEPLOYMENT_ID=00000000-0000-0000-0000-000000000000;
SA_CLIENT_ID=sa_ffffffff-ffff-ffff-ffff-ffffffffffff;
SA_CLIENT_SECRET=<client-secret>
EOF
$ docker run --rm -it --env-file ~/.ciam-cli/.env cloudiam/ciam-cli info

⁠common

All the tasks require credentials to communicate with the Cloud-IAM API. The credentials can be provided by command line arguments or environment variables.

⁠info

This command displays details about the deployment.

⁠logs

This command retrieves the Keycloak logs generated by the deployment and follow the output The logs from the nodes are merged together.

The command periodically polls the API to fetch the latest logs.

To fetch the logs from the last 10 minutes:

$ ciam-cli logs --since 10min

This command can also be used to retrieve the logs in the customer infrastructure. Simply start the command and use set the --save-state to be resilient to restart.

A file named .ciam-logs.state will be created and will store the timestamp of the latest processed log entry.

If the command is restarted and the file is present, it will continue fetching the values starting from the date stored in this file.