Skip to content

Commit ad643bc

Browse files
author
mar
committed
doc: write about integrity check in tcm
1 parent c656a36 commit ad643bc

File tree

1 file changed

+6
-37
lines changed

1 file changed

+6
-37
lines changed

doc/tooling/tcm/tcm_integrity_check.rst

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,6 @@ This mechanism allows TCM to:
1616
* Allows updating the configuration with integrity check support.
1717
* Detect unauthorized changes in centralized configuration.
1818

19-
.. _tcm_integrity_check_enable:
20-
21-
Enabling integrity check
22-
------------------------
23-
24-
To enable integrity checks, you must sign the application and configuration:
25-
26-
#. Package the application with integrity checks:
27-
28-
.. code-block:: console
29-
30-
tt pack --with-integrity-check
31-
32-
#. Publish configuration with integrity metadata:
33-
34-
.. code-block:: console
35-
36-
tt cluster publish --with-integrity-check
37-
3819
.. _tcm_integrity_check_configure:
3920

4021
Configure integrity check
@@ -79,23 +60,11 @@ Example configuration
7960
~~~~~~~~~~~~~~~~~~~~~
8061

8162
Integrity check in |tcm| can be enabled and customized using several methods.
82-
You can configure it directly in the |tcm| configuration file or through environment variables when starting the application.
83-
84-
* In configuration file:
85-
86-
.. code-block:: yaml
87-
88-
# tcm.yaml
89-
security:
90-
integrity-check: true
91-
signature-private-key-file: /etc/tcm/private_key.pem
92-
93-
94-
* Environment variables:
95-
96-
.. code-block:: console
63+
You can configure it directly in the |tcm| configuration file:
9764

98-
export TCM_SECURITY_INTEGRITY_CHECK=true
99-
export TCM_SECURITY_SIGNATURE_PRIVATE_KEY_FILE=/etc/tcm/private_key.pem
65+
.. code-block:: yaml
10066
101-
tt --integrity-check /etc/tcm/public_key.pem start tcm
67+
# tcm.yaml
68+
security:
69+
integrity-check: true
70+
signature-private-key-file: /etc/tcm/private_key.pem

0 commit comments

Comments
 (0)