2020-12-04 14:00:47 +03:00
|
|
|
Operations
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
This section describes how :term:`Operators` manage the different nodes constituting a CCF network.
|
|
|
|
|
|
|
|
|
|
.. panels::
|
|
|
|
|
|
2021-01-05 22:04:12 +03:00
|
|
|
:fa:`laptop-code` :doc:`run_setup`
|
2021-11-23 20:35:01 +03:00
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2020-12-04 14:00:47 +03:00
|
|
|
|
|
|
|
|
Set up a VM or a container to run a CCF application node.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
:fa:`play-circle` :doc:`start_network`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Start a new instance of a CCF service, and add an initial set of execution nodes.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2021-11-23 20:35:01 +03:00
|
|
|
:fa:`cogs` :doc:`configuration`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Configure CCF nodes from JSON configuration file.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2020-12-04 14:00:47 +03:00
|
|
|
:fa:`upload` :doc:`ledger_snapshot`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Provision a new execution node for an existing service quickly from a state snapshot.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2022-01-12 12:01:56 +03:00
|
|
|
:fa:`sync-alt` :doc:`code_upgrade`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Upgrade a live service with minimal downtime.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
:fa:`sync-alt` :doc:`code_upgrade_1x`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Specific guidelines to upgrade a service from CCF 1.x to 2.0.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2021-10-28 15:51:32 +03:00
|
|
|
:fa:`stamp` :doc:`certificates`
|
2022-01-12 12:01:56 +03:00
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
2021-10-28 15:51:32 +03:00
|
|
|
|
|
|
|
|
Set and renew nodes and service x509 certificates.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2020-12-04 14:00:47 +03:00
|
|
|
:fa:`helicopter` :doc:`recovery`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Recover a service instance from a catastrophic failure, using one or more ledger copies.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2022-06-24 12:14:18 +03:00
|
|
|
:fa:`network-wired` :doc:`network`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Configure a network to deploy a CCF service.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
2020-12-04 14:00:47 +03:00
|
|
|
:fa:`file-alt` :doc:`node_output`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Monitor node health and events using logs.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
:fa:`tachometer-alt` :doc:`resource_usage`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Monitor node resource consumption.
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
:fa:`terminal` :doc:`operator_rpc_api`
|
|
|
|
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
|
|
|
|
|
|
|
|
Node API reference.
|
|
|
|
|
|
|
|
|
|
.. toctree::
|
|
|
|
|
:hidden:
|
|
|
|
|
|
2021-01-05 22:04:12 +03:00
|
|
|
run_setup
|
2020-12-04 14:00:47 +03:00
|
|
|
start_network
|
2021-11-23 20:35:01 +03:00
|
|
|
configuration
|
2020-12-04 14:00:47 +03:00
|
|
|
ledger_snapshot
|
2022-03-15 17:25:34 +03:00
|
|
|
code_upgrade
|
|
|
|
|
code_upgrade_1x
|
2021-11-09 15:00:15 +03:00
|
|
|
certificates
|
2020-12-04 14:00:47 +03:00
|
|
|
recovery
|
2022-06-24 12:14:18 +03:00
|
|
|
network
|
2020-12-04 14:00:47 +03:00
|
|
|
node_output
|
|
|
|
|
resource_usage
|
2022-01-13 12:57:26 +03:00
|
|
|
operator_rpc_api
|
