mirror of
https://github.com/corda/corda.git
synced 2025-03-14 00:06:45 +00:00
ENT-1955, ENT-2227 - Documentation scrub and TOC update (#1209)
* ENT-1955 - Fix capitalisation of page headings * ENT-2227 - Remove design proposals from enterprise docs * ENT-1955 - Fix formatting issue in release notes * ENT-1955 - Miscellaneous updates and formatting fixes * ENT-1955 - Update title of Corda Firewall
This commit is contained in:
parent
2f4642e0fc
commit
28561280d0
@ -36,7 +36,7 @@ your own ``bridge.conf`` file will use these defaults:
|
||||
.. literalinclude:: ../../bridge/src/main/resources/bridgedefault.conf
|
||||
:language: javascript
|
||||
|
||||
Bridge Operating Modes
|
||||
Bridge operating modes
|
||||
----------------------
|
||||
.. note:: By default, the Corda node assumes that it will carry out the peer-to-peer functions of the bridge internally!
|
||||
Before running a dedicated bridge process, it is essential to turn off the dev mode component by setting the
|
||||
@ -212,8 +212,8 @@ absolute path to the bridge's base directory.
|
||||
|
||||
:enableAMQPPacketTrace: Set this developer flag to true if very detailed logs are required for connectivity debugging. Note that the logging volume is substantial, so do not enable in production systems.
|
||||
|
||||
Fully Worked Example
|
||||
-------
|
||||
Complete example
|
||||
----------------
|
||||
As an example to show all features the following is a walk through of the configuration for a pair of HA hot-cold Nodes,
|
||||
connected to by a HA hot-warm set of ``BridgeInner`` and ``FloatOuter`` that use some simple certificates to secure the
|
||||
control tunnel and a SOCKS5 proxy for outgoing connectivity (see diagram).
|
||||
|
@ -1,4 +1,4 @@
|
||||
Certificate Revocation List
|
||||
Certificate revocation list
|
||||
===========================
|
||||
|
||||
The certificate revocation list consists of certificate serial numbers of issued certificates that are no longer valid.
|
||||
@ -56,8 +56,8 @@ Submission of the certificate revocation requests expects the following fields t
|
||||
|
||||
:reporter: Issuer of this certificate revocation request.
|
||||
|
||||
Note: At least one of the three: certificateSerialNumber, csrRequestId or legalName needs to be specified.
|
||||
Also, Corda AMQP serialization framework is used as the serialization framework.
|
||||
.. note:: At least one of the three: certificateSerialNumber, csrRequestId or legalName needs to be specified.
|
||||
Also, Corda AMQP serialization framework is used as the serialization framework.
|
||||
|
||||
Because of the proprietary serialization mechanism, it is assumed that those endpoints are used by dedicated tools that support this kind of data encoding.
|
||||
|
||||
|
@ -1,5 +1,5 @@
|
||||
Corda Bridge Component Overview
|
||||
===============================
|
||||
Bridge component overview
|
||||
=========================
|
||||
|
||||
.. contents::
|
||||
|
||||
@ -35,7 +35,7 @@ protocol will continue to be AMQP 1.0 over TLS.
|
||||
|
||||
.. Note:: All deployment modes of the bridge, float, or all-in-one node are transparently interoperable, if correctly configured.
|
||||
|
||||
Message Path Between Peer Nodes
|
||||
Message path between peer nodes
|
||||
-------------------------------
|
||||
When a flow within a node needs to send a message to a peer there is a carefully orchestrated sequence of steps to ensure
|
||||
correct secure routing based upon the network map information and to ensure safe, restartable delivery to the remote flow.
|
||||
|
@ -5,7 +5,7 @@
|
||||
<script type="text/javascript" src="_static/codesets.js"></script>
|
||||
|
||||
|
||||
Database Management
|
||||
Database management
|
||||
===================
|
||||
|
||||
Corda - the platform, and the installed third-party CorDapps store their data in a relational database (see
|
||||
|
@ -4,8 +4,8 @@
|
||||
|
||||
.. role:: red
|
||||
|
||||
Deterministic Corda Modules
|
||||
===========================
|
||||
Deterministic modules
|
||||
=====================
|
||||
|
||||
A Corda contract's verify function should always produce the same results for the same input data. To that end,
|
||||
Corda provides the following modules:
|
||||
@ -21,7 +21,7 @@ contract verification should be compiled against these modules to prevent them c
|
||||
.. note:: These modules are only a development aid. They cannot guarantee determinism without also including
|
||||
deterministic versions of all their dependent libraries, e.g. ``kotlin-stdlib``.
|
||||
|
||||
Generating the Deterministic Modules
|
||||
Generating the deterministic modules
|
||||
------------------------------------
|
||||
|
||||
JDK 8
|
||||
@ -92,7 +92,7 @@ The build generates each of Corda's deterministic JARs in six steps:
|
||||
This step will fail if ProGuard spots any Java API references that still cannot be satisfied by the deterministic
|
||||
``rt.jar``, and hence it will break the build.
|
||||
|
||||
Configuring IntelliJ with a Deterministic SDK
|
||||
Configuring IntelliJ with a deterministic SDK
|
||||
---------------------------------------------
|
||||
|
||||
We would like to configure IntelliJ so that it will highlight uses of non-deterministic Java APIs as :red:`not found`.
|
||||
@ -195,7 +195,7 @@ These steps will enable IntelliJ's presentation compiler to use the deterministi
|
||||
|
||||
but still build everything using Gradle with the full JDK.
|
||||
|
||||
Testing the Deterministic Modules
|
||||
Testing the deterministic modules
|
||||
---------------------------------
|
||||
|
||||
The ``core-deterministic:testing`` module executes some basic JUnit tests for the ``core-deterministic`` and
|
||||
|
@ -1,8 +1,8 @@
|
||||
.. highlight:: kotlin
|
||||
.. raw:: html
|
||||
|
||||
Hot-Cold Deployment
|
||||
===================
|
||||
Hot-cold high availability deployment
|
||||
=====================================
|
||||
|
||||
Overview
|
||||
--------
|
||||
|
@ -69,19 +69,3 @@ application development please continue to refer to `the main project documentat
|
||||
|
||||
deterministic-modules.rst
|
||||
changelog.rst
|
||||
|
||||
.. only:: htmlmode
|
||||
|
||||
.. toctree::
|
||||
:caption: Design docs
|
||||
:maxdepth: 2
|
||||
|
||||
design/design-review-process.md
|
||||
design/certificate-hierarchies/design.md
|
||||
design/failure-detection-master-election/design.md
|
||||
design/float/design.md
|
||||
design/hadr/design.md
|
||||
design/kafka-notary/design.md
|
||||
design/monitoring-management/design.md
|
||||
design/sgx-integration/design.md
|
||||
|
||||
|
@ -1,4 +1,4 @@
|
||||
Platform Support Matrix
|
||||
Platform support matrix
|
||||
=======================
|
||||
|
||||
Our supported Operating System platforms are a subset of those supported by Java `8u172 <http://www.oracle.com/technetwork/java/javase/certconfig-2095354.html>`_. Production use of Corda Enterprise 3.0 is only supported on Linux OS, see details below.
|
||||
|
@ -1,4 +1,4 @@
|
||||
Release Notes
|
||||
Release notes
|
||||
=============
|
||||
|
||||
|release|
|
||||
@ -148,9 +148,9 @@ From a build perspective, switching CorDapps built using Corda 3.x to |release|
|
||||
and simply requires making the Corda Enterprise binaries available to Gradle, and changing two variables in the build file:
|
||||
|
||||
|
||||
.. parsed-literal:: shell
|
||||
.. sourcecode:: shell
|
||||
|
||||
ext.corda_release_version = '|version|'
|
||||
ext.corda_release_version = '3.0'
|
||||
ext.corda_release_distribution = 'com.r3.corda'
|
||||
|
||||
..
|
||||
|
@ -1,4 +1,4 @@
|
||||
Sizing and Performance
|
||||
Sizing and performance
|
||||
======================
|
||||
|
||||
Overview
|
||||
|
@ -1,4 +1,4 @@
|
||||
Corda and Corda Enterprise Compatibility
|
||||
Corda and Corda Enterprise compatibility
|
||||
========================================
|
||||
|
||||
Corda Enterprise 3.0 provides a baseline for wire stability and compatibility with future versions of Corda Enterprise, and open-source releases of Corda starting from version 3.0.
|
||||
|
Loading…
x
Reference in New Issue
Block a user