Skip to content

Commit

Permalink
FAB-17410 Updated doc links to latest levels
Browse files Browse the repository at this point in the history
- Did not update references to 1.4 cc lifecycle
- Removed Kafka (which had old links) from FAQ

Signed-off-by: pama-ibm <pama@ibm.com>
  • Loading branch information
pamandrejko authored and denyeart committed Jan 27, 2020
1 parent 2777611 commit 666a5b7
Show file tree
Hide file tree
Showing 7 changed files with 14 additions and 88 deletions.
84 changes: 5 additions & 79 deletions docs/source/Fabric-FAQ.rst
Original file line number Diff line number Diff line change
Expand Up @@ -242,15 +242,13 @@ Ordering Service

:Answer:
A consensus plugin needs to implement the ``Consenter`` and ``Chain``
interfaces defined in the `consensus package`_. There are two plugins built
against these interfaces already: raft_ and kafka_. You can study them to take
cues for your own implementation. The ordering service code can be found under
interfaces defined in the `consensus package`_. There is a plugin built
against raft_ . You can study it to learn more for your own implementation. The ordering service code can be found under
the `orderer package`_.

.. _consensus package: https://github.com/hyperledger/fabric/blob/master/orderer/consensus/consensus.go
.. _raft: https://github.com/hyperledger/fabric/tree/master/orderer/consensus/etcdraft
.. _kafka: https://github.com/hyperledger/fabric/tree/master/orderer/consensus/kafka
.. _orderer package: https://github.com/hyperledger/fabric/tree/master/orderer
.. _consensus package: https://github.com/hyperledger/fabric/blob/release-2.0/orderer/consensus/consensus.go
.. _raft: https://github.com/hyperledger/fabric/tree/release-2.0/orderer/consensus/etcdraft
.. _orderer package: https://github.com/hyperledger/fabric/tree/release-2.0/orderer

..
Expand All @@ -262,78 +260,6 @@ Ordering Service
This falls under reconfiguring the network. Please consult the topic on
:doc:`commands/configtxlator`.

Solo
~~~~

:Question:
**How can I deploy Solo in production?**

:Answer:
Solo is not intended for production. It is not, and will never be, fault
tolerant. It has been deprecated in favor of Raft and may be removed in a
future release.

Kafka
~~~~~

:Question:
**How do I remove a node from the ordering service?**

:Answer:
This is a two step-process:

1. Add the node's certificate to the relevant orderer's MSP CRL to prevent peers/clients from connecting to it.
2. Prevent the node from connecting to the Kafka cluster by leveraging standard Kafka access control measures such as TLS CRLs, or firewalling.

..
:Question:
**I have never deployed a Kafka/ZK cluster before, and I want to use the
Kafka-based ordering service. How do I proceed?**

:Answer:
The Hyperledger Fabric documentation assumes the reader generally has the
operational expertise to setup, configure, and manage a Kafka cluster
(see :ref:`kafka-caveat`). If you insist on proceeding without such expertise,
you should complete, *at a minimum*, the first 6 steps of the
`Kafka Quickstart guide`_ before experimenting with the Kafka-based ordering
service. You can also consult `this sample configuration file`_ for a brief
explanation of the sensible defaults for Kafka/ZooKeeper.

.. _Kafka Quickstart guide: https://kafka.apache.org/quickstart
.. _this sample configuration file: https://github.com/hyperledger/fabric/blob/release-1.1/bddtests/dc-orderer-kafka.yml

..
:Question:
**Where can I find a Docker composition for a network that uses the
Kafka-based ordering service?**

:Answer:
Consult `the end-to-end CLI example`_.

.. _the end-to-end CLI example: https://github.com/hyperledger/fabric/blob/release-1.3/examples/e2e_cli/docker-compose-e2e.yaml

..
:Question:
**Why is there a ZooKeeper dependency in the Kafka-based ordering service?**

:Answer:
Kafka uses it internally for coordination between its brokers.

..
:Question:
**I'm trying to follow the BYFN example and get a "service unavailable" error,
what should I do?**

:Answer:
Check the ordering service's logs. A "Rejecting deliver request because of
consenter error" log message is usually indicative of a connection problem
with the Kafka cluster. Ensure that the Kafka cluster is set up properly, and
is reachable by the ordering service's nodes.

BFT
~~~

Expand Down
4 changes: 2 additions & 2 deletions docs/source/access_control.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ exercised.

Application developers need to be aware of these resources and the default
policies associated with them. The complete list of these resources are found in
`configtx.yaml`. You can look at a [sample `configtx.yaml` file here](http://github.com/hyperledger/fabric/blob/release-1.2/sampleconfig/configtx.yaml).
`configtx.yaml`. You can look at a [sample `configtx.yaml` file here](http://github.com/hyperledger/fabric/blob/release-2.0/sampleconfig/configtx.yaml).

The resources named in `configtx.yaml` is an exhaustive list of all internal resources
currently defined by Fabric. The loose convention adopted there is `<component>/<resource>`.
Expand Down Expand Up @@ -108,7 +108,7 @@ access control in the channel configuration of an existing channel.
## How ACLs are formatted in `configtx.yaml`

ACLs are formatted as a key-value pair consisting of a resource function name
followed by a string. To see what this looks like, reference this [sample configtx.yaml file](https://github.com/hyperledger/fabric/blob/release-1.2/sampleconfig/configtx.yaml).
followed by a string. To see what this looks like, reference this [sample configtx.yaml file](https://github.com/hyperledger/fabric/blob/release-2.0/sampleconfig/configtx.yaml).

Two excerpts from this sample:

Expand Down
2 changes: 1 addition & 1 deletion docs/source/cc_service.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The chaincode package should be used to provide two pieces of information to the
* provide chaincode endpoint information in a `connection.json` file placed in the release directory. The `bin/run` section describes the `connection.json` file

There is plenty of flexibility to gathering the above information. The sample scripts in the [External builder and launcher sample scripts](#external-builder-and-launcher-sample-scripts) illustrate a simple approach to providing the information.
As an example of flexibility, consider packaging couchdb index files (see [Add the index to your chaincode folder](https://hyperledger-fabric.readthedocs.io/en/release-1.4/couchdb_tutorial.html#add-the-index-to-your-chaincode-folder)). Sample scripts below describe an approach to packaging the files into code.tar.gz.
As an example of flexibility, consider packaging couchdb index files (see [Add the index to your chaincode folder](couchdb_tutorial.html#add-the-index-to-your-chaincode-folder)). Sample scripts below describe an approach to packaging the files into code.tar.gz.

```
tar cfz code.tar.gz connection.json metadata
Expand Down
4 changes: 2 additions & 2 deletions docs/source/commands/fabric-ca-commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ Fabric-CA Client
The fabric-ca-client command allows you to manage identities (including attribute management)
and certificates (including renewal and revocation).

More information on ``fabric-ca-client`` commands can be found `here <https://hyperledger-fabric-ca.readthedocs.io/en/release-1.1/clientcli.html#fabric-ca-client-s-cli>`__.
More information on ``fabric-ca-client`` commands can be found `here <https://hyperledger-fabric-ca.readthedocs.io/en/release-1.4/clientcli.html#fabric-ca-client-s-cli>`__.

Fabric-CA Server
^^^^^^^^^^^^^^^^^

The fabric-ca-server command allows you to initialize and start a server process which may host
one or more certificate authorities.

More information on ``fabric-ca-server`` commands can be found `here <https://hyperledger-fabric-ca.readthedocs.io/en/release-1.1/servercli.html#fabric-ca-server-s-cli>`__.
More information on ``fabric-ca-server`` commands can be found `here <https://hyperledger-fabric-ca.readthedocs.io/en/release-1.4/servercli.html#fabric-ca-server-s-cli>`__.

.. Licensed under Creative Commons Attribution 4.0 International License
https://creativecommons.org/licenses/by/4.0/
2 changes: 1 addition & 1 deletion docs/source/orderer_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The configuration of the orderer is handled through a `yaml` file called
an `orderer.yaml` file you've configured, which will extract a series of files
and certificates on your file system.

To look at a sample `orderer.yaml`, check out the [`fabric-samples` github repo](https://github.com/hyperledger/fabric/blob/release-1.4/sampleconfig/orderer.yaml), which **should be read and studied closely** before proceeding.
To look at a sample `orderer.yaml`, check out the [`fabric-samples` github repo](https://github.com/hyperledger/fabric/blob/release-2.0/sampleconfig/orderer.yaml), which **should be read and studied closely** before proceeding.
Note in particular a few values:

* `LocalMSPID` --- this is the name of the MSP, generated by your CA, of your
Expand Down
2 changes: 1 addition & 1 deletion docs/source/smartcontract/smartcontract.md
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ abbreviations:
* Lifecycle system chaincode (LSCC) manages the chaincode lifecycle for the
1.x releases of Fabric. This version of lifecycle required that chaincode be
instantiated or upgraded on channels. You can read more about how the LSCC
implements this [process](https://hyperledger-fabric.readthedocs.io/en/release-1.4/chaincode4noah.html).
implements this [process](../chaincode4noah.html).
You can still use LSCC to manage your chaincode if you have the channel
application capability set to V1_4_x or below.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/tutorial/commercial_paper.md
Original file line number Diff line number Diff line change
Expand Up @@ -473,9 +473,9 @@ file system within the target peer's docker container. Once the smart contract
is installed on the peer and instantiated on a channel,
`papercontract` can be invoked by applications, and interact with the ledger
database via the
[putState()](https://fabric-shim.github.io/release-1.3/fabric-shim.ChaincodeStub.html#putState__anchor)
[putState()](https://fabric-shim.github.io/release-1.4/fabric-shim.ChaincodeStub.html#putState__anchor)
and
[getState()](https://fabric-shim.github.io/release-1.3/fabric-shim.ChaincodeStub.html#getState__anchor)
[getState()](https://fabric-shim.github.io/release-1.4/fabric-shim.ChaincodeStub.html#getState__anchor)
Fabric APIs. Examine how these APIs are used by `StateList` class within
`ledger-api\statelist.js`.

Expand Down

0 comments on commit 666a5b7

Please sign in to comment.