Skip to content

Commit

Permalink
Merge pull request #36 from interTwin-eu/dev-esparig
Browse files Browse the repository at this point in the history
Updated READMEs and small documentation fixes
  • Loading branch information
esparig authored Nov 7, 2024
2 parents 93877ed + 562da01 commit 5ac9d1d
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 73 deletions.
62 changes: 0 additions & 62 deletions .github/workflows/dev.yml

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Apache NiFi can be automatically deployed using the [Infrastructure Manager (IM)
## Achievements

<a href="https://eu.badgr.com/public/assertions/0vLlQBANQzyHMOrmcsck3w?identity__url=https:%2F%2Fgithub.com%2FEOSC-synergy%2Foscar.assess.sqaaas%2Fcommit%2F10254d15a9230f45c84dae22f3711653162faf78">
<img src="docpage/docs/images/badge_software_silver.png" alt="Silver Badge" width="150"></a>
<img src="docpage/docs/images/badge_software_silver.png" alt="Silver Badge" width="250"></a>

This software has received a silver badge according to the [Software Quality Baseline criteria](https://www.eosc-synergy.eu/for-developers/) defined by the [EOSC-Synergy](https://www.eosc-synergy.eu) project.

Expand Down
13 changes: 7 additions & 6 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# New Image of Nifi
# Regarding the Docker image

It had created a Docker image called `ghcr.io/grycap/nifi-sse:latest` from apache/nifi version 1.20.0.
Also, it created two folders /ssefiles and /state.
A Docker image called `ghcr.io/grycap/nifi-sse:latest` has been created from Apache NiFi version 1.20.0.

1. The /ssefiles folder has introduced the files necessary to execute the [sse protocol](https://github.com/paulmillar/dcache-sse) defined in the paulmillar GitHub repository.
2. The other folder /state will be a persistent folder that will save all the events and the state.
The image contains two folders called *ssefiles* and *state*.

Finally, all the dependencies necessary to execute the sse protocol have been added.
1. The *ssefiles* folder contains the necessary files to execute the [dCache SSE protocol](https://github.com/paulmillar/dcache-sse) as defined in the paulmillar GitHub repository.
2. The *state* folder purpose is to be employed as a persistent storage for the events and the state.

The image also contains preinstalled the required dependencies to execute the SSE protocol.
8 changes: 4 additions & 4 deletions docpage/docs/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 1
DCNiOS is an open-source command-line tool that easily manages the creation of event-driven data processing flows. DCNiOS reads a file with a workflow defined in a YAML structure. Then, DCNiOS creates this workflow in an Apache NiFi cluster. DCNiOS uses transparently the Apache NiFi [ProcessGroups](https://nifi.apache.org/docs/nifi-docs/html/user-guide.html#Configuring_a_ProcessGroup) to create predefined workflows.


![DCNiOS images](/../static/img/dcnios-logo-hor.png)
![DCNiOS images](../static/img/dcnios-logo-hor.png)

Apache NiFi ProcessGroup is a group of Processors that compose a dataflow. DCNiOS uses predefined ProcessGroups that make simple actions like interacting with third-party elements (e.g., consuming from Kafka) or changing the data content (e.g.encoding the data in base64) to compose a complete dataflow.

Expand All @@ -23,12 +23,12 @@ In DCNiOS documentation, the ProcessGroups are split by purpose into three main
## Prerequisites

- OSCAR cluster containing the user-defined OSCAR Services. You can see some [examples](https://github.com/grycap/oscar/tree/master/examples) in GitHub.
- Apache Nifi cluster deployed.
- Apache NiFi cluster deployed.
- A Python distribution such as [Anaconda](https://www.anaconda.com/) or Python version 3.7.6
- An input source (one of these is enough: dCache, Kafka, S3 AWS, SQS AWS)
- An input source (e.g.: dCache, Kafka, S3 AWS, SQS AWS)


[IM](https://www.grycap.upv.es/im/index.php) can deploy a Kubernetes cluster that includes OSCAR and Apache NiFi.
[IM](https://www.grycap.upv.es/im/index.php) can deploy a Kubernetes cluster that includes an OSCAR cluster and Apache NiFi.


## Installation
Expand Down

0 comments on commit 5ac9d1d

Please sign in to comment.