README.md

Identity service

Identity service for EOEPCA project.

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Documentation
• Usage
• Roadmap
• Contributing
• Debug
• License
• Contact
• Acknowledgements

About The Project

Identity offers seemingly authentication and authorization to be added to Applications.
Includes four main components:

• Keycloak integration: Open Source Identity and Access Management.
• Gatekeeper proxy integration: Authentication Proxy to enable seemless authentication and authorization to be added to Applications. Interacts with Keycloak.
• Keycloak client: Keycloak client written in Python based on python-keycloak package.
• Identity API: Restful API using Flask Framework to be consumed by Identity Manager. Interacts with Keycloak API.

Built With

• Keycloak
• Gatekeeper Proxy
• FastAPI Framework
• PostgreSQL

Getting Started

Using Docker compose:

docker-compose up -d --build

Using Helm:

kubectl apply -f infra/cert-issuer.yaml
helm install identity infra

Prerequisites

• Docker
• Docker Compose
  or
• Helm
• Kubernetes
• Rancher (Optional)

Installation

1. Get into EOEPCA's development environment

vagrant ssh

2. Clone the repo

git clone https://github.com/EOEPCA/um-identity-service.git

3. Change local directory

cd um-identity-service

4. Run with Docker compose

docker compose up -d --build

4. Run with Helm

helm install identity-service helm

Documentation

The component documentation can be found at https://eoepca.github.io/um-identity-service/.

Usage

• Docker-compose:
  Keycloak - http://localhost
  Gatekeeper Proxy - http://localhost:3000
  Identity API - http://localhost:8080
  Resource server demo - http://localhost:7072

Add 127.0.0.1 keycloak to hosts file to be able to run locally.

• Helm charts:
  Keycloak - https://identity.keycloak.nip.io Gatekeeper Proxy - https://identity.proxy.nip.io
  Identity API - https://identity.api.nip.io
  Resource server demo - https://identity.demo.nip.io

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Debug

Debug Helm Charts:

cd infra/charts/identity-keycloak
helm template identity-keycloak --debug . > keycloak-chart.log

cd infra/charts/identity-gatekeeper
helm template identity-gatekeeper --debug . > gatekeeper-chart.log

cd infra/charts/identity-api
helm template identity-api --debug . > identity-api-chart.log

cd infra/charts/identity-postgres
helm template identity-postgres --debug . > postgres-chart.log

cd infra/charts/identity-spring-boot-echo
helm template identity-postgres --debug . > spring-boot-echo-chart.log

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

Contact

EOEPCA mailbox

Project Link: https://github.com/EOEPCA/um-identity-service

Acknowledgements

• README.md is based on this template by Othneil Drew.