Gaffer

Gaffer

Pour accéder rapidement et facilement à un environnement avec tout installé et configuré correctement, vous pouvez utiliser GitHub Codespaces, ou bien GitLab GitPod. Ceux-ci fournissent des environnements de codage à distance utilisant VS Code avec les plugins requis, la version Java et Maven préinstallés.

Notre Javadoc peut être trouvé ici. La documentation de Gaffer est conservée dans le référentiel gaffer-doc et publiée sur les pages GitHub (gchq.github.io).

Exigences locales

Pour créer Gaffer localement, vous avez besoin de Java 8 ou 11 et de Maven installés localement dans un environnement * nix. MS Windows fonctionnera dans la plupart des cas, mais n'est pas recommandé car les tests utilisant Hadoop échouent en raison de la prise en charge limitée de Hadoop sous Windows. Gaffer compilera avec des versions plus récentes de Java, mais certains tests échoueront en raison du manque de prise en charge de Java plus récent dans certaines dépendances externes.

Pour construire Gaffer, exécutez mvn clean install -Pquick dans le répertoire de niveau supérieur. Cela construira toutes les bibliothèques principales de Gaffer et quelques exemples sur la façon de charger et d'interroger des données.

Processus de contribution

Des informations détaillées sur nos méthodes de travail peuvent être trouvées dans nos documents destinés aux développeurs. Bref:

• Signez le contrat de licence de contributeur GCHQ
• Poussez vos modifications vers un fork
• Soumettre une pull request

Inclusion dans d'autres projets

Gaffer est hébergé sur Maven Central et peut facilement être intégré à vos propres projets Maven.

Pour utiliser Gaffer à partir de l'API Java, les seules dépendances requises sont le module graphique Gaffer et un module de magasin pour la technologie de base de données spécifique utilisée pour stocker les données, par exemple pour le magasin Accumulo :

< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >graph</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >
< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >accumulo-store</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >

Cela inclura toutes les autres dépendances obligatoires. D'autres composants (facultatifs) peuvent être ajoutés à votre projet selon les besoins.

Dépôts associés

Le référentiel gafferpy contient un shell python qui peut exécuter des opérations.

Le référentiel gaffer-docker contient le code nécessaire pour exécuter Gaffer à l'aide de Docker ou Kubernetes.

Le référentiel koryphe contient une bibliothèque de fonctions extensibles pour filtrer, agréger et transformer les données basées sur l'API Java Function. C'est une dépendance de Gaffer.

Licence

Gaffer est sous licence Apache 2 et est couvert par Crown Copyright.

 Copyright 2016-2023 Crown Copyright

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.