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

Commit

Permalink
Merge pull request #73 from CogStack/examples-update
Browse files Browse the repository at this point in the history
Updating the examples
  • Loading branch information
lrog authored Nov 29, 2018
2 parents 1440bfc + 9ab1f4d commit 7be57b0
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 33 deletions.
2 changes: 1 addition & 1 deletion dockerfiles/gate/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM cogstacksystems/cogstack-pipeline:dev-latest
FROM cogstacksystems/cogstack-pipeline:latest

RUN apt-get update && \
apt-get install -y curl && \
Expand Down
27 changes: 5 additions & 22 deletions docs/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,23 +39,16 @@ Some parts of this document are also used in [CogStack Quickstart](https://githu
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:

```bash
git clone -b dev --single-branch https://github.com/CogStack/CogStack-Pipeline.git
git clone https://github.com/CogStack/CogStack-Pipeline.git
```
or by downloading it from the repository and decompressing it:
```bash
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/dev.zip'
unzip dev.zip
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/master.zip'
unzip master.zip
```
The content will be decompressed into `CogStack-Pipeline/` directory.


[//]: # "<span style='color:red'> NOTE: </span>"
**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.**

[//]: # "<span style='color:red'> NOTE: </span>"
**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.**



# <a name="how-they-are-organized"></a> How are the examples organized
[//]: # "-------------------------------------------------------------------------------------"
Expand Down Expand Up @@ -1331,10 +1324,6 @@ For a detailed list of features, please refer to the official [ElasticSearch X-P
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.


[//]: # "<span style='color:red'> NOTE: </span>"
**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.**



## Deployment information

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

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.

[//]: # "<span style='color:red'> NOTE: </span>"
**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.**



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

## Deployment information

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

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.

[//]: # "<span style='color:red'> NOTE: </span>"
**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.**
10 changes: 3 additions & 7 deletions docs/quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,16 @@ The main directory with resources used in this tutorial is available in the CogS
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:

```bash
git clone -b dev --single-branch https://github.com/CogStack/CogStack-Pipeline.git
git clone https://github.com/CogStack/CogStack-Pipeline.git
```
or by downloading it from the repository and decompressing it:
```bash
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/dev.zip'
unzip dev.zip
wget 'https://github.com/CogStack/CogStack-Pipeline/archive/master.zip'
unzip master.zip
```
The content will be decompressed into `CogStack-Pipeline/` directory.


[//]: # "<span style='color:red'> NOTE: </span>"
**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.**



# <a name="how-does-it-work"></a> How does CogStack work
[//]: # "-------------------------------------------------------------------------------------"
Expand Down
2 changes: 1 addition & 1 deletion examples/docker-common/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ services:
# CogStack-Pipeline related containers #
#---------------------------------------------------------------------------#
cogstack-pipeline:
image: cogstacksystems/cogstack-pipeline:dev-latest
image: cogstacksystems/cogstack-pipeline:latest
environment:
- SERVICES_USED=cogstack-job-repo:5432,samples-db:5432,elasticsearch-1:9200
- LOG_LEVEL=info
Expand Down
2 changes: 1 addition & 1 deletion examples/example8/docker/docker-compose.override.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ services:
# CogStack containers #
#---------------------------------------------------------------------------#
cogstack-pipeline:
image: cogstacksystems/cogstack-pipeline-gate:dev-latest
image: cogstacksystems/cogstack-pipeline-gate:latest
volumes:
- ./gate/app:/gate/app

Expand Down
2 changes: 1 addition & 1 deletion examples/example9/docker/docker-compose.override.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ services:
# CogStack containers #
#---------------------------------------------------------------------------#
cogstack-pipeline:
image: cogstacksystems/cogstack-pipeline-gate:dev-latest
image: cogstacksystems/cogstack-pipeline-gate:latest
volumes:
- ./gate/app:/gate/app

Expand Down

0 comments on commit 7be57b0

Please sign in to comment.