preinstall
This section lists the Corda CLI
A command line tool that supports various Corda-related tasks, including Corda Package Installer (CPI) creation and Corda cluster management.
preinstall arguments. You can use these commands to manually check Corda’s configuration, to confirm that all the Corda deployment prerequisites
are running and that the correct credentials and permissions are provided to install a running Corda cluster.
The YAML files used by the commands must be of the format described in the Configure the Deployment section. This allows you to use the commands to verify the override configuration used as part of a Corda Helm installation.
check-limits
The check-limits argument verifies if the resource limits have been assigned correctly.
| Argument | Description |
|---|---|
| <path> | The YAML file containing resource limit overrides for the Corda install. |
./corda-cli.sh preinstall check-limits <path>
./corda-cli.cmd preinstall check-limits <path>
check-postgres
The check-postgres argument verifies if the PostgreSQL database is up and if the credentials work.
| Argument | Description |
|---|---|
| <path> | The YAML file containing the user name and password values for PostgreSQL - either as values, or as secret references. |
| -n, --namespace=<namespace> | The namespace in which to look for PostgreSQL secrets, if there are any. |
./corda-cli.sh preinstall check-postgres [-n=<namespace>] <path>
./corda-cli.cmd preinstall check-postgres [-n=<namespace>] <path>
check-kafka
The check-kafka argument verifies if Kafka is up and if the credentials work.
| Argument | Description |
|---|---|
| <path> | The YAML file containing the Kafka, SASL, and TLS configurations. |
| -n, --namespace=<namespace> | The namespace in which to look for the Kafka secrets if TLS or SASL is enabled. |
| -t, --timeout=<timeout> | The timeout in milliseconds for testing the Kafka connection - defaults to 3000. |
./corda-cli.sh preinstall check-kafka [-n=<namespace>] [-t=<timeout>] <path>
./corda-cli.cmd preinstall check-kafka [-n=<namespace>] [-t=<timeout>] <path>
run-all
The run-all argument runs all pre-install checks.
| Argument | Description |
|---|---|
| <path> | The YAML file containing all configurations. |
| -n, --namespace=<namespace> | The namespace in which to look for both the PostgreSQL and Kafka secrets. |
| -t, --timeout=<timeout> | The timeout in milliseconds for testing the Kafka connection - defaults to 3000. |
./corda-cli.sh preinstall run-all [-n=<namespace>] [-t=<timeout>] <path>
./corda-cli.cmd preinstall run-all [-n=<namespace>] [-t=<timeout>] <path>
Was this page helpful?
Thanks for your feedback!
Chat with us
Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.
Propose documentation improvements directly
Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.
We're sorry this page wasn't helpful. Let us know how we can make it better!
Chat with us
Chat with us on our #docs channel on slack. You can also join a lot of other slack channels there and have access to 1-on-1 communication with members of the R3 team and the online community.
Create an issue
Create a new GitHub issue in this repository - submit technical feedback, draw attention to a potential documentation bug, or share ideas for improvement and general feedback.
Propose documentation improvements directly
Help us to improve the docs by contributing directly. It's simple - just fork this repository and raise a PR of your own - R3's Technical Writers will review it and apply the relevant suggestions.