Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

REMOVE rpm stuff and documentation #2354

Merged
merged 1 commit into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,12 +74,11 @@ Fiware/Cygnus has four sub-modules [cygnus-common](cygnus-common#welcome-to-cygn
Following are the links of install section of Fiware/Cygnus sub-modules:
* cygnus-common:
- [Install from sources](doc/cygnus-common/installation_and_administration_guide/install_from_sources.md)
- [Install with docker](doc/cygnus-common/installation_and_administration_guide/install_with_docker.md)
- [Install with rpm](doc/cygnus-common/installation_and_administration_guide/install_with_rpm.md)
- [Install with docker](doc/cygnus-common/installation_and_administration_guide/install_with_docker.md)
* cygnus-ngsi:
- [Install from sources](doc/cygnus-ngsi/installation_and_administration_guide/install_from_sources.md)
- [Install with docker](doc/cygnus-ngsi/installation_and_administration_guide/install_with_docker.md)
- [Install with rpm](doc/cygnus-ngsi/installation_and_administration_guide/install_with_rpm.md)

* cygnus-twitter:
- [Install from sources](doc/cygnus-twitter/installation_and_administration_guide/install_from_sources.md)
- [Install with docker](doc/cygnus-twitter/installation_and_administration_guide/install_with_docker.md)
Expand Down
2 changes: 1 addition & 1 deletion cygnus-ngsi-ld/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ $ curl -X GET "http://localhost:8081/v1/stats" | python -m json.tool
## <a name="section3"></a>Advanced topics and further reading
Detailed information regarding cygus-ngsi can be found in the [Installation and Administration Guide](../doc/cygnus-ngsi-ld/installation_and_administration_guide/introduction.md), the [User and Programmer Guide](../doc/cygnus-ngsi-ld/user_and_programmer_guide/introduction.md) and the [Flume extensions catalogue](../doc/cygnus-ngsi-ld/flume_extensions_catalogue/introduction.md). The following is just a list of shortcuts regarding the most popular topics:

* [Installation with docker](../doc/cygnus-ngsi-ld/installation_and_administration_guide/install_with_docker.md). An alternative to RPM installation, docker is one of the main options when installing FIWARE components.
* [Installation with docker](../doc/cygnus-ngsi-ld/installation_and_administration_guide/install_with_docker.md). The preffered installation way, docker is one of the main options when installing FIWARE components.
* [Installation from sources](../doc/cygnus-ngsi-ld/installation_and_administration_guide/install_from_sources.md). Sometimes you will need to install from sources, particularly when some of the dependencies must be modified.

[Top](#top)
Expand Down
2 changes: 1 addition & 1 deletion cygnus-ngsi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Many other operations, like getting/setting the log level, can be found in Manag
## <a name="section3"></a>Advanced topics and further reading
Detailed information regarding cygus-ngsi can be found in the [Installation and Administration Guide](../doc/cygnus-ngsi/installation_and_administration_guide/introduction.md), the [User and Programmer Guide](../doc/cygnus-ngsi/user_and_programmer_guide/introduction.md) and the [Flume extensions catalogue](../doc/cygnus-ngsi/flume_extensions_catalogue/introduction.md). The following is just a list of shortcuts regarding the most popular topics:

* [Installation with docker](../doc/cygnus-ngsi/installation_and_administration_guide/install_with_docker). An alternative to RPM installation, docker is one of the main options when installing FIWARE components.
* [Installation with docker](../doc/cygnus-ngsi/installation_and_administration_guide/install_with_docker). Thre preferred installation method, docker is one of the main options when installing FIWARE components.
* [Installation from sources](../doc/cygnus-ngsi/installation_and_administration_guide/install_from_sources.md). Sometimes you will need to install from sources, particularly when some of the dependencies must be modified, e.g. the `hadoop-core` libraries.
* [Running as a process](../doc/cygnus-ngsi/installation_and_administration_guide/running_as_process.md). Running cygus-ngsi as a process is very useful for testing and debugging purposes.
* [Management Interface](../doc/cygnus-ngsi/installation_and_administration_guide/management_interface.md). REST-based management interface for administration purposes.
Expand Down
15 changes: 1 addition & 14 deletions doc/contributing/contributing_guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ Content:
* [Commits and squashing](#section3.8)
* [Releasing](#section3.9)
* [Deployers](#section4)
* [RPMs](#section4.1)
* [Dockers](#section4.2)
* [Documentation](#section5)
* [Repository documentation](#section5.1)
Expand Down Expand Up @@ -120,7 +119,6 @@ Each folder MUST have, at least, the following subdirectories and files:
* `docker/` → everything about deploying Cygnus by means of Docker
* `test/` → acceptance tests, e2e tests, performance tests, others
* `conf/` → templates for configuration files required to run the agent
* `spec/` → spec file for generating a RPM
* `pom.xml` → Maven’s Project Object Model

A folder with common content named `cygnus-common` MUST exist. It will be a Maven project in charge of building a Cygnus common library that SHOULD be used by all the agents, enforcing the reusability of code.
Expand Down Expand Up @@ -254,17 +252,6 @@ Releases MUST be published in the <i>releases</i> section of the main repository
As a result of the release, `CHANGES_NEXT_RELEASE` file MUST be emptied in Github repo.

## <a name="section4"></a>Deployers
### <a name="section4.1"></a>RPMs
There MUST exist a `rpm/` folder at the root of the main repository. A packaging script MUST generate a RPM based on the spec file of each Cygnus agent, including `cygnus-common`. Such a spec file MUST live at the `spec` subfolder within the agent folder.

Upon releasing, these RPMs MUST be created and uploaded to some repository in order they are available. As an example, `cygnus-ngsi` agent's RPM is uploaded to `http://repositories.testbed.fiware.org`.

Agents' RPMs MUST depend on `cygnus-common` RPM, which MUST be in charge of installing not only the common classes to all the agents, but installing Apache Flume, default configuration templates and provisioning the Cygnus plugin. `cygnus-common` RPM is typically uploaded to `http://repositories.testbed.fiware.org` as well.

All RPMs spec files (spec for `cygnus-common` and any other agent) MUST contain a copy of the content of `CHANGES_NEXT_RELEASE` file.

[Top](#top)

### <a name="section4.2"></a>Dockers
There MUST exist a `docker/` folder at the root of the main repository. Every Cygnus agent MUST include a docker subfolder as per the following rules:

Expand Down Expand Up @@ -391,6 +378,6 @@ In addition, a table MUST be included in charge of defining a set of alarm condi
## <a name="section7"></a>Configuration
When adding a new agent to Cygnus, it MUST include an agent configuration template in [Flume format](https://flume.apache.org/FlumeUserGuide.html#setup). Other configuration files MAY be added as well.

The specific agent configuration template MUST replace the one handled by `cygnus-common` in the Flume deployment donde by `cygnus-common` RPM.
The specific agent configuration template MUST replace the one handled by `cygnus-common` in the Flume deployment done by `cygnus-common`.

[Top](#top)
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
* [log4j configuration](./log4j_conf.md)
* Running:
* [Running as a process](./running_as_process.md)
* [Running as a service](./running_as_service.md)
* [YAFS](./yafs.md)
* [Testing](./testing.md)
* [Logs and alarm](./logs_and_alarms.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Maven is installed by downloading it from [maven.apache.org](http://maven.apache
[Top](#top)

## <a name="section2"></a>`cygnus` user creation
It is highly recommended to create a `cygnus` Unix user, under which Cygnus will be installed and run. By the way, this is how the [RPM](./install_with_rpm.md) proceeds.
It is highly recommended to create a `cygnus` Unix user, under which Cygnus will be installed and run.

Creating such a user is quite simple. As a sudoer user (root or any other allowed), type the following:

Expand Down

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Nevertheless, using YAFS has side effects, specially when a thread dies as part

Of special interest is the case involving a configuration change on the fly. Flume is designed for that purpose, nevertheless using YAFS produce very weird results in conjunction with on the fly configuration changes. This is because reloading a configuration in Flume implies to stop previous running components, i.e. thread stops that YAFS detects and result in a complete Cygnus stop.

In order to avoid scenarios as the ones described above, YAFS can be disabled when configuring the agent, by simply using the `--no-yafs` option. Please check the sections about running a Cygnus agent as a [process](./runninh_as_process.md) or as a [service](./running_as_service.md) for further details.
In order to avoid scenarios as the ones described above, YAFS can be disabled when configuring the agent, by simply using the `--no-yafs` option. Please check the sections about running a Cygnus agent as a [process](./runninh_as_process.md) for further details.

**NOTE**: Please observe Flume 1.4.0 shows a problem when changing the configuration on the fly, as described in [FLUME-2310](https://issues.apache.org/jira/browse/FLUME-2310). Basically, new components cannot register for JMX monitoring because old ones are not properly deregistered. This problem is inherited by Cygnus since it extends Flume. In any case, it is a minor issue not affecting Flume nor Cygnus functionalityu (except for proper JMX monitoring, of course). You will see this error in Cygnus in traces like this one:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
* log4j configuration (FIXME: we don't have yet and specific configuration for log4j but it will be done in the future)
* Running:
* [Running as a process](./running_as_process.md)
* [Running as a service](./running_as_service.md)
* Advanced topics:
* [Testing](./testing.md)
* [Sanity checks](./sanity_checks.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Apart from this introduction, this Installation and Administration Guide mainly
* [Configuration examples](./configuration_examples.md)
* Running:
* [Running as a process](./running_as_process.md)
* [Running as a service](./running_as_service.md)

* Advanced topics:
* [Testing](./testing.md)
* [Sanity checks](./sanity_checks.md)
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

* [Introduction](./introduction.md)
* Installation:
* [Installation via RPM](./install_with_rpm.md)
* [Installation via docker](./install_with_docker.md)
* [Installation from sources](./install_from_sources.md)
* Configuration:
Expand All @@ -11,7 +10,6 @@
* [Configuration examples](./configuration_examples.md)
* Running:
* [Running as a process](./running_as_process.md)
* [Running as a service](./running_as_service.md)
* Advanced topics:
* [Testing](./testing.md)
* [Backends as short-term historics](./backends_as_sth.md)
Expand Down

This file was deleted.

This file was deleted.

2 changes: 1 addition & 1 deletion doc/cygnus-ngsi/integration/orion_cygnus_spark.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Please refere to Orion Context Broker [official documentation](http://fiware-ori
[Top](#top)

## <a name="section3"></a>Setting up Cygnus
Regarding installation, do it from [FIWARE yum repository](https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-ngsi/installation_and_administration_guide/install_with_rpm.md). Once installed in its latest version, a Cygnus agent must be configured as follows:
Regarding installation, do it [using Dockerhub](https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-ngsi/installation_and_administration_guide/install_with_docker.md). Once installed in its latest version, a Cygnus agent must be configured as follows:

```
$ cat /usr/cygnus/conf/agent_spark.conf
Expand Down
5 changes: 1 addition & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,7 @@ pages:
- 'cygnus-common library':
- 'Installation and Administration Guide':
- 'Introduction': 'cygnus-common/installation_and_administration_guide/introduction.md'
- 'Hardware requirements': 'cygnus-common/installation_and_administration_guide/hw_requirements.md'
- 'Installation via RPM': 'cygnus-common/installation_and_administration_guide/install_with_rpm.md'
- 'Hardware requirements': 'cygnus-common/installation_and_administration_guide/hw_requirements.md'
- 'Installation from sources': 'cygnus-common/installation_and_administration_guide/install_from_sources.md'
- 'Installation via docker': 'cygnus-common/installation_and_administration_guide/install_with_docker.md'
- 'Cygnus agent configuration': 'cygnus-common/installation_and_administration_guide/cygnus_agent_conf.md'
Expand Down Expand Up @@ -50,12 +49,10 @@ pages:
- 'Quick Start Guide': 'cygnus-ngsi/quick_start_guide.md'
- 'Installation and Administration Guide':
- 'Introduction': 'cygnus-ngsi/installation_and_administration_guide/introduction.md'
- 'Installation via RPM': 'cygnus-ngsi/installation_and_administration_guide/install_with_rpm.md'
- 'Installation via docker': 'cygnus-ngsi/installation_and_administration_guide/install_with_docker.md'
- 'Installation from sources': 'cygnus-ngsi/installation_and_administration_guide/install_from_sources.md'
- 'NGSI agent configuration': 'cygnus-ngsi/installation_and_administration_guide/ngsi_agent_conf.md'
- 'Configuration examples': 'cygnus-ngsi/installation_and_administration_guide/configuration_examples.md'
- 'Running as a service': 'cygnus-ngsi/installation_and_administration_guide/running_as_service.md'
- 'Testing': 'cygnus-ngsi/installation_and_administration_guide/testing.md'
- 'Backends as short-term historics': 'cygnus-ngsi/installation_and_administration_guide/backends_as_sth.md'
- 'Name mappings': 'cygnus-ngsi/installation_and_administration_guide/name_mappings.md'
Expand Down
Loading
Loading