Skip to content

Commit 1966de0

Browse files
authored
Merge pull request hyperledger-cello#731 from dodo920306/task/provide-first-4-lessons-of-the-tutorial
Elaborate docs and create the first 7 lessons of the tutorials
2 parents d9ffb9a + a176aaf commit 1966de0

18 files changed

Lines changed: 798 additions & 43 deletions

Makefile

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,9 @@ deep-clean: ##@Clean Stop services, clean docker images and remove mounted local
145145
make clean-images
146146
rm -rf $(LOCAL_STORAGE_PATH)
147147

148+
docs:
149+
make doc
150+
148151
doc: ##@Documentation Build local online documentation and start serve
149152
command -v mkdocs >/dev/null 2>&1 || pip install -r docs/requirements.txt || pip3 -r docs/requirements.txt
150153
mkdocs serve -f mkdocs.yml
@@ -216,7 +219,7 @@ images: api-engine docker-rest-agent fabric dashboard
216219

217220
api-engine:
218221
docker build -t hyperledger/cello-api-engine:latest -f build_image/docker/common/api-engine/Dockerfile.in ./ --platform linux/$(ARCH)
219-
222+
220223
docker-rest-agent:
221224
docker build -t hyperledger/cello-agent-docker:latest -f build_image/docker/agent/docker-rest-agent/Dockerfile.in ./ --build-arg pip=$(PIP) --platform linux/$(ARCH)
222225

@@ -226,15 +229,19 @@ fabric:
226229
dashboard:
227230
docker build -t hyperledger/cello-dashboard:latest -f build_image/docker/common/dashboard/Dockerfile.in ./
228231

232+
server:
233+
docker compose -f bootup/docker-compose-files/docker-compose.server.dev.yml up -d --force-recreate --remove-orphans
229234

230-
235+
agent:
236+
docker compose -f bootup/docker-compose-files/docker-compose.agent.dev.yml up -d --force-recreate --remove-orphans
231237

232238
.PHONY: \
233239
all \
234240
license \
235241
check \
236242
check-api \
237243
check-dashboard \
244+
docs \
238245
doc \
239246
help \
240247
docker \
@@ -253,4 +260,6 @@ dashboard:
253260
clean-images \
254261
start-docker-compose \
255262
stop-docker-compose \
256-
images \
263+
images \
264+
server \
265+
agent

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Cello](docs/images/favicon.png)
1+
![Cello](docs/images/logo.svg)
22

33
[![Release](https://img.shields.io/github/v/release/hyperledger-cello/cello)](https://github.com/hyperledger-cello/cello/releases)
44
[![Build Status](https://github.com/hyperledger/cello/actions/workflows/docker-image.yml/badge.svg)](https://github.com/hyperledger/cello/actions/workflows/docker-image.yml)
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
#
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
5+
services:
6+
cello-docker-agent:
7+
image: hyperledger/cello-agent-docker
8+
container_name: cello-docker-agent
9+
hostname: cello.docker.agent
10+
restart: always
11+
ports:
12+
- "2375:2375"
13+
- "5001:5001"
14+
volumes:
15+
- /var/run/docker.sock:/var/run/docker.sock
16+
environment:
17+
- DOCKER_URL=unix://var/run/docker.sock
18+
- STORAGE_PATH=${CELLO_STORAGE_PATH:-/opt/cello}/hyperledger
19+
networks:
20+
- cello-net
21+
22+
networks:
23+
cello-net:
24+
name: cello-net
25+
26+
volumes:
27+
cello-docker-agent:
Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
#
2+
# SPDX-License-Identifier: Apache-2.0
3+
#
4+
5+
services:
6+
cello-dashboard:
7+
image: hyperledger/cello-dashboard
8+
container_name: cello-dashboard
9+
ports:
10+
- "${DASHBOARD_SERVICE_PORT}:8081"
11+
networks:
12+
- cello-net
13+
depends_on:
14+
- cello-api-engine
15+
16+
# pg database
17+
cello-postgres:
18+
image: postgres:12.0
19+
container_name: cello-postgres
20+
restart: unless-stopped
21+
environment:
22+
- POSTGRES_DB=api_engine
23+
- POSTGRES_USER=postgres
24+
- POSTGRES_PASSWORD=123456
25+
ports:
26+
- "5432:5432"
27+
volumes:
28+
- ${CELLO_STORAGE_PATH:-/opt/cello}/pgdata:/var/lib/postgresql/data
29+
networks:
30+
- cello-net
31+
32+
# api engine service of cello
33+
cello-api-engine:
34+
image: hyperledger/cello-api-engine
35+
container_name: cello-api-engine
36+
restart: unless-stopped
37+
stdin_open: true
38+
dns_search: .
39+
environment:
40+
- GODEBUG=netdns=go
41+
- DB_NAME=api_engine
42+
- DB_USER=postgres
43+
- DB_PASSWORD=123456
44+
- DB_HOST=cello-postgres
45+
- CELERY_BROKER_URL=redis://redis
46+
- DB_PORT=5432
47+
- DEBUG=True
48+
- CORE_VM_ENDPOINT=unix:///host/var/run/docker.sock
49+
- FABRIC_LOGGING_SPEC=INFO
50+
- API_ENGINE_ADMIN_EMAIL=admin@cello.com
51+
ports:
52+
- "8080:8080"
53+
volumes:
54+
- ${CELLO_STORAGE_PATH:-/opt/cello}:/opt/cello
55+
networks:
56+
- cello-net
57+
depends_on:
58+
- cello-postgres
59+
60+
networks:
61+
cello-net:
62+
name: cello-net
63+
64+
volumes:
65+
cello-api-engine:
66+
cello-postgres:
67+
cello-dashboard:

docs/concepts.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
16
hero: All concepts related to cello
27

38
# Concepts

docs/contributing.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
16
[//]: # (SPDX-License-Identifier: CC-BY-4.0)
27

38
## Introduction

docs/design/arch.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
---
5+
16
# Architecture Design
27

38
Here we discuss the architecture design for the mangement services on the Master node.

docs/faq.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
## Questions
22

3-
* [What is cello?](#what-is-cello)
4-
53
### What is cello?
64

75
Hyperledger Cello is a blockchain provision and operation system, which helps manage blockchain networks in an efficient way.

0 commit comments

Comments
 (0)