Skip to content

Commit

Permalink
doc edits - preview & starter kit
Browse files Browse the repository at this point in the history 
clean up video format
change Fabric to fabric
starter kit typos and edits
[ci skip]

Change-Id: I029a79ab4bc27179f251bc88d33d08ae358b384d
Signed-off-by: Nick Gaski <ngaski@us.ibm.com>
  • Loading branch information
@nickgaski
nickgaski committed Oct 3, 2016
1 parent 5b0a7f0 commit fac2d2e
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 30 deletions.
21 changes: 12 additions & 9 deletions docs/abstract_v1.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HYPERLEDGER FABRIC v1.0

Hyperledger Fabric is a platform that enables the delivery of a secure, robust, permissioned blockchain for the enterprise that incorporates a byzantine fault tolerant consensus. We have learned much as we progressed through the v0.6-preview release. In particular, that in order to provide for the scalability and confidentiality needs of many use cases, a refactoring of the architecture was needed. The v0.6-preview release will be the final (barring any bug fixes) release based upon the original architecture.
Hyperledger fabric is a platform that enables the delivery of a secure, robust, permissioned blockchain for the enterprise that incorporates a byzantine fault tolerant consensus. We have learned much as we progressed through the v0.6-preview release. In particular, that in order to provide for the scalability and confidentiality needs of many use cases, a refactoring of the architecture was needed. The v0.6-preview release will be the final (barring any bug fixes) release based upon the original architecture.

Hyperledger fabric's v1.0 architecture has been designed to address two vital enterprise-grade requirements – **security** and **scalability**. Businesses and organizations can leverage this new architecture to execute confidential transactions on networks with shared or common assets – e.g. supply chain, FOREX market, healthcare, etc. The progression to v1.0 will be incremental, with myriad windows for community members to contribute code and start curating the fabric to fit specific business needs.

Expand All @@ -14,16 +14,19 @@ The new architecture introduces a clear functional separation of peer roles, and

The consensus process (i.e. algorithmic computation) is entirely abstracted from the peer. This modularity not only provides a powerful security layer – the consenting nodes are agnostic to the transaction logic – but it also generates a framework where consensus can become pluggable and scalability can truly occur. There is no longer a parallel relationship between the number of peers in a network and the number of consenters. Now networks can grow dynamically (i.e. add endorsers and committers) without having to add corresponding consenters, and exist in a modular infrastructure designed to support high transaction throughput. Moreover, networks now have the capability to completely liberate themselves from the computational and legal burden of consensus by tapping into a pre-existing consensus cloud.

As v1.0 manifests, we will see the foundation for interoperable blockchain networks that have the ability to scale and transact in a manner adherent with regulatory and industry standards. Watch how Fabric v1.0 and the Hyperledger Project are building a true blockchain for business - [![HYPERLEDGERv1.0_ANIMATION](http://img.youtube.com/vi/EKa5Gh9whgU/0.jpg)](http://www.youtube.com/watch?v=EKa5Gh9whgU)
As v1.0 manifests, we will see the foundation for interoperable blockchain networks that have the ability to scale and transact in a manner adherent with regulatory and industry standards. Watch how fabric v1.0 and the Hyperledger Project are building a true blockchain for business -

[![HYPERLEDGERv1.0_ANIMATION](http://img.youtube.com/vi/EKa5Gh9whgU/0.jpg)](http://www.youtube.com/watch?v=EKa5Gh9whgU)

## HOW TO CONTRIBUTE

Use the following links to explore upcoming additions to fabric's codebase that will spawn the capabilities in v1.0:
1. Familiarize yourself with the [guidelines for code contributions](CONTRIBUTING.md) to this project. **Note**: In order to participate in the development of the Hyperledger Fabric project, you will need an [LF account](Gerrit/lf-account.md). This will give you single

* Familiarize yourself with the [guidelines for code contributions](CONTRIBUTING.md) to this project. **Note**: In order to participate in the development of the Hyperledger fabric project, you will need an [LF account](Gerrit/lf-account.md). This will give you single
sign-on to JIRA and Gerrit.
1. Explore the design document for the new [architecture](https://github.com/hyperledger-archives/fabric/wiki/Next-Consensus-Architecture-Proposal)
1. Explore [JIRA](https://jira.hyperledger.org/projects/FAB/issues/) for open Hyperledger Fabric issues.
1. Explore the [JIRA](https://jira.hyperledger.org/projects/FAB/issues/) backlog for upcoming Hyperledger Fabric issues.
1. Explore [JIRA](https://jira.hyperledger.org/issues/?filter=10147) for Hyperledger Fabric issues tagged with "help wanted."
1. Explore the [source code](https://github.com/hyperledger/fabric)
1. Explore the [documentation](http://hyperledger-fabric.readthedocs.io/en/latest/)
* Explore the design document for the new [architecture](https://github.com/hyperledger-archives/fabric/wiki/Next-Consensus-Architecture-Proposal)
* Explore [JIRA](https://jira.hyperledger.org/projects/FAB/issues/) for open Hyperledger fabric issues.
* Explore the [JIRA](https://jira.hyperledger.org/projects/FAB/issues/) backlog for upcoming Hyperledger fabric issues.
* Explore [JIRA](https://jira.hyperledger.org/issues/?filter=10147) for Hyperledger fabric issues tagged with "help wanted."
* Explore the [source code](https://github.com/hyperledger/fabric)
* Explore the [documentation](http://hyperledger-fabric.readthedocs.io/en/latest/)
41 changes: 20 additions & 21 deletions docs/starter/fabric-starter-kit.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Fabric Starter Kit

This section describes how to set up a self contained environment for
application development with the Hyperledger Fabric. The setup
This section describes how to set up a self-contained environment for
application development with the Hyperledger fabric. The setup
uses **Docker** to provide a controlled environment with all the necessary
Hyperledger fabric components to support a Node.js application built with
the fabric's Node.js SDK, and chaincode written in Go.

There are three Docker images that, when run, will provide a basic
network environment. There is an image to run a single `peer`, one to run
the `membersrvc` and one to run both your Node.js application and the your
the `membersrvc`, and one to run both your Node.js application and your
chaincode. See [Application Developer's Overview](../nodeSDK/app-overview.md) on how the
components running within the containers will communicate.

Expand All @@ -18,7 +18,7 @@ In this mode, the chaincode is built and started prior to the application
making a call to deploy it.

**Note:** The deployment of chaincode in network mode requires that the
Hyperledger Fabric Node.js SDK has access to the chaincode source code and all
Hyperledger fabric Node.js SDK has access to the chaincode source code and all
of its dependencies, in order to properly build a deploy request. It also
requires that the `peer` have access to the Docker daemon to be able to build
and deploy the new Docker image that will run the chaincode. *This is a more
Expand All @@ -45,10 +45,9 @@ If you wish, there are a number of chaincode examples near by.
```
curl -o docker-compose.yml https://raw.githubusercontent.com/hyperledger/fabric/master/examples/sdk/node/docker-compose.yml
```
The docker compose environment uses three docker images. Two are published to
DockerHub. However, the third, we provide you the source to build your own,
so that you can customize to inject your application code for development,
the following [Dockerfile](https://raw.githubusercontent.com/hyperledger/fabric/master/examples/sdk/node/Dockerfile)
The docker-compose environment uses three Docker images. Two are published to
DockerHub. However, with the third, we provide you the source to build your own,
so that you can customize it to inject your application code for development. The following [Dockerfile](https://raw.githubusercontent.com/hyperledger/fabric/master/examples/sdk/node/Dockerfile)
is used to build the base **fabric-starter-kit** image and may be used as
a starting point for your own customizations.

Expand Down Expand Up @@ -76,15 +75,15 @@ is located, execute one of following `docker-compose` commands.
docker-compose up
```

Both commands will start three docker containers, to view the container
status try `docker ps` command. The first time this is run the Docker
Both commands will start three Docker containers. To view the container
status use the `docker ps` command. The first time this is run, the Docker
images will be downloaded. This may take 10 minutes or more depending on the
network connections of the system running the command.

```
docker ps
```
You should see something like the following:
You should see something similar to the following:

```
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
Expand All @@ -98,34 +97,34 @@ Node.js application is located.

**note:** Be sure to wait 20 seconds after starting the network using the
`docker-compose up` command before executing the following command to allow
the network to initialize.
the network to initialize:

```
docker exec -it starter /bin/bash
```

* From the terminal session in the **starter** container execute the standalone
Node.js application. The docker terminal session should be in the working
Node.js application. The Docker terminal session should be in the working
directory of the sample application called **app.js** (*/opt/gopath/src/github.com/hyperledger/fabric/examples/sdk/node*). Execute
the following Node.js command to run the application.
the following Node.js command to run the application:

```
node app
```
In another terminal session on the host you can view the logs for the peer
by executing the following command (not in the docker shell above, in a new
terminal session of the real system)
terminal session of the real system):

```
docker logs peer
```

* If you wish to run your own Node.js application using the pre build docker
* If you wish to run your own Node.js application using the pre-built Docker
images:
* use the directories in the `volumes` tag under **starter** in the
`docker-compose.yml` file as a place to store your programs from the host
system into the docker container. The first path is the top level system
(host system) and the second is created in the docker container. If you wish
(host system) and the second is created in the Docker container. If you wish
to use a host location that is not under the `/Users` directory (`~` is
under `/Users') then you must add that to the Docker file sharing
under Docker preferences.
Expand All @@ -136,18 +135,18 @@ images:
```
* copy or create and edit your application in the `~/mytest` directory as
stated in the `docker-compose.yml` `volumes` tag under **starter** container.
* run npm to install Hyperledger Fabric Node.js SDK in the `mytest` directory
* run npm to install Hyperledger fabric Node.js SDK in the `mytest` directory:

```
npm install /opt/gopath/src/github.com/hyperledger/fabric/sdk/node
```
* run the application from within the **starter** Docker container using the
commands
following commands:
```
docker exec -it starter /bin/bash
```
once in the shell, and assuming your Node.js application is called `app.js`
once in the shell, and assuming your Node.js application is called `app.js`:
```
cd /user/mytest
Expand All @@ -164,7 +163,7 @@ the containers from Docker:
docker-compose down
```
or if you wish to keep your changes and just stop the containers, which will
be restarted on the next `up` command
be restarted on the next `up` command:
```
docker-compose kill
Expand Down

0 comments on commit fac2d2e

Please sign in to comment.