Commit Graph

14 Commits

Author SHA1 Message Date
Jeremy Stanley aa21a0c61b Overhaul package metadata and contributor info
Modernize our package metadata in the following ways:

* switch from description-file to long_description with the file
  attribute, and specify an explicit content type and encoding

* replace the home-page parameter with the newer general url one

* use the specific license metadata in addition to the corresponding
  trove classifier for it

* make sure wheels when built also incorporate the LICENSE and
  AUTHORS files so that we're not distributing them without a copy
  of the license text

* indicate support for all recent Python releases in trove
  classifiers

* drop Python 3.4 cruft from the bindep list

https://setuptools.readthedocs.io/en/latest/userguide/declarative_config.html

Also replace the contributor documentation with a more up to date
copy from opendev/bindep, and adjust the copyright assertions in the
built Sphinx docs to refer to "OpenDev Contributors" and drop the
unnecessary year.

Change-Id: I39c5f5afc66edec0cf51709218f143b2a749eddd
2021-07-10 16:45:05 +00:00
liyou01 370be17fc5 remove unicode from code
Change-Id: If93af8c01cbbaad4e64dc78fb651815a4de6e741
2021-01-07 15:03:18 +08:00
Mohammed Naser a4449758bf Fix documentation builds
This patch does a few things to fix the documentation builds for
this project

- Move requirements to doc/requirements.txt for building docs to
  avoid installing extra dependencies.
- Bump sphinx version to a newer release which is compatible with
  sphinxcontrib-programoutput
- Remove default theme option to use the latest Sphinx theme that
  is shipped directly from upstream.
- Bumped basepython for documentation jobs to Python 3.

These are all squashed because the job is currently broken.

Change-Id: Ib998923a5daaa5e9d3ddc748b76b6304e5c39b22
2019-10-14 12:47:52 -04:00
Jenkins 026fe3bf36 Merge "Generate a geard.8 manpage for Debian packaging" 2014-10-12 17:09:51 +00:00
Antoine Musso fb5018382f Generate a geard.8 manpage for Debian packaging
I have created a Debian package for gear and the Debian policy requires
daemon to ship with a manpage.

This patch:
* extracts out geard program output out of index.rst to a new geard.rst
  including it at the original place for convenience.
* configure sphinx to generate a geard.8 manpage from geard.rst
* geard.rst remains unlinked in the HTML documentation since it is
  included in index.rst.

Minor issue:
* I haven't found how to add cross references between the two manpages
  without interfering with the HTML documentation output.

Change-Id: I2576cfa4acb0b91d789dc1ce42299ae91c6f9422
2014-05-16 21:36:08 +02:00
Khai Do 3d2902451c document how to configure gearman logging
Change-Id: Ic6623c23dbb7e970d1fa24115c45ee427e07bdaa
2014-05-16 08:31:52 -07:00
Khai Do 5bdcfef2af doc update: move the server usage info
Created a server example section and moved the the server usage info there.

Change-Id: I43457cc36c54a7dc5dab3083d1d858e5c5c88fba
2014-05-16 08:01:13 -07:00
James E. Blair 27e5d63661 Add access control
The gear server is modified to check an access control list for
certain actions if SSL and ACLs are enabled.  Clients and workers
can be granted permission to register and invoke only functions
matching certain regexes, as well as the ability to grant ACLs to
other connections.  A connection can always revoke its own access.
ACL entries are checked based on the subject name in the SSL
certificate (which is trustworthy because only certificates signed
by the supplied CA are accepted).

The submitJob method is updated to give up sooner if it is unable
to submit a job to any connected servers (older behavior would busy
loop trying to submit it, but since there are now more scenarios
where a functioning gear server might reject a job, that behavior
seems less desirable).

Docs and tests are updated for the new feature.

Change-Id: I07edfb964bf716df08be86f844061bdad29b9728
2014-04-22 11:55:09 -07:00
Khai Do cc6e90181e Update gear docs to include gearman server daemon
Use the sphinxcontrib-programoutput package to
document command line interface for geard.

Change-Id: Ibe53e9cd176e4cdacd1519c7f1da890002a67125
2013-08-30 21:07:57 -07:00
David Shrewsbury 035b883e7a Add SSL support for clients, workers, and geard
This change requires all three SSL files (private key,
public certificate, and CA certificate) to be specified in
order for SSL to be used.

Change-Id: Ie69b9c16325c04a1818c0b54d3b23526d11ed6a1
2013-07-08 19:40:35 +00:00
James E. Blair 61bd6ce570 Add simple Gearman server.
For testing, not for real use under load.

Change-Id: I9c84b1eea7d868e907b80b6edf60c49c172c356b
2013-05-04 08:20:51 -07:00
James E. Blair 772d256328 Reorganize documentation.
Split up into sections by usage.

Improve autodoc output of AdminRequest objects and enforce appropriate
arguments in constructors.

Change-Id: I834e4d10edbee9494d68ae010f439624172a111f
2013-05-04 08:20:51 -07:00
James E. Blair 868cc239c9 Add worker functionality.
Change-Id: I7d624df38278dbfba8a3123285b33a52bdc3b870
2013-05-04 08:20:49 -07:00
James E. Blair ba9ff1c9c6 Add Sphinx documentation.
Add more events.

Also, return Job objects from event handlers for convenience of
subclasses.

Add sphinx config to setup.cfg.

Change-Id: I2ccc32fbc5f043a67d5da86cc3c37ab3d2c30d99
2013-04-10 14:06:18 -07:00