Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/authzforce/fiware
FIWARE Generic Enabler for PDP/PAP support functions using an access control schema based on the XACML standard
https://github.com/authzforce/fiware
authzforce fiware pdp security xacml
Last synced: 4 days ago
JSON representation
FIWARE Generic Enabler for PDP/PAP support functions using an access control schema based on the XACML standard
- Host: GitHub
- URL: https://github.com/authzforce/fiware
- Owner: authzforce
- License: gpl-3.0
- Created: 2015-09-27T15:23:12.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-02-07T01:45:20.000Z (9 months ago)
- Last Synced: 2024-08-02T01:21:15.581Z (3 months ago)
- Topics: authzforce, fiware, pdp, security, xacml
- Language: API Blueprint
- Homepage: https://authzforce-ce-fiware.rtfd.io
- Size: 41.2 MB
- Stars: 5
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome - Authzforce - Addon which implements PDP/PAP functions within an access control schema based on the XACML standard. (FIWARE Catalogue / Security)
README
# FIWARE-specific documentation and Docker distribution
[](https://www.fiware.org/developers/catalogue/)
[](https://www.gnu.org/licenses/gpl-3.0)
[](http://stackoverflow.com/questions/tagged/authzforce)
[](https://ask.fiware.org/questions/scope:all/sort:activity-desc/tags:authzforce/)
[](http://authzforce-ce-fiware.readthedocs.io/en/latest/?badge=latest)
This project is part of [FIWARE](https://www.fiware.org). More info on the [FIWARE catalogue](http://catalogue.fiware.org/enablers/authorization-pdp-authzforce).
This project provides the source of various FIWARE-specific documents to AuthzForce Server. AuthzForce Server is FIWARE Authorization PDP GEri (Generic Enabler Reference Implementation):
- Technical specifications of the FIWARE Authorization PDP Generic Enabler (GE)'s API that AuthzForce implements in various forms:
- WADL and XML schemas (the reference);
- Apiary blueprint (the HTML output is available in [Apiary style](http://docs.authorizationpdp.apiary.io) and [FIWARE style](http://authzforce.github.io/fiware/) ).
- The source of the GEri's documentation: Installation and Administration guide, User and Programmer Guide, etc. The generated documentation is available for each AuthzForce Server release as standalone HTML/PDF from the [Server release page](https://github.com/authzforce/server/releases), or online on [readthedocs.org](http://readthedocs.org/projects/authzforce-ce-fiware/versions/);
- The source of the GEri's Docker image published in FIWARE Docker hub.
The actual source code of the GEri is in [server component's repository](https://github.com/authzforce/server).
# How to generate the documentation
Checkout this git repository, go to the `doc` directory of the local copy, then
for HTML output, run:
```console
make clean html
```
For PDF output, if you do it for the first time, install the requirements (instructions for Ubuntu 14.04+):
```console
sudo aptitude install texlive-latex-recommended texlive-fonts-recommended texlive-latex-extra
```
Then run:
```console
make clean latexpdf
```
# Release
After any new release of AuthzForce server on authzforce/server repository, do the documentation release here as follows:
1. Update `version` and `release` variables in [Sphinx configuration](doc/conf.py), to match the new AuthzForce server version.
1. Update manuals: [Installation and Administration Guide](doc/InstallationAndAdministrationGuide.rst) and [User and Programmer's Guide](doc/UserAndProgrammersGuide.rst); especially version numbers when they occur.
1. Test the updated documentation locally:
```
$ pip install -r requirements.txt
$ make html
```
1. Update FILAB deployment scripts: [install.sh](filab.deploy/install.sh), [verif.sh](filab.deploy/verif.sh); especially the package version to match the new AuthzForce server version.
1. Commit and push all changes
1. Re-publish the Docker image on Docker Hub from [authzforce/server repository](https://hub.docker.com/r/authzforce/server/) to [fiware/authzforce-ce-server Docker repository](https://hub.docker.com/r/fiware/authzforce-ce-server/).
1. Test the readthedocs.org HTML/PDF output by building the version *latest* from the [readthedocs.org repository](https://readthedocs.org/projects/authzforce-ce-fiware/builds/).
1. After the readthedocs.org build is OK, create a release on Github with same tag name as the matching release of the AuthzForce [server](https://github.com/authzforce/server/releases/latest), e.g. `release-1.2.3`.
1. Create a Docker tag in [build settings of authzforce-ce-server's Docker repository](https://hub.docker.com/r/fiware/authzforce-ce-server/) with the new release tag as *Name*, e.g. `release-1.2.3`, save changes and trigger the build.
1. Trigger readthedocs.org to fetch the new release tag by updating something in the [authzforce-ce-fiware project Settings in Admin menu](https://readthedocs.org/dashboard/authzforce-ce-fiware/edit/) such as the *Description*.
1. In the *Versions* sub-menu of *Admin* on this readthedocs.org repository, you should now see the new tag/version. Check the *Active* checkbox next to it and click *Submit*.
1. In the *Builds* menu on the readthedocs.org repository, select the new version and click the *Build version:* button. The build is triggered and added to the queue. Wait until the status changes to *Passed*.
# Hotfix
If you need to fix things on a release, create a hotfix release by adding/incrementing a letter as suffix to the AuthzForce server version, e.g. `1.2.3a` would be the first documentation fix for AuthzForce version `1.2.3` (the tag would be `release-1.2.3a`), `1.2.3b` would be the second hotfix, etc.