Skip to content
This repository was archived by the owner on Jan 13, 2023. It is now read-only.

Commit 7be57b0

Browse files
authored
Merge pull request #73 from CogStack/examples-update
Updating the examples
2 parents 1440bfc + 9ab1f4d commit 7be57b0

File tree

6 files changed

+12
-33
lines changed

6 files changed

+12
-33
lines changed

dockerfiles/gate/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM cogstacksystems/cogstack-pipeline:dev-latest
1+
FROM cogstacksystems/cogstack-pipeline:latest
22

33
RUN apt-get update && \
44
apt-get install -y curl && \

docs/examples/index.md

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -39,23 +39,16 @@ Some parts of this document are also used in [CogStack Quickstart](https://githu
3939
The most convenient way to get CogStack bundle is to download it directly from the [official github repository](https://github.com/CogStack/CogStack-Pipeline) either by cloning it using git:
4040

4141
```bash
42-
git clone -b dev --single-branch https://github.com/CogStack/CogStack-Pipeline.git
42+
git clone https://github.com/CogStack/CogStack-Pipeline.git
4343
```
4444
or by downloading it from the repository and decompressing it:
4545
```bash
46-
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/dev.zip'
47-
unzip dev.zip
46+
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/master.zip'
47+
unzip master.zip
4848
```
4949
The content will be decompressed into `CogStack-Pipeline/` directory.
5050

5151

52-
[//]: # "<span style='color:red'> NOTE: </span>"
53-
**Note: For the moment the CogStack bundle is obtained from the `dev` branch -- soon it will be merged into `master` branch with a version tag for a direct download.**
54-
55-
[//]: # "<span style='color:red'> NOTE: </span>"
56-
**Note: For the moment, the CogStack pipeline Docker image used in this example is `cogstacksystems/cogstack-pipeline:dev-latest` However, once the development branch will be merged to `master` the image names will be updated.**
57-
58-
5952

6053
# <a name="how-they-are-organized"></a> How are the examples organized
6154
[//]: # "-------------------------------------------------------------------------------------"
@@ -1331,10 +1324,6 @@ For a detailed list of features, please refer to the official [ElasticSearch X-P
13311324
This example is an extension of [Example 6](#example-6) providing logging mechanism using [Fluentd](https://www.fluentd.org/) log collector and it only focuses on the logging part.
13321325

13331326

1334-
[//]: # "<span style='color:red'> NOTE: </span>"
1335-
**Note: For the moment, the Docker images used in this example are: `cogstacksystems/cogstack-pipeline:dev-latest` and `cogstacksystems/fluentd:dev-latest`. These images are build from the `dev` branch. However, once the development branch will be merged to `master` the image names will be updated.**
1336-
1337-
13381327

13391328
## Deployment information
13401329

@@ -1347,7 +1336,7 @@ This example uses the stack of microservices used in [Example 6](#example-6), bu
13471336
Regarding Docker Compose configuration file, for each microservice used an additional section has been added regarding logging -- e.g., in case of CogStack pipeline:
13481337
```yml
13491338
cogstack:
1350-
image: cogstacksystems/cogstack-pipeline:dev-latest
1339+
image: cogstacksystems/cogstack-pipeline:latest
13511340
13521341
...
13531342
@@ -1460,9 +1449,6 @@ When running `setup.sh` script, a number of separate directories will be created
14601449

14611450
Apart from that, this example uses the standard stack of microservices (see: [CogStack ecosystem](#cogstack-ecosystem)) and also uses a single CogStack *properties* file, running only one instance of CogStack data processing engine.
14621451

1463-
[//]: # "<span style='color:red'> NOTE: </span>"
1464-
**Note: For the moment, the CogStack Docker image used in this example is `cogstacksystems/cogstack-pipeline-gate:dev-latest`. This image are build from the `dev` branch. However, once the development branch will be merged to `master` the image name will be updated.**
1465-
14661452

14671453

14681454
# <a name="example-9"></a> Example 9
@@ -1506,9 +1492,6 @@ Tika item processor will extract the text from the document initially stored in
15061492

15071493
## Deployment information
15081494

1509-
When running `setup.sh` script, a number of separate directories will be created. Since NLP components for pipelines require additional applications to be installed in the system, CogStack provides another, extended image containing them. In this example, hence `cogstacksystems/cogstack-pipeline-gate:dev-latest` image is being used.
1495+
When running `setup.sh` script, a number of separate directories will be created. Since NLP components for pipelines require additional applications to be installed in the system, CogStack provides another, extended image containing them. In this example, hence `cogstacksystems/cogstack-pipeline-gate:latest` image is being used.
15101496

15111497
Apart from that, this example uses the standard stack of microservices (see: [CogStack ecosystem](#cogstack-ecosystem)) and also uses a single CogStack *properties* file, running only one instance of CogStack data processing engine.
1512-
1513-
[//]: # "<span style='color:red'> NOTE: </span>"
1514-
**Note: For the moment, the CogStack Docker image used in this example is `cogstacksystems/cogstack-pipeline-gate:dev-latest`. This image are build from the `dev` branch. However, once the development branch will be merged to `master` the image name will be updated.**

docs/quickstart/index.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,20 +31,16 @@ The main directory with resources used in this tutorial is available in the CogS
3131
The most convenient way to get CogStack bundle is to download it directly from the [official github repository](https://github.com/CogStack/CogStack-Pipeline) either by cloning it using git:
3232

3333
```bash
34-
git clone -b dev --single-branch https://github.com/CogStack/CogStack-Pipeline.git
34+
git clone https://github.com/CogStack/CogStack-Pipeline.git
3535
```
3636
or by downloading it from the repository and decompressing it:
3737
```bash
38-
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/dev.zip'
39-
unzip dev.zip
38+
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/master.zip'
39+
unzip master.zip
4040
```
4141
The content will be decompressed into `CogStack-Pipeline/` directory.
4242

4343

44-
[//]: # "<span style='color:red'> NOTE: </span>"
45-
**Note: For the moment the CogStack bundle is obtained from the `dev` branch -- soon it will be merged into `master` branch with a version tag for a direct download.**
46-
47-
4844

4945
# <a name="how-does-it-work"></a> How does CogStack work
5046
[//]: # "-------------------------------------------------------------------------------------"

examples/docker-common/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ services:
2626
# CogStack-Pipeline related containers #
2727
#---------------------------------------------------------------------------#
2828
cogstack-pipeline:
29-
image: cogstacksystems/cogstack-pipeline:dev-latest
29+
image: cogstacksystems/cogstack-pipeline:latest
3030
environment:
3131
- SERVICES_USED=cogstack-job-repo:5432,samples-db:5432,elasticsearch-1:9200
3232
- LOG_LEVEL=info

examples/example8/docker/docker-compose.override.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ services:
1717
# CogStack containers #
1818
#---------------------------------------------------------------------------#
1919
cogstack-pipeline:
20-
image: cogstacksystems/cogstack-pipeline-gate:dev-latest
20+
image: cogstacksystems/cogstack-pipeline-gate:latest
2121
volumes:
2222
- ./gate/app:/gate/app
2323

examples/example9/docker/docker-compose.override.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ services:
1717
# CogStack containers #
1818
#---------------------------------------------------------------------------#
1919
cogstack-pipeline:
20-
image: cogstacksystems/cogstack-pipeline-gate:dev-latest
20+
image: cogstacksystems/cogstack-pipeline-gate:latest
2121
volumes:
2222
- ./gate/app:/gate/app
2323

0 commit comments

Comments
 (0)