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
Show all changes
27 commits
Select commit Hold shift + click to select a range
d8bfac1
Merge remote-tracking branch 'hyperledger/master'
EdProsser Jun 15, 2017
caeedc3
Merge remote-tracking branch 'hyperledger/master'
EdProsser Jun 19, 2017
fd76df6
Merge remote-tracking branch 'hyperledger/master'
EdProsser Jun 29, 2017
2ba0a15
Merge remote-tracking branch 'hyperledger/master'
EdProsser Jun 29, 2017
e8b27d2
Merge remote-tracking branch 'hyperledger/master'
EdProsser Jul 5, 2017
75a6419
Merge remote-tracking branch 'hyperledger/master'
EdProsser Jul 6, 2017
baadf55
v.1 diagnosing and connector specific info
EdProsser Jul 6, 2017
c27ffd6
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 7, 2017
2af32d3
minor update
EdProsser Jul 10, 2017
9b0af8c
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 10, 2017
d23e7b5
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 11, 2017
acd143a
Readmefix, modelling and acl
EdProsser Jul 11, 2017
64a8654
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 13, 2017
bb945fe
Add in shortened accordion ToC
EdProsser Jul 13, 2017
0db3091
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 17, 2017
f3ba941
Merging master changes
EdProsser Jul 17, 2017
a804b1b
System ACL doc
EdProsser Jul 18, 2017
342f269
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 18, 2017
6db6897
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 19, 2017
d42476d
More changes
EdProsser Jul 19, 2017
5fff628
last changes
EdProsser Jul 19, 2017
722b2c7
Merge remote-tracking branch 'hyperledger/master' into 6-7-17-ed
EdProsser Jul 19, 2017
d22fac4
RC -> v1.0, network start, runtime install,
EdProsser Jul 19, 2017
65bc6b2
Adding links to new commands
EdProsser Jul 19, 2017
7cbc2e8
Merge remote-tracking branch 'hyperledger/master' into options-19-7-ed
EdProsser Jul 19, 2017
fd85a0a
Update for modelling lang doc
EdProsser Jul 19, 2017
9c7b51d
hyper ledger fabric endorsing peer
EdProsser Jul 19, 2017
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 @@ -3,9 +3,9 @@
{% if page.index-order %}
{% capture mods %}{{ page.index-order | modulo:100 }}{% endcapture %}
{% if mods == "0" %}
- [{{ page.title }}](../{{page.url}}.html)
- [{{ page.title }}](..{{page.url}}.html)
{% elsif mods != "0" %}
- [{{page.title}}](../{{page.url}}.html)
- [{{page.title}}](..{{page.url}}.html)
{% endif %}
{% endif %}
{% endfor %}
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,18 @@ 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}} RC 1
## Deploying business networks to {{site.data.conrefs.hlf_full}} v1.0

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.
In {{site.data.conrefs.hlf_full}} v1.0 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 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).
Due to many breaking API changes between {{site.data.conrefs.hlf_full}} alpha 1 and {{site.data.conrefs.hlf_full}} v1.0, {{site.data.conrefs.composer_full}} only supports the {{site.data.conrefs.hlf_full}} v1.0 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 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.
When deploying a business network to {{site.data.conrefs.hlf_full}} v1.0 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 @@ -16,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-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.
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 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.

## Writing Queries

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

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-RC. The default is for v1.0-RC and we suggest this is the one you use.
There are two version of {{site.data.conrefs.hlf_full}}: v0.6 and v1.0. The default is for v1.0 and we suggest this is the one you use.

## 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-RC 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 is the default, but to 'unset' the v0.6, or to be explicit in using v1 use this command

export FABRIC_VERSION=hlfv1

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

# 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 RC 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.

{{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}} RC
## Deploying business networks to {{site.data.conrefs.hlf_full}} v1.0

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.
In {{site.data.conrefs.hlf_full}} v1.0 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 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).
Due to many breaking API changes between {{site.data.conrefs.hlf_full}} v1.0 alpha 1 and {{site.data.conrefs.hlf_full}} v1.0, {{site.data.conrefs.composer_full}} only supports {{site.data.conrefs.hlf_full}} v1.0 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}} 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.
When deploying a business network to {{site.data.conrefs.hlf_full}} v1.0 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
Expand Up @@ -30,7 +30,7 @@ index-order: 102
{{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 RC 1. State is stored on the distributed ledger.
* {{site.data.conrefs.hlf_full}} version 1.0. 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
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The config module does write out a warning, if there are no configuration files
- advice: set loglevel to debug on deploy because if deploy breaks you want the logs.


## {{site.data.conrefs.hlf_full}} RC1 - David

Choose a reason for hiding this comment

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

Just checking, should it say "David" here ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah that's commented out. :)

## {{site.data.conrefs.hlf_full}} v1.0 - David


-->
Expand Down
10 changes: 9 additions & 1 deletion packages/composer-website/jekylldocs/reference/acl_language.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,15 @@ Network access is required to use the CREATE operation on participants or the UP

### Granting network access control

Network access is granted using the system namespace. The system namespace is always `org.hyperledger.composer.system`.
Network access is granted using the system namespace. The system namespace is always `org.hyperledger.composer.system.Network` for network access, and `org.hyperledger.composer.system` for all access. The following access control rules gives the **networkControl** participant the authority to use all operations with network commands.

rule networkControlPermission {
description: "networkControl can access network commands"
participant: "org.acme.vehicle.auction.networkControl"
operation: ALL
resource: "org.hyperledger.composer.system.Network"
action: ALLOW
}

The following access control rule will give all participants access to all operations and commands in the business network, including network access and business access.

Expand Down
8 changes: 8 additions & 0 deletions packages/composer-website/jekylldocs/reference/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,14 @@ Test the connection to a deployed a Business Network: [composer network ping](./

Update a deployed Business Network: [composer network update](./composer.network.update.md)

`composer network start`

Deploy a business network archive to a {{site.data.conrefs.hlf_full}} endorsing peer that already has the {{site.data.conrefs.composer_full}} runtime installed: [composer network start](./composer.network.start.md)

`composer runtime install`

Install the {{site.data.conrefs.composer_full}} runtime to a {{site.data.conrefs.hlf_full}} endorsing peer: [composer runtime install](./composer.runtime.install.md)

## Participant and Identity management

`composer participant add`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ excerpt: Composer Network Deploy CLI

---

The `composer network deploy` utility is used to deploy a business network archive from local disk to a Hyperledger Fabric runtime.
The `composer network deploy` utility is used to deploy a business network archive from local disk to a {{site.data.conrefs.hlf_full}} v1.0 runtime.

```
composer network deploy -a <business-network-archive> -i <enrollment-id> -s <enrollment-secret>
Expand Down Expand Up @@ -43,34 +43,25 @@ Command completed successfully.

## {{site.data.conrefs.hlf_full}} Endorsement Policies

The `--option, -o` option and the `--optionsFile, -O` option allow connection specific information to be sent. {{site.data.conrefs.hlf_full}} RC endorsement policies can be sent using the `-o` and `-O` options in several ways.
The `--option, -o` option and the `--optionsFile, -O` option allow connection specific information to be sent. {{site.data.conrefs.hlf_full}} v1.0 endorsement policies can be sent using the `-o` and `-O` options in several ways.

- Using the `-o` option, the endorsement policy can be sent as a single-line JSON string as follows:

<<<<<<< HEAD
composer network deploy -o endorsementPolicy='{"endorsementPolicy": {"identities": [.... }'
=======
composer network deploy -o endorsementPolicy='{"identities": [.... }'
>>>>>>> hyperledger/master

- Using the `-o` option, the endorsement policy can be sent as a file path as follows:

composer network deploy -o endorsementPolicyFile=/path/to/file/endorsementPolicy.json

<<<<<<< HEAD
=======
In this case, the endorsement policy file should follow this format:

{"identities":[...],
"policy": {...}}

>>>>>>> hyperledger/master
- Using the `-O` option, the endorsement policy can be sent as a file path as follows:

composer network deploy -O /path/to/file/options.json

<<<<<<< HEAD
=======
In this case, the options file should follow this format:

{"endorsementPolicy": {"Identities": [...].
Expand All @@ -79,5 +70,4 @@ The `--option, -o` option and the `--optionsFile, -O` option allow connection sp
"someOtherOption": "A Value"
}

>>>>>>> hyperledger/master
For more information on writing {{site.data.conrefs.hlf_full}} endorsement policies, see the [{{site.data.conrefs.hlf_full}} node SDK documentation](https://fabric-sdk-node.github.io/global.html#Policy).
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
layout: default
title: Hyperledger Composer Network Start CLI
section: reference-command
sidebar: sidebars/accordion-toc0.md
excerpt: Composer Network Start
---

# {{site.data.conrefs.composer_full}} Network Start

---

The `composer network start` utility is used to deploy a business network archive from local disk to the {{site.data.conrefs.hlf_full}} endorsing peers.

_Please Note_: You **must** first install the {{site.data.conrefs.composer_full}} runtime to the {{site.data.conrefs.hlf_full}} endorsing peers by using the `composer runtime install` command. The business network name specified in the `composer runtime install` command must be the same as the business network name specified in the `composer network start` command.

```
composer network start -a <business-network-archive> -i <user-id> -s <user-id-secret>
```

### Options
```
composer network start [options]

Options:
--help Show help [boolean]
-v, --version Show version number [boolean]
--archiveFile, -a The business network archive file name [string] [required]
--connectionProfileName, -p The connection profile name [string]
--loglevel, -l The initial loglevel to set (INFO|WARNING|ERROR|DEBUG) [string]
--option, -o Options that are specific specific to connection. Multiple options are specified by repeating this option [string]
--optionsFile, -O A file containing options that are specific to connection [string]
--startId, -i The id of the user permitted to start a network [string] [required]
--startSecret, -s The secret of the user permitted to start a network, if required [string]
```


## {{site.data.conrefs.hlf_full}} Endorsement Policies

The `--option, -o` option and the `--optionsFile, -O` option allow connection specific information to be sent. {{site.data.conrefs.hlf_full}} endorsement policies can be sent using the `-o` and `-O` options in several ways.

- Using the `-o` option, the endorsement policy can be sent as a single-line JSON string as follows:

composer network deploy -o endorsementPolicy='{"identities": [.... }'

- Using the `-o` option, the endorsement policy can be sent as a file path as follows:

composer network deploy -o endorsementPolicyFile=/path/to/file/endorsementPolicy.json

In this case, the endorsement policy file should follow this format:

{"identities":[...],
"policy": {...}}

- Using the `-O` option, the endorsement policy can be sent as a file path as follows:

composer network deploy -O /path/to/file/options.json

In this case, the options file should follow this format:

{"endorsementPolicy": {"Identities": [...].
"policy: {...}"
},
"someOtherOption": "A Value"
}

For more information on writing {{site.data.conrefs.hlf_full}} endorsement policies, see the [{{site.data.conrefs.hlf_full}} node SDK documentation](https://fabric-sdk-node.github.io/global.html#Policy).
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
layout: default
title: Hyperledger Composer Runtime Start CLI
section: reference-command
sidebar: sidebars/accordion-toc0.md
excerpt: Composer Runtime Install
---

# {{site.data.conrefs.composer_full}} Runtime Install

---

The `composer runtime install` command is used to install the {{site.data.conrefs.composer_full}} runtime on the {{site.data.conrefs.hlf_full}} endorsing peers of the blockchain network you are connecting to. This command must be run before the `composer network start` command.

_Please Note_: The `--businessNetworkName, -n` option **must** contain the same name as the business network name you intend to run on the {{site.data.conrefs.hlf_full}} endorsing peers. Only business networks with names matching the `--businessNetworkName, -n` option given in this command will successfully run.

```
composer runtime install -n <businessNetworkName> -p <connectionProfileName> -i <installId> -s <installSecret>
```

### Options
```
composer runtime install [options]

Options:
--help Show help [boolean]
-v, --version Show version number [boolean]
--businessNetworkName, -n The business network name [string] [required]
--connectionProfileName, -p The connection profile name [string] [required]
--option, -o Options that are specific specific to connection. Multiple options are specified by repeating this option [string]
--optionsFile, -O A file containing options that are specific to connection [string]
--installId, -i The id of the user permitted to install the runtime [string] [required]
--installSecret, -s The secret of the user permitted to install the runtime, if required [string]
```
Loading