Cluster Administrator Tooling
This section outlines the tools needed by a Cluster Administrator to deploy and operate Corda. There are additional tools which may be required depending on the installation approach taken.
| Tool | Description |
|---|---|
| Kubernetes A powerful tool for managing containerized applications at scale, making it easier for teams to deploy and manage their applications with high reliability and efficiency. CLI | Corda 5 is deployed to Kubernetes and to interact with the cluster, the Cluster Administrator requires the Kubernetes client kubectl. The Kubernetes documentation contains details on how to install kubectl. You should use a version of the CLI that is within one minor version of the Kubernetes cluster that you are using, for example, if your cluster is v1.23, your CLI should be v1.22, v1.23, or v1.24. |
| Helm A package manager for Kubernetes, which is an open-source container orchestration platform. CLI | Corda 5 is deployed as a Helm chart. To perform the installation, the Cluster Administrator requires the Helm CLI. The Helm documentation contains details on how to install Helm. The Helm version should be v3.9.4 or newer. |
| Corda CLI A command line tool that supports various Corda-related tasks, including Corda Package Installer (CPI) creation and Corda cluster management. | The Cluster Administrator requires the Corda CLI if they intend to manually bootstrap Kafka and PostgreSQL. See the documentation on installing the Corda CLI. |
| curl | Examples in this documentation for Linux and macOS use the curl CLI to interact with HTTP endpoints. See the curl documentation for details on how to install curl. Alternatives may be used if desired. On Windows, PowerShell contains native support for HTTP calls. |
| jq | Examples in this documentation for Linux and macOS use the jq CLI to parse content out of JSON responses received from the Corda REST API. See the jq documentation for details on how to install jq. Alternatives may be used if desired. On Windows, PowerShell contains native support for parsing JSON. |
| PostgreSQL Client | The Cluster Administrator, or their database administrator, requires a PostgreSQL client if they intend to manually bootstrap PostgreSQL. Examples in this documentation use the psql CLI. See the Postgres documentation for details on how to download Postgres. Alternatives may be used if desired. |
| Kafka The means by which Corda workers communicate, acting as a central message bus between the worker processes. Client | The Cluster Administrator, or their Kafka administrator, may require a Kafka client if they intend to manually bootstrap Kafka. Examples in this documentation use the scripts packaged with Kafka. See the Kafka documentation for details on how to download Kafka. Alternatives may be used if desired. |
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.