Skip to content

Commit

Permalink
First round of minor fixes; Fix rucio#1841
Browse files Browse the repository at this point in the history
  • Loading branch information
mlassnig committed Dec 4, 2018
1 parent 06e4f7e commit df06ef5
Show file tree
Hide file tree
Showing 36 changed files with 173 additions and 128 deletions.
34 changes: 11 additions & 23 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Contributor Guide
* The issue should contain the motivation, modification and expected results (discussions usually happen there).
* No pull request will be merged without an associated issue (release notes are generated from issues).
* You should make sure to add your name (and organisation) to `AUTHORS <AUTHORS.rst>`_.
* If you have questions, you can reach the core development team on our `Slack <https://rucio.slack.com/>`_ channel, or send an email to our development mailing list `[email protected] <mailto:[email protected]>`_.

A contribution can be either be a **patch**, **feature**, or **hotfix**:
* **Patches** include bugfixes and minor changes to the code and are included in patch releases usually made on a bi-weekly schedule.
Expand All @@ -18,13 +19,7 @@ Accordingly, the `repository <https://github.com/rucio/rucio/>`_ consists of th
* the **next** branch includes the development for the next major version.
* the **hotfix** branch includes the patch for hotfix releases.

Thus, on release day of a feature release both master and next are the same,
afterwards they diverge until the next feature release.
Pull requests for **features** are only made against the **next** branch.
Pull requests for **patches** are made against the **next** and **master** branch, as
these bugfixes need to be represented in both branches. Thus two
pull requests are needed for patches, and the helper scripts do it
automatically for you.
Thus, on release day of a feature release both master and next are the same, afterwards they diverge until the next feature release. Pull requests for **features** are only made against the **next** branch. Pull requests for **patches** are made against the **next** and **master** branch, as these bugfixes need to be in both branches. Thus two pull requests are needed for patches, and the helper scripts do it automatically for you. Pull requests for **hotfixes** are made against the **master**, **next**, and **hotfix** branches.

Setting up the repository
-------------------------
Expand All @@ -43,9 +38,7 @@ Contributing
------------


**Step 1**: Create an `issue <https://github.com/rucio/rucio/issues/new>`_ with the description
of the contribution (motivation, modification and expected results).
Every issue will get a **unique issue number**.
**Step 1**: Create an `issue <https://github.com/rucio/rucio/issues/new>`_ with the description of the contribution (motivation, modification and expected results). Every issue will get a **unique issue number**.

**Step 2**: Create a local branch that corresponds to the issue. There are utility scripts to help you with this::

Expand All @@ -58,8 +51,9 @@ git commit -m "<component>: <change_message> #<issue number>"

Valid component names are listed in the `label list <https://github.com/rucio/rucio/labels>`_.

If you add a `github-recognised keyword <https://help.github.com/articles/closing-issues-using-keywords/>`_ then
the associated issue can be closed automatically once the pull request is merged, e.g.::
If you use the default commit message template, make sure you edit it.

If you add a `github-recognised keyword <https://help.github.com/articles/closing-issues-using-keywords/>`_ then the associated issue can be closed automatically once the pull request is merged, e.g.::

<component>: <change_message> Fix #<issue number>

Expand All @@ -79,8 +73,7 @@ The format of the pull request title must be:

<component>: <short_change_message> #<issue number>

If you add a `github-recognised keyword <https://help.github.com/articles/closing-issues-using-keywords/>`_ then
the associated issue can be closed automatically once the pull request is merged, e.g.::
If you add a `github-recognised keyword <https://help.github.com/articles/closing-issues-using-keywords/>`_ then the associated issue can be closed automatically once the pull request is merged, e.g.::

<component>: <short_change_message> Fix #<issue number>

Expand All @@ -93,30 +86,25 @@ and for a new **feature**::

$ git pull-request -m '<short_change_message> #<issue number>' -b next

**Step 5**: Watch the pull request for comments and reviews. For any pull requests update,
please try to squash/amend your commits to avoid "in-between" commits.
**Step 5**: Watch the pull request for comments and reviews. For any pull requests update, please try to squash/amend your commits to avoid "in-between" commits.

Automatic Review
----------------

Every submitted pull request will automatically be run through automated review and
testing(nosetests) with Travis.
Every submitted pull request will automatically be run through automated review and testing with Travis.

Human Review
------------

Anyone is welcome to review merge requests and make comments!

All collaborators, thus the Rucio core development team can approve, request
changes or close pull requests. Merging of approved pull requests is done by the Rucio
development lead.
The Rucio development team can approve, request changes, or close pull requests. Merging of approved pull requests is done by the Rucio development lead.


Coding Style and testing
------------------------

We use flake8 and pylint to sanitize our code. Please do the same before
submitting a pull request.
We use flake8 and pylint to sanitize our code. Please do the same before submitting a pull request.


Git Hooks
Expand Down
4 changes: 4 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
Motivation
----------



Modification
------------


23 changes: 6 additions & 17 deletions README.client.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,18 @@
Rucio Clients
==============
Rucio - Scientific Data Management (Client Package)
===================================================

Data Management for science in the Big Data era.

Rucio is a project that provides services and associated libraries for allowing scientific
collaborations to manage large volumes of data spread across facilities at
multiple institutions and organisations. Rucio has been developed by the
`ATLAS <https://atlas.cern/>`_. experiment. It offers advanced features, is
highly scalable and modular. Rucio is a data management
solution that could cover the needs of different communities in the scientific
domain (e.g., HEP, astronomy, biology).
Rucio is a software framework that provides functionality to organize, manage, and access large volumes of scientific data using customisable policies. The data can be spread across globally distributed locations and across heterogeneous data centers, uniting different storage and network technologies as a single federated entity. Rucio offers advanced features such as distributed data recovery or adaptive replication, and is highly scalable, modular, and extensible. Rucio has been originally developed to meet the requirements of the high-energy physics experiment ATLAS, and is continuously extended to support LHC experiments and other diverse scientific communities.


Documentation
-------------

General information and latest documentation about Rucio can be found
at `readthedocs <http://rucio.readthedocs.io>`_.
General information and latest documentation about Rucio can be found at `readthedocs <https://rucio.readthedocs.io>`_ or our `webpage <https://rucio.cern.ch>`_.

Developers
----------

For information on how to contribute to Rucio, please refer and follow our
`CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.
For information on how to contribute to Rucio, please refer and follow our `CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.

Operators
----------
Expand All @@ -32,5 +22,4 @@ To learn how to deploy and configure Rucio, consult the `documentation <http://r
Getting Support
----------------

If you are looking for support, please contact our mailing list [email protected]
or join us on our slack `support <https://rucio.slack.com/messages/#support>`_ channel.
If you are looking for support, join us on our Slack `support <https://rucio.slack.com/messages/#support>`_ channel, or send an email to our public mailing list `[email protected] <mailto:[email protected]>`_.
25 changes: 7 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,34 +7,24 @@ Build Status:
:alt: Master

.. image:: https://readthedocs.org/projects/rucio/badge/?version=latest
:target: http://rucio.readthedocs.io/en/latest/
:target: https://rucio.readthedocs.io/en/latest/
:alt: Documentation

Rucio
======
Rucio - Scientific Data Management
==================================

Data Management for science in the Big Data era.

Rucio is a project that provides services and associated libraries for allowing scientific
collaborations to manage large volumes of data spread across facilities at
multiple institutions and organisations. Rucio has been developed by the
`ATLAS <https://atlas.cern/>`_. experiment. It offers advanced features, is
highly scalable and modular. Rucio is a data management
solution that could cover the needs of different communities in the scientific
domain (e.g., HEP, astronomy, biology).
Rucio is a software framework that provides functionality to organize, manage, and access large volumes of scientific data using customisable policies. The data can be spread across globally distributed locations and across heterogeneous data centers, uniting different storage and network technologies as a single federated entity. Rucio offers advanced features such as distributed data recovery or adaptive replication, and is highly scalable, modular, and extensible. Rucio has been originally developed to meet the requirements of the high-energy physics experiment ATLAS, and is continuously extended to support LHC experiments and other diverse scientific communities.


Documentation
-------------

General information and latest documentation about Rucio can be found
at `readthedocs <http://rucio.readthedocs.io>`_.
General information and latest documentation about Rucio can be found at `readthedocs <https://rucio.readthedocs.io>`_ or our `webpage <https://rucio.cern.ch>`_.

Developers
----------

For information on how to contribute to Rucio, please refer and follow our
`CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.
For information on how to contribute to Rucio, please refer and follow our `CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.

Operators
----------
Expand All @@ -44,5 +34,4 @@ To learn how to deploy and configure Rucio, consult the `documentation <http://r
Getting Support
----------------

If you are looking for support, please contact our mailing list [email protected]
or join us on our slack `support <https://rucio.slack.com/messages/#support>`_ channel.
If you are looking for support, join us on our Slack `support <https://rucio.slack.com/messages/#support>`_ channel, or send an email to our public mailing list `[email protected] <mailto:[email protected]>`_.
24 changes: 6 additions & 18 deletions README.rucio.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,18 @@
Rucio
======
Rucio - Scientific Data Management (Core Package)
=================================================

Data Management for science in the Big Data era.

Rucio is a project that provides services and associated libraries for allowing scientific
collaborations to manage large volumes of data spread across facilities at
multiple institutions and organisations. Rucio has been developed by the
`ATLAS <https://atlas.cern/>`_. experiment. It offers advanced features, is
highly scalable and modular. Rucio is a data management
solution that could cover the needs of different communities in the scientific
domain (e.g., HEP, astronomy, biology).
Rucio is a software framework that provides functionality to organize, manage, and access large volumes of scientific data using customisable policies. The data can be spread across globally distributed locations and across heterogeneous data centers, uniting different storage and network technologies as a single federated entity. Rucio offers advanced features such as distributed data recovery or adaptive replication, and is highly scalable, modular, and extensible. Rucio has been originally developed to meet the requirements of the high-energy physics experiment ATLAS, and is continuously extended to support LHC experiments and other diverse scientific communities.


Documentation
-------------

General information and latest documentation about Rucio can be found
at `readthedocs <http://rucio.readthedocs.io>`_.
General information and latest documentation about Rucio can be found at `readthedocs <https://rucio.readthedocs.io>`_ or our `webpage <https://rucio.cern.ch>`_.

Developers
----------

For information on how to contribute to Rucio, please refer and follow our
`CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.
For information on how to contribute to Rucio, please refer and follow our `CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.

Operators
----------
Expand All @@ -32,6 +22,4 @@ To learn how to deploy and configure Rucio, consult the `documentation <http://r
Getting Support
----------------

If you are looking for support, please contact our mailing list [email protected]
or join us on our slack `support <https://rucio.slack.com/messages/#support>`_ channel.

If you are looking for support, join us on our Slack `support <https://rucio.slack.com/messages/#support>`_ channel, or send an email to our public mailing list `[email protected] <mailto:[email protected]>`_.
23 changes: 6 additions & 17 deletions README.webui.rst
Original file line number Diff line number Diff line change
@@ -1,28 +1,18 @@
Rucio WebUI
===========
Rucio - Scientific Data Management (WebUI Package)
==================================================

Data Management for science in the Big Data era.

Rucio is a project that provides services and associated libraries for allowing scientific
collaborations to manage large volumes of data spread across facilities at
multiple institutions and organisations. Rucio has been developed by the
`ATLAS <https://atlas.cern/>`_. experiment. It offers advanced features, is
highly scalable and modular. Rucio is a data management
solution that could cover the needs of different communities in the scientific
domain (e.g., HEP, astronomy, biology).
Rucio is a software framework that provides functionality to organize, manage, and access large volumes of scientific data using customisable policies. The data can be spread across globally distributed locations and across heterogeneous data centers, uniting different storage and network technologies as a single federated entity. Rucio offers advanced features such as distributed data recovery or adaptive replication, and is highly scalable, modular, and extensible. Rucio has been originally developed to meet the requirements of the high-energy physics experiment ATLAS, and is continuously extended to support LHC experiments and other diverse scientific communities.


Documentation
-------------

General information and latest documentation about Rucio can be found
at `readthedocs <http://rucio.readthedocs.io>`_.
General information and latest documentation about Rucio can be found at `readthedocs <https://rucio.readthedocs.io>`_ or our `webpage <https://rucio.cern.ch>`_.

Developers
----------

For information on how to contribute to Rucio, please refer and follow our
`CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.
For information on how to contribute to Rucio, please refer and follow our `CONTRIBUTING <CONTRIBUTING.rst>`_ guidelines.

Operators
----------
Expand All @@ -32,5 +22,4 @@ To learn how to deploy and configure Rucio, consult the `documentation <http://r
Getting Support
----------------

If you are looking for support, please contact our mailing list [email protected]
or join us on our slack `support <https://rucio.slack.com/messages/#support>`_ channel.
If you are looking for support, join us on our Slack `support <https://rucio.slack.com/messages/#support>`_ channel, or send an email to our public mailing list `[email protected] <mailto:[email protected]>`_.
3 changes: 2 additions & 1 deletion bin/rucio-atropos
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# Authors:
# - Cedric Serfon, <[email protected]>, 2016
# - Vincent Garonne, <[email protected]>, 2018
#
# PY3K COMPATIBLE

'''
Expand All @@ -25,7 +26,7 @@ Atropos Daemon : End the life of the rules according to the Lifetime Model
import argparse
import signal

from rucio.daemons.atropos import run, stop
from rucio.daemons.atropos.atropos import run, stop


def get_parser():
Expand Down
2 changes: 1 addition & 1 deletion bin/rucio-automatix
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Automatix (Dataset injector) Daemon
import argparse
import signal

from rucio.tests.daemons.Automatix import run, stop
from rucio.daemons.automatix.automatix import run, stop


def get_parser():
Expand Down
28 changes: 20 additions & 8 deletions bin/rucio-conveyor-poller-latest
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
# - Wen Guan, <[email protected]>, 2015
# - Martin Barisits, <[email protected]>, 2016
# - Vincent Garonne, <[email protected]>, 2018
# - Mario Lassnig, <[email protected]>, 2018
#
# PY3K COMPATIBLE

Expand All @@ -26,6 +27,7 @@ Conveyor is a daemon to manage file transfers.

import argparse
import signal
import sys

from rucio.daemons.conveyor.poller_latest import run, stop

Expand All @@ -45,6 +47,8 @@ def get_parser():
help='Poll control: wait seconds to poll FTS server in "latest" mode')
parser.add_argument("--external-hosts", nargs='+', type=str,
help='Poll control: List of FTS hosts')
parser.add_argument("--allow", action="store_true", default=False,
help='This daemon is deprecated and will be removed. Explicitly turn it on.')
return parser


Expand All @@ -53,11 +57,19 @@ if __name__ == "__main__":
signal.signal(signal.SIGTERM, stop)
parser = get_parser()
args = parser.parse_args()
try:
run(once=args.run_once,
last_nhours=args.last_nhours,
fts_wait=args.fts_wait,
total_threads=args.total_threads,
external_hosts=args.external_hosts)
except KeyboardInterrupt:
stop()

if args.allow:

try:
run(once=args.run_once,
last_nhours=args.last_nhours,
fts_wait=args.fts_wait,
total_threads=args.total_threads,
external_hosts=args.external_hosts)
except KeyboardInterrupt:
stop()

else:

print('This daemon is deprecated and will be removed. Explicitly turn it on with --allow.')
sys.exit(1)
5 changes: 4 additions & 1 deletion bin/rucio-conveyor-transfer-submitter
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
# limitations under the License.
#
# Authors:
# - Mario Lassnig, <[email protected]>, 2013-2015
# - Mario Lassnig, <[email protected]>, 2013-2018
# - Cedric Serfon, <[email protected]>, 2013-2018
# - Wen Guan, <[email protected]>, 2014-2016
# - Vincent Garonne, <[email protected]>, 2016-2018
Expand Down Expand Up @@ -72,6 +72,9 @@ if __name__ == "__main__":
signal.signal(signal.SIGTERM, stop)
parser = get_parser()
args = parser.parse_args()

print('\n\n\n\n\nDEPRECATION WARNING: This daemon will be deprecated, switch to rucio-conveyor-submitter!\n\n\n\n\n')

try:
run(once=args.run_once,
bulk=args.bulk,
Expand Down
3 changes: 2 additions & 1 deletion bin/rucio-sonar
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
# Authors:
# - Vitjan Zavrtanik, <[email protected]>, 2017
# - Vincent Garonne, <[email protected]>, 2018
# - Mario Lassnig, <[email protected]>, 2018
#
# PY3K COMPATIBLE

Expand All @@ -25,7 +26,7 @@ Sonar is a daemon that tests inactive links.

import signal

from rucio.daemons.sonar_v3.sonar.sonar_v3_dev_daemon import run, stop
from rucio.daemons.sonar.sonar.sonar_v3_dev_daemon import run, stop

if __name__ == "__main__":
signal.signal(signal.SIGTERM, stop)
Expand Down
Loading

0 comments on commit df06ef5

Please sign in to comment.