Skip to content
Snippets Groups Projects
Commit e2f0eb06 authored by Benguria Elguezabal, Gorka's avatar Benguria Elguezabal, Gorka
Browse files

public release

parents
No related branches found
No related tags found
No related merge requests found
Showing
with 891 additions and 0 deletions
# Created by https://www.gitignore.io/api/java,maven,osx,windows,python,eclipse
docker-compose.prod
### Visual Code ###
.vs/
.vscode/
.hintrc
### Maven ###
target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
pom.xml.next
release.properties
dependency-reduced-pom.xml
buildNumber.properties
.mvn/timing.properties
# Exclude maven wrapper
!/.mvn/wrapper/maven-wrapper.jar
### OSX ###
*.DS_Store
.AppleDouble
.LSOverride
# Icon must end with two \r
Icon
# Thumbnails
._*
# Files that might appear in the root of a volume
.DocumentRevisions-V100
.fseventsd
.Spotlight-V100
.TemporaryItems
.Trashes
.VolumeIcon.icns
.com.apple.timemachine.donotpresent
# Directories potentially created on remote AFP share
.AppleDB
.AppleDesktop
Network Trash Folder
Temporary Items
.apdisk
### Windows ###
# Windows image file caches
Thumbs.db
ehthumbs.db
# Folder config file
Desktop.ini
# Recycle Bin used on file shares
$RECYCLE.BIN/
# Windows Installer files
*.cab
*.msi
*.msm
*.msp
# Windows shortcuts
*.lnk
### Python ###
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class
# C extensions
*.so
# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
#lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg
# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec
# Installer logs
pip-log.txt
pip-delete-this-directory.txt
# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover
.hypothesis/
# Translations
*.mo
*.pot
# Django stuff:
*.log
local_settings.py
# Flask stuff:
instance/
.webassets-cache
# Scrapy stuff:
.scrapy
# Sphinx documentation
docs/_build/
# PyBuilder
# Jupyter Notebook
.ipynb_checkpoints
# pyenv
.python-version
# celery beat schedule file
celerybeat-schedule
# dotenv
.env
# virtualenv
.venv/
venv/
ENV/
# Spyder project settings
.spyderproject
# Rope project settings
.ropeproject
### Eclipse ###
.metadata
bin/
tmp/
*.tmp
*.bak
*.swp
*~.nib
local.properties
.settings/
.loadpath
.recommenders
# Eclipse Core
.project
# External tool builders
.externalToolBuilders/
# Locally stored "Eclipse launch configurations"
*.launch
# PyDev specific (Python IDE for Eclipse)
*.pydevproject
# CDT-specific (C/C++ Development Tooling)
.cproject
# JDT-specific (Eclipse Java Development Tools)
.classpath
# Java annotation processor (APT)
.factorypath
# PDT-specific (PHP Development Tools)
.buildpath
# sbteclipse plugin
.target
# Tern plugin
.tern-project
# TeXlipse plugin
.texlipse
# STS (Spring Tool Suite)
.springBeans
# Code Recommenders
.recommenders/
### Java ###
*.class
# Mobile Tools for Java (J2ME)
.mtj.tmp/
# Package Files #
*.jar
*.war
*.ear
*.rar
# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
hs_err_pid*
# Current Config...
.env
#Vscode extension
.history
#intelliJ settings files
.service-catalogue-server/.idea
#temp files
temp/
sync.ffs_db
service-catalogue-server/service-catalogue-server.bat
service-catalogue-manager/service-catalogue-manager.bat
test/
service-catalogue-server/.idea/
*.hprof
backup/
service-catalogue-manager/src/assets/data/examples/cataloguesDataset3.json
stages:
- build_and_push
- redeploy
variables:
DOCKER_BUILDKIT: 1
COMPOSE_DOCKER_CLI_BUILD: 1
build_and_push:
image: docker/compose:latest
stage: build_and_push
services:
- docker:dind
script:
- docker login docker.io -u "$DOCKER_REGISTRY_USER" -p "$DOCKER_REGISTRY_PASSWORD"
- echo We download previous build for using as cache from
- docker-compose pull
- docker-compose build
- docker-compose push
tags:
- docker
only:
- kubernetes
redeploy_at_k8s:
image: alpine/k8s:1.21.5
stage: redeploy
script:
- kubectl config set-cluster local --server="${K8S_SERVER}"
- kubectl config set clusters.local.certificate-authority-data "${K8S_CERTIFICATE_AUTHORITY_DATA}"
- kubectl config set-credentials local --token="${K8S_USER_TOKEN}"
- kubectl config set-context local --cluster=local --user=local
- kubectl config use-context local
- kubectl --insecure-skip-tls-verify version
- kubectl get deployments -n data-harmonization-dev --insecure-skip-tls-verify
- kubectl rollout restart deployment sc-be -n data-harmonization-dev --insecure-skip-tls-verify
- kubectl rollout restart deployment sc-fe -n data-harmonization-dev --insecure-skip-tls-verify
tags:
- docker
only:
- kubernetes
when: manual
\ No newline at end of file
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
mkdocs:
configuration: mkdocs.yml
# Optionally declare the Python requirements required to build your docs
python:
install:
- requirements: docs/requirements.txt
\ No newline at end of file
apiVersion: v1
data:
.dockerconfigjson: eyJhdXRocyI6eyJodHRwczovL2luZGV4LmRvY2tlci5pby92MS8iOnsidXNlcm5hbWUiOiJhdGNhY3Jvc3MiLCJwYXNzd29yZCI6IlIhekByZSFvdTEwIiwiZW1haWwiOiJhY3Jvc3MtdGVjaEBpbGFiLmF0Yy5nciIsImF1dGgiOiJZWFJqWVdOeWIzTnpPbEloZWtCeVpTRnZkVEV3In19fQ==
kind: Secret
metadata:
name: across-registry
namespace: data-harmonization-dev
type: kubernetes.io/dockerconfigjson
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: data-harmonization-mongo-pv-claim
namespace: data-harmonization-dev
spec:
accessModes:
- ReadWriteMany
resources:
requests:
storage: 5Gi
storageClassName: nfs-client
apiVersion: v1
kind: Service
metadata:
namespace: data-harmonization-dev
name: sc-mongo
spec:
ports:
- port: 27017
selector:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-mongo
\ No newline at end of file
apiVersion: v1
kind: Service
metadata:
namespace: data-harmonization-dev
name: sc-be
spec:
ports:
- name: sc-be
port: 8086
selector:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-be
\ No newline at end of file
apiVersion: v1
kind: Service
metadata:
namespace: data-harmonization-dev
name: sc-fe
spec:
ports:
- name: sc-fe
port: 80
selector:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-fe
\ No newline at end of file
apiVersion: apps/v1
kind: Deployment
metadata:
namespace: data-harmonization-dev
name: sc-mongo
labels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-mongo
spec:
replicas: 1
selector:
matchLabels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-mongo
template:
metadata:
labels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-mongo
spec:
volumes:
- name: data-harmonization-mongo
persistentVolumeClaim:
claimName: data-harmonization-mongo-pv-claim
containers:
- image: mongo:4.4.6
name: service-catalog-mongo
imagePullPolicy: Always
volumeMounts:
- name: data-harmonization-mongo
mountPath: /data/db
ports:
- containerPort: 27017
name: sc-mongo
env:
- name: MONGO_INITDB_ROOT_USERNAME
value: root
- name: MONGO_INITDB_ROOT_PASSWORD
value: root
apiVersion: apps/v1
kind: Deployment
metadata:
namespace: data-harmonization-dev
name: sc-be
labels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-be
spec:
replicas: 1
selector:
matchLabels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-be
template:
metadata:
labels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-be
spec:
imagePullSecrets:
- name: across-registry
containers:
- image: 094360380/wp4-service-catalogue-server:latest
name: service-catalogue-server
imagePullPolicy: Always
ports:
- containerPort: 8086
name: sc-be
env:
- name: SPRING_LOGGING_LEVEL
value: INFO
- name: MONGO_LOGGING_LEVEL
value: ERROR
- name: SECURITY_LOGGING_LEVEL
value: DEBUG
- name: MONGODB_HOST
value: sc-mongo
- name: MONGODB_PORT
value: '27017'
- name: MONGODB_USER
value: root
- name: MONGODB_PWD
value: root
- name: ENABLE_AUTH
value: 'false'
- name: IDM_ISSUER_URI
value: https://keycloak-security-dev.k8s.across-h2020.eu/realms/Cape
- name: IDM_ALLOWED_ORIGIN_PATTERNS
value: https://service-catalogue-manager-dev.k8s.across-h2020.eu, http://localhost, http://across2:80, http://across2:4200, http://localhost:4200, https://transparency-dashboard-td-dev.k8s.across-h2020.eu
- name: IDM_ALLOWED_ORIGINS
value: ''
apiVersion: apps/v1
kind: Deployment
metadata:
namespace: data-harmonization-dev
name: sc-fe
labels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-fe
spec:
replicas: 1
selector:
matchLabels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-fe
template:
metadata:
labels:
workload.user.cattle.io/workloadselector: apps.deployment-data-harmonization-dev-sc-fe
spec:
imagePullSecrets:
- name: across-registry
containers:
- image: 094360380/wp4-service-catalogue-manager:latest
name: service-catalogue-manager
imagePullPolicy: Always
ports:
- containerPort: 80
name: sc-fe
env:
- name: IDM_BASE_URL
value: https://keycloak-security-dev.k8s.across-h2020.eu
- name: SERVICE_CATALOGUE_MANAGER_URL
value: https://service-catalogue-manager-dev.k8s.across-h2020.eu
- name: SERVICE_CATALOGUE_SERVER_URL
value: https://service-catalogue-server-dev.k8s.across-h2020.eu/service-catalogue
- name: CONFIG_FILE_FROM_TEMPLATE
value: 'true'
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
namespace: data-harmonization-dev
name: sc-fe-ing
annotations:
cert-manager.io/cluster-issuer: letsencrypt-cert
field.cattle.io/description: Data harmonization sc frontend ingress
spec:
ingressClassName: nginx
tls:
- hosts:
- service-catalogue-manager-dev.k8s.across-h2020.eu
secretName: sc-fe-cert-le
rules:
- host: service-catalogue-manager-dev.k8s.across-h2020.eu
http:
paths:
- pathType: ImplementationSpecific
backend:
service:
name: sc-fe
port:
number: 80
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
namespace: data-harmonization-dev
name: sc-be-ing
annotations:
cert-manager.io/cluster-issuer: letsencrypt-cert
field.cattle.io/description: Data harmonization sc backend ingress
spec:
ingressClassName: nginx
tls:
- hosts:
- service-catalogue-server-dev.k8s.across-h2020.eu
secretName: sc-be-cert-le
rules:
- host: service-catalogue-server-dev.k8s.across-h2020.eu
http:
paths:
- pathType: ImplementationSpecific
backend:
service:
name: sc-be
port:
number: 8086
This diff is collapsed.
README.md 0 → 100644
# Service Catalogue
[![License badge](https://img.shields.io/github/license/OPSILab/Idra.svg)](https://opensource.org/licenses/AGPL-3.0)
[![Docker Pulls](https://img.shields.io/docker/pulls/capesuite/service-catalog)](https://hub.docker.com/r/capesuite/service-catalog)
[![Documentation badge](https://img.shields.io/readthedocs/cape-suite)](https://service-catalogue.readthedocs.io/)
Service Catalogue provides all functionality to register, model, map and publish and manage all the information needed to support the uses of service (public&private) according to the following three points of view:
- Informational
- Service Invocation
- Semantic interoperability & Personal Data Governance
The catalogue enables the storage and publishing of service by providing general, technical and data processing information based on standard models ( e.g. [ISA2 CPSV-AP](https://joinup.ec.europa.eu/collection/semantic-interoperability-community-semic/solution/core-public-service-vocabulary-application-profile/about) ).
Service Catalogue is an open source software developed by
[Engineering Ingegneria Informatica SpA](http://www.eng.it) inside the EU founded project [ACROSS](https://across-h2020.eu/).
| :books: [Documentation](https://service-catalogue.readthedocs.io/) | :whale: [Docker Hub](https://hub.docker.com/u/capesuite)|
|---|---|
# Table of Contents
1. [Introduction](#introduction)
2. [Installation](#installation)
3. [Usage](#usage)
4. [API](#api)
5. [License](#license)
6. [Libraries](#libraries)
--------------------
## Introduction
The Service Catalogue is a layered application implementing the Service Registry (front-end and backend) and Metadata Catalogue features, to provide APIs for programmatically interaction with other components of ACROSS platform and dashboards and a graphical editors supporting users to manage service descriptions and related [Service Model](./docs/model/index.md) adaptation.
![alt tag](./docs/sc-architecture.png "Service Catalogue architecture")
The Backend is implemented as [Spring
Boot](https://spring.io/projects/spring-boot) Java microservice, and
will be deployed with a tightly coupled storage service
([MongoDB](https://www.mongodb.com/) 4.2+). The Front-end,named Service Catalogue Manager, is an Angular
portal based on [Nebular](https://akveo.github.io/nebular/) framework.
![alt tag](./docs/sc-tech-layers.png "Service Catalogue Layers")
The two layers can be deployed as [Docker](https://www.docker.com/)
containers, based on [Tomcat Alpine
image](https://hub.docker.com/_/tomcat) and paired with a MongoDB
container. This adoption of several reliable and production ready
technologies guarantees robustness and modularity of the solution.
![alt tag](./docs/sc-techs.png "Service Catalogue Technologies")
Service Catalogue architecture implementation is completed by
integrating Spring Security and [Keycloak](https://www.keycloak.org/)
that supports [OpenId Connect](https://openid.net/connect/) and
[OAuth2](https://oauth.net/2/) authorization framework. The Service
Catalogue uses the Open Id Connect protocol upon the OAuth2
Authorization workflows, in order to perform User authentication and
obtain an Access Token (JWT), which will be used to grant access.
![alt tag](./docs/sc-auth-layer.png "Service Catalogue Authentication layer")
Similarly, a client application/service wanting to interact with the
Service Catalogue, will perform OAuth2 Authorization, obtaining an
Access Token to be used in the request to APIs.The choice of Keycloak
provides an out of box solution for a rapid security layer development
of application with supporting features such as Single-Sign-On (SSO),
Social Login, User Federation, Client Adapters, Admin Console and
Account Management Console and finally [Identity
Brokering](https://www.keycloak.org/docs/latest/server_admin/#_identity_broker)
![alt tag](./docs/sc-keycloak-proxy.png "Keycloak identity brokering")
This last aspect will facilitate the integration of the Service Catalogue with multiple and specific identity Systems.
## Installation
The instruction to install Service Catalogue modules can be found at the corresponding [install](./docs/install/index.md) section
## Usage
The User Guide for Service Catalogue Manager can be found at the corresponding [usage](./docs/usage/index.md) section
## API
The Service Catalogue APIs Introduction can be found at the corresponding section of
[API](./docs/api/index.md).
## Support / Contact
Any feedback on this documentation is highly welcome, including bugs, typos and suggestions. You can use GitHub [issues](https://github.com/OPSILab/Service-Catalogue/issues)
to provide feedback.
##### Contacts
- Vincenzo Savarino: [_vincenzo.savarino@eng.it_](mailto:vincenzo.savarino@eng.it)
---
## License
Service Catalogue is licensed under [AGPLv3 License](./LICENSE).
---
## Libraries
Service Catalogue Suite uses following libraries and frameworks.
| Name | Version | License |
|-----------------------------------------------------------------------------------------|---------------|-----------------------------------|
| [Spring Boot](https://spring.io/projects/spring-boot) | 2.4.5 | Apache License 2.0 |
| [Springdoc Openapi](https://springdoc.org) | 1.5.8 | Apache License 2.0 |
| [Spring Data](https://spring.io/projects/spring-data) | 2.4.5 | Apache License 2.0 |
| [Lombok](https://projectlombok.org/) | 1.18.12 | MIT |
| [Apache Commong Lang 3](https://commons.apache.org) | 3.11 | Apache License 2.0 |
| [JSONSchema2Pojo Plugin](http://jsonschema2pojo.org) | 1.01 | Apache License 2.0 |
| [Angular](angular.io) | 11.2.12 | MIT |
| [Nebular](https://akveo.github.io/nebular) | 7.0.0 | MIT |
| [Json-Editor](https://github.com/json-editor/json-editor) | 2.8.0 | MIT |
| [Bootstrap](https://getbootstrap.com ) | 4.6.0 | MIT |
| [Ngx-configure](https://github.com/catrielmuller/ngx-configure) | 9.0.0 | ISC License |
| [Ng2-smart-table](https://akveo.github.io/ng2-smart-table) | 1.7.2 | MIT |
| [Rxjs](https://rxjs.dev/guide/overview) | 6.6.7 | Apache License 2.0 |
| [Ngx-translate](http://www.ngx-translate.com/) | 13.0.0 | MIT |
| [TypeScript](https://www.typescriptlang.org) | 4.1.5 | Apache License 2.0 |
| [jQuery](jquery.com) | 3.5.1 | MIT |
| [D3](https://d3js.org) | 6.6.2 | BSD |
| [Material-design-icons](https://github.com/google/material-design-icons) | 3.0.1 | Apache License 2.0 |
| [Fontawesome-free](https://fontawesome.com) | 5.15.3 | CC-BY-4.0 |
| [Fontawesome-svg-core](https://www.npmjs.com/package/@fortawesome/fontawesome-svg-core) | 1.2.35 | MIT | | | |
| [Java OpenJDK](https://openjdk.java.net/) | >= 15 | GNU General Public License Version 2.0 |
| [Apache Tomcat](https://tomcat.apache.org) | >=9.0 | Apache License v.2.0 |
| [MongoDB Community Server](www.mongodb.com) | >=4.2.9 | Server Side Public License (SSPL) |
| [Maven](https://maven.apache.org) | >=3.5.0 | Apache License 2.0 |
| [JsonEditor](https://www.npmjs.com/package/jsoneditor) | 9.10.0 | Apache License 2.0 |
| [Lodash](https://www.npmjs.com/package/lodash) | 4.17.21 | MIT |
| [urlencode](https://github.com/node-modules/urlencode) | 1.1.0 | MIT |
---
### External Components
Service Catalogue uses the [Keycloak IdM](https://www.keycloak.org/) (Apache License 2.0).
---
© 2021-2023 Engineering Ingegneria Informatica S.p.A.
version: "3.8"
services:
service-catalog:
image: capesuite/service-catalog
build: ./service-catalogue-server
ports:
- "8086:8086"
environment:
#- PROFILE=
- SPRING_LOGGING_LEVEL=INFO
- MONGO_LOGGING_LEVEL=ERROR
- SECURITY_LOGGING_LEVEL=DEBUG
- MONGODB_HOST=service-catalog-mongo
- MONGODB_PORT=27017
- MONGODB_USER=root
- MONGODB_PWD=root
- ENABLE_AUTH=false
- IDM_ISSUER_URI=https://idm.cape-suite.eu/auth/realms/Cape
- IDM_ALLOWED_ORIGIN_PATTERNS=http://localhost:81,http://localhost,http://localhost:82,http://localhost:83
- IDM_ALLOWED_ORIGINS=
networks:
- sc-network
service-catalog-mongo:
image: mongo:4.4.6
restart: always
ports:
- "27022:27017"
environment:
MONGO_INITDB_ROOT_USERNAME: root
MONGO_INITDB_ROOT_PASSWORD: root
volumes:
- type: volume
source: service-catalog-volume
target: /data/db
volume:
nocopy: true
networks:
- sc-network
service-catalogue-manager:
image: capesuite/service-catalogue-manager:latest
build:
context: ./service-catalogue-manager
args:
BASE_HREF: /service-catalogue-manager/
ports:
- "97:80"
volumes:
- ./service-catalogue-manager/src/assets/config.prod.json:/usr/share/nginx/html/assets/config.json
- ./service-catalogue-manager/nginx.conf:/etc/nginx/conf.d/default.conf
networks:
- sc-network
volumes:
service-catalog-volume:
networks:
sc-network:
name: sc-network
driver: bridge
driver_opts:
com.docker.network.driver.mtu: 1400
ipam:
config:
- subnet: 172.29.1.0/24
version: "3.8"
services:
service-catalog:
image: 094360380/wp4-service-catalogue-server:latest
# image: capesuite/service-catalog
build:
context: ./service-catalogue-server
args:
BUILDKIT_INLINE_CACHE: 1 # For multistage docker
cache_from:
- 094360380/wp4-service-catalogue-server:latest
ports:
- "8086:8086"
environment:
#- PROFILE=
- SPRING_LOGGING_LEVEL=INFO
- MONGO_LOGGING_LEVEL=ERROR
- SECURITY_LOGGING_LEVEL=DEBUG
- MONGODB_HOST=service-catalog-mongo
- MONGODB_PORT=27017
- MONGODB_USER=root
- MONGODB_PWD=root
- ENABLE_AUTH=false
#- IDM_ISSUER_URI=http://across2:8083/auth/realms/Cape
- IDM_ISSUER_URI=https://keycloak-security-dev.k8s.across-h2020.eu/realms/Cape
#- IDM_ALLOWED_ORIGIN_PATTERNS=*
#- IDM_ALLOWED_ORIGINS=*
- IDM_ALLOWED_ORIGIN_PATTERNS=http://localhost, http://across2:80, http://across2:4200, http://localhost:4200, https://transparency-dashboard-td-dev.k8s.across-h2020.eu
- IDM_ALLOWED_ORIGINS=
networks:
- sc-network
extra_hosts:
- "across2:172.26.41.230"
service-catalog-mongo:
image: mongo:4.4.6
restart: always
ports:
- "27022:27017"
environment:
MONGO_INITDB_ROOT_USERNAME: root
MONGO_INITDB_ROOT_PASSWORD: root
volumes:
- type: volume
source: service-catalog-volume
target: /data/db
volume:
nocopy: true
networks:
- sc-network
extra_hosts:
- "across2:172.26.41.230"
service-catalogue-manager:
image: 094360380/wp4-service-catalogue-manager:latest
# image: capesuite/service-catalogue-manager:latest
environment:
IDM_BASE_URL: https://keycloak-security-dev.k8s.across-h2020.eu
SERVICE_CATALOGUE_MANAGER_URL: http://across2:80/service-catalogue-manager
SERVICE_CATALOGUE_SERVER_URL: http://across2:8086/service-catalogue
CONFIG_FILE_FROM_TEMPLATE: "true"
build:
context: ./service-catalogue-manager
args:
#BASE_HREF: /service-catalogue-manager/
BASE_HREF: /service-catalogue-manager
BUILDKIT_INLINE_CACHE: 1 # For multistage docker
cache_from:
- 094360380/wp4-service-catalogue-manager:latest
ports:
- "80:80"
networks:
- sc-network
extra_hosts:
- "across2:172.26.41.230"
volumes:
service-catalog-volume:
networks:
sc-network:
name: sc-network
driver: bridge
driver_opts:
com.docker.network.driver.mtu: 1400
ipam:
config:
- subnet: 172.29.1.0/24
This diff is collapsed.
# Service Catalogue APIs
## Introduction
Service Catalogue exposes a set of APIs implementing the Service Catalogue functionalities in particular CRUD operation for the management of the registered services.
## OpenAPI Documentation
The following links provide the Swagger UI interfaces exposing the OpenAPI 3 documentation of Service Catalogue APIs:
- [Service Catalogue Server](https://www.cape-suite.eu/service-catalogue/swagger-ui/index.html?configUrl=/service-catalogue/api-docs/swagger-config)
APis can be directly tried:
- By clicking at first on `Authorize` either:
* Using client and credentials of an user registered in the Service Catalogue Idm (Keycloak)
* Copy as Bearer directly a JWT token issued by Service Catalogue Idm (Keycloak)
- Then click each `Try it out` button.
---
Any feedback on this documentation is highly welcome, including bug reports and
suggestions. Please send the feedback through
[GitHub](https://github.com/OPSILab/Service-Catalogue). Thanks!
Service Catalogue provides all functionality to register, model, map and publish and manage all the information needed to support the uses of service (public&private) according to the following three points of view:
- Informational
- Service Invocation
- Semantic interoperability & Personal Data Governance
The catalogue enables the storage and publishing of service by providing general, technical and data processing information based on standard models ( e.g. [ISA2 CPSV-AP](https://joinup.ec.europa.eu/collection/semantic-interoperability-community-semic/solution/core-public-service-vocabulary-application-profile/about) ).
Service Catalogue is an open source software developed by
[Engineering Ingegneria Informatica SpA](http://www.eng.it) inside the EU founded project [ACROSS](https://across-h2020.eu/).
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment