Skip to content
This repository was archived by the owner on Mar 8, 2020. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [Revoking an identity from a participant](../managing/identity-revoke.html)
- [Enabling OAuth using GitHub](../managing/github-oauth.html)
- [Enabling access control using the current participant](../managing/current-participant.html)
- [Updating {{site.data.conrefs.composer_full}}](../managing/updating-composer.html)
- [Diagnosing Problems](../problems/diagnostics.html)
- [Reference](../reference/reference-index.html)
- [Support](../support/index.html)
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Task - Create a Business Network Definition
category: tasks
section: business-network
index-order: 2
sidebar: sidebars/businessnetworks.md
excerpt: How to create a business network definition
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Task - Deploying and Updating Business Networks
category: tasks
section: business-network
index-order: 3
sidebar: sidebars/businessnetworks.md
excerpt: How to deploy or update Business Networks
---
Expand All @@ -20,17 +22,17 @@ For example:

To update the definition of an already deployed business network use the `composer network update` CLI command.

## Deploying business networks to {{site.data.conrefs.hlf_full}} v1.0 Beta 1
## Deploying business networks to {{site.data.conrefs.hlf_full}} v1.0 RC 1

In {{site.data.conrefs.hlf_full}} v1.0 Beta 1 peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret.
In {{site.data.conrefs.hlf_full}} v1.0 RC 1 peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret.

When connecting to the peer you must use an identity (certificate) where the Common Name (CN) contains the text `admin`, for example, `PeerAdmin`, `myadmin`, `Admin` or `AdminPeer` are all valid Common Names. Peers in different organizations may have different admin users. Only an admin user of peer's organization will be able to deploy a business network to their peers.

Due to many breaking API changes between {{site.data.conrefs.hlf_full}} alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 Beta 1, {{site.data.conrefs.composer_full}} only supports the beta 1 level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).
Due to many breaking API changes between {{site.data.conrefs.hlf_full}} alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 RC 1, {{site.data.conrefs.composer_full}} only supports the RC 1 level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).

### Deploying business networks using Playground locally

When deploying a business network to {{site.data.conrefs.hlf_full}} v1.0 Beta 1 using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity.
When deploying a business network to {{site.data.conrefs.hlf_full}} v1.0 RC 1 using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity.

## References

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Task - Publish Models or Business Network Definitions
category: tasks
section: business-network
index-order: 6
sidebar: sidebars/businessnetworks.md
excerpt: How to publish a model or business network definition for use by applications
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Hyperledger Composer - Developing Business Networks
category: concepts
section: business-network
index-order: 0
sidebar: sidebars/businessnetworks.md
excerpt: Overview of Developing Business Networks
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Hyperledger Composer - Business Network Definition
category: concepts
section: business-network
index-order: 1
sidebar: sidebars/businessnetworks.md
excerpt: Overview of the Business Network Definition
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Emitting Events
category: tasks
section: business-network
index-order: 4
sidebar: sidebars/businessnetworks.md
excerpt: Emitting Events from Transaction Processor Functions
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ layout: default
title: Querying Business Network Data
category: tasks
section: business-network
index-order: 7
sidebar: sidebars/businessnetworks.md
excerpt: Queries are used to return data about the blockchain world-state; for example, you could write a query to return all drivers over a defined age parameter, or all drivers with a specific name.
---
Expand All @@ -15,7 +16,7 @@ Queries are used to return data about the blockchain world-state; for example, y

Queries are an optional component of a business network definition, written in a single query file (`queries.qry`).

Note: Queries are supported by the {{site.data.conrefs.hlf_full}} v1.0, embedded and web runtimes. The query support for the embedded and web runtimes currently has limitations and is unstable. When using the {{site.data.conrefs.hlf_full}} v1.0-beta runtime {{site.data.conrefs.hlf_full}} must be configured to use CouchDB persistence. Queries are **not** supported with the {{site.data.conrefs.hlf_full}} v0.6 runtime.
Note: Queries are supported by the {{site.data.conrefs.hlf_full}} v1.0, embedded and web runtimes. The query support for the embedded and web runtimes currently has limitations and is unstable. When using the {{site.data.conrefs.hlf_full}} v1.0-RC runtime {{site.data.conrefs.hlf_full}} must be configured to use CouchDB persistence. Queries are **not** supported with the {{site.data.conrefs.hlf_full}} v0.6 runtime.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be RC1


## Writing Queries

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
layout: default
title: Task - Testing Business Networks
category: tasks
section: business-network
index-order: 5
sidebar: sidebars/businessnetworks.md
excerpt: How to test business networks
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ index-order: 3

Follow the instructions below to get the required {{site.data.conrefs.composer_full}} development tools and stand up a {{site.data.conrefs.hlf_full}}.

There are two version of {{site.data.conrefs.hlf_full}}: v0.6 and v1.0-beta. The default is for v1.0-beta and we suggest this is the one you use.
There are two version of {{site.data.conrefs.hlf_full}}: v0.6 and v1.0-RC. The default is for v1.0-RC and we suggest this is the one you use.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be RC1


## Before you begin

Expand Down Expand Up @@ -107,7 +107,7 @@ docker rmi $(docker images dev-* -q)

export FABRIC_VERSION=hlfv0.6

{{site.data.conrefs.hlf_full}} v1.0-beta is the default, but to 'unset' the v0.6, or to be explicit in using v1 use this command
{{site.data.conrefs.hlf_full}} v1.0-RC is the default, but to 'unset' the v0.6, or to be explicit in using v1 use this command
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be RC1


export FABRIC_VERSION=hlfv1

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ index-order: 2

# Installing and running {{site.data.conrefs.composer_full}} Playground locally

This tutorial will take you through how to install and run the {{site.data.conrefs.composer_full}} Playground on your local machine. It also creates an instance of {{site.data.conrefs.hlf_full}} v1.0 Beta 1.
This tutorial will take you through how to install and run the {{site.data.conrefs.composer_full}} Playground on your local machine. It also creates an instance of {{site.data.conrefs.hlf_full}} v1.0 RC 1.

{{site.data.conrefs.composer_full}} Playground can also be used in a "browser only" mode, without a running instance of {{site.data.conrefs.hlf_full}}. When used in this mode, all the functionality of {{site.data.conrefs.composer_full}} Playground is available, but all of the data (business networks, assets, participants, and transactions) is persisted into browser local storage.

Expand Down Expand Up @@ -39,17 +39,17 @@ docker images -aq | xargs docker rmi -f
2. Access your local {{site.data.conrefs.composer_full}} Playground by clicking this link: <a href="http://localhost:8080" target="blank">http://<span></span>localhost:8080</a>.


## Deploying business networks to {{site.data.conrefs.hlf_full}} Beta
## Deploying business networks to {{site.data.conrefs.hlf_full}} RC
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be RC1


In {{site.data.conrefs.hlf_full}} Beta peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret.
In {{site.data.conrefs.hlf_full}} RC peers now enforce the concepts of admins and members. Admin user's identities and crypto material must be available to the peer at deployment. To make that identity and its crypto material available, your must import it to your local `keyValStore` directory before deploying the business network. To import the identity, use the [`composer identity import` command](../reference/composer.identity.import.html). When importing an identity, you do not assign it a secret, however the `composer network deploy` command requires a secret. If you are using an imported identity, you can enter any value for the secret.

When connecting to the peer you must use an identity (certificate) where the Common Name (CN) contains the text `admin`, for example, `PeerAdmin`, `myadmin`, `Admin` or `AdminPeer` are all valid Common Names. Peers in different organizations may have different admin users. Only an admin user of peer's organization will be able to deploy a business network to their peers.

Due to many breaking API changes between {{site.data.conrefs.hlf_full}} v1.0 alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 beta, {{site.data.conrefs.composer_full}} only supports the beta level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).
Due to many breaking API changes between {{site.data.conrefs.hlf_full}} v1.0 alpha 1 and {{site.data.conrefs.hlf_full}} v1.0 RC, {{site.data.conrefs.composer_full}} only supports the RC level and cannot support older versions of {{site.data.conrefs.hlf_full}} v1.0 (e.g. alpha 1).

### Deploying business networks using Playground locally

When deploying a business network to {{site.data.conrefs.hlf_full}} Beta using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity.
When deploying a business network to {{site.data.conrefs.hlf_full}} RC using the Playground locally, you must follow the process above to connect using the peer admin identity. However, in order to create identities and interact with your business network in the Playground, you must use the certificate authority admin identity.


---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
layout: default
title: Hyperledger Composer - Overview
title: Introduction
category: overview
section: introduction
index-order: 0
sidebar: sidebars/introduction.md
excerpt: Hyperledger Composer overview
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
layout: default
title: Key Concepts in Hyperledger Composer
title: Key Concepts
sidebar: sidebars/introduction.md
excerpt:
section: introduction
index-order: 1
---

# Features and Concepts in {{site.data.conrefs.composer_full}}
# Key Concepts in {{site.data.conrefs.composer_full}}

{{site.data.conrefs.composer_full}} is a programming model containing a modeling language, and a set of APIs to quickly define and deploy business networks and applications that allow **participants** to send **transactions** that exchange **assets**.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
---
layout: default
title: Solution Architecture
title: Typical Solution Architecture
sidebar: sidebars/introduction.md
excerpt:
section: introduction
index-order: 2.5
---

# Typical {{site.data.conrefs.composer_full}} Solution Architecture
Expand All @@ -29,7 +30,7 @@ excerpt:
{{site.data.conrefs.composer_full}} has been designed to support different pluggable runtimes, and currently has four runtime implementations:

* {{site.data.conrefs.hlf_full}} version 0.6. State is stored on the distributed ledger.
* {{site.data.conrefs.hlf_full}} version 1.0 beta 1. State is stored on the distributed ledger.
* {{site.data.conrefs.hlf_full}} version 1.0 RC 1. State is stored on the distributed ledger.
* Web, which executes within a web page, and is used by Playground. State is stored in browser local storage.
* Embedded, which executes within a Node.js process, and is used primarily for unit testing business logic. State is stored in an in-memory key-value store.

Expand Down
25 changes: 23 additions & 2 deletions packages/composer-website/jekylldocs/managing/updating-composer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,31 @@ title: Updating Hyperledger Composer
category: tasks
section: managing
sidebar: sidebars/managing.md
excerpt:
excerpt: To [update Hyperledger Composer](./updating-composer.html) to a new version, the Hyperledger Composer components must be uninstalled and reinstalled using npm.
index-order: 7
---

# Updating {{site.data.conrefs.composer_full}}

After deploying {{site.data.conrefs.composer_full}} you may wish to upgrade to a new version for additional functionality.
After deploying {{site.data.conrefs.composer_full}} you may wish to upgrade to a new version. To update your installed version of {{site.data.conrefs.composer_full}} you must uninstall the client, admin, and runtime CLI components and reinstall them by using npm.

## Procedure

1. Uninstall the {{site.data.conrefs.composer_full}} components by using the following commands:

npm uninstall -g composer-cli
npm uninstall -g composer-rest-server
npm uninstall -g generator-fabric-composer

2. Install the latest version of the {{site.data.conrefs.composer_full}} components by using the following commands:

npm install -g composer-cli
npm install -g composer-rest-server
npm install -g generator-fabric-composer


## What next?

- [Defining a business network](../business-network/bnd-create.html)
- [Modeling language](../reference/cto_language.html)
- [Managing your solution](./managingindex.html)
2 changes: 2 additions & 0 deletions packages/composer-website/jekylldocs/problems/diagnostics.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ title: Task - Diagnosing Problems
category: tasks
sidebar: sidebars/problems.md
excerpt: Diagnosing Problems
section: diagnostics
index-order: 0
---

# Diagnosing Problems
Expand Down
34 changes: 34 additions & 0 deletions packages/composer-website/jekylldocs/reference/JSDOC-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
index-order: 9
title: API Documentation
section: reference
layout: default
exception: API
excerpt: The Client, Admin, and Runtime components of Hyperledger Composer contain [JavaScript APIs](../jsdoc/index.html) for application integration.
---

# Hyperledger Composer API
Hyperledger Composer is an application development framework for building Blockchain applications based on Hyperledger. This is the JavaScript documentation for the Hyperledger Composer Client, Admin, and Runtime JavaScript APIs.


## Overview
The major components of Hyperledger Composer are:

1. The Hyperledger Composer language for describing the structure of resources (assets, participants
and transactions) that participate in a blockchain backed business network.
2. JavaScript APIs to query, create, update and delete resources and submit transactions
from client applications. Hyperledger Composer resources are stored on the Blockchain.
3. JavaScript transaction processor functions that runs on Hyperledger Fabric when transactions are
submitted for processing. These functions may update the state of resources
stored on the Blockchain via server-side Hyperledger Composer APIs.

## Resources

- [Documentation](https://hyperledger.github.io/composer/)
- [npm modules](https://www.npmjs.com/search?q=hyperledger-composer)
- [GitHub repositories](https://github.com/hyperledger/composer)

## Contributing

To read more about the community and guidelines for submitting pull requests,
please read the [Contributing document](https://github.com/hyperledger/composer/blob/master/CONTRIBUTING.md).
4 changes: 4 additions & 0 deletions packages/composer-website/jekylldocs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@ Permanently disable a business network definition: [composer network undeploy](.

List the contents of a deployed Business Network: [composer network list](./composer.network.list.md)

`composer network logLevel`

Return or update the log level for the composer runtime: [`composer network logLevel`](./composer.network.logLevel.md)

`composer network ping`

Test the connection to a deployed a Business Network: [composer network ping](./composer.network.ping.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Options:
--newUserId, -u The user ID for the new identity [string] [required]
--participantId, -a The particpant to issue the new identity to [string] [required]
--issuer, -x If the new identity should be able to issue other new identities [boolean] [required]
--option, -o Options that are specific specific to a connection. Multiple options are specified by repeating this option [string]
--optionFile, -O A file containing options that are specific to connection [string]
```

## Options
Expand Down
Loading