Merge pull request #371 from isururanawaka/jakarta-conversion

Improve README
tree: 01d42d91eb950f01e4edff4443ccb07c3916c872
  1. ansible/
  2. custos-client-sdks/
  3. custos-core/
  4. custos-grpc-data-models/
  5. custos-rest-proxy/
  6. custos-services/
  7. custos-tests/
  8. custos-utilities/
  9. .asf.yaml
  10. .gitignore
  11. .travis.yml
  12. LICENSE
  13. pom.xml
  14. README.md
README.md

Apache Airavata Custos Security

License GitHub closed pull requests Build Status

Science gateways represent potential targets for cybersecurity threats to users, scientific research, and scientific resources. Custos is a software framework that provides common security operations for science gateways, including user identity and access management, gateway tenant profile management, resource secrets management, and groups and sharing management. The goals of the Custos project are to provide these services to a wide range of science gateway frameworks, providing the community with an open-source, transparent, and reviewed code base for common security operations; and to operate trustworthy security services for the science gateway community using this software base. To accomplish these goals, we implement Custos using a scalable microservice architecture that can provide highly available, fault-tolerant operations. Custos exposes these services through a language-independent Application Programming Interface that encapsulates science gateway usage scenarios.

To find out more, please check out the Custos website and the Custos wiki.

Quickstart

Installation Instructions

Deploy Custos on remote server

Setup Custos for local development

Prerequisites

  • Java 17

  • Docker installed on local environment

####Clone the repository

  git clone -b develop https://github.com/apache/airavata-custos.git
  

Build source code

Following command builds the Custos source code and create two docker images of custos_core_server and custos_integration_server

  cd airavata-custos
  mvn clean install

Run Custos on docker

Following command starts Custos main services and its depend services
  • Dependent Services

    • Keycloak
    • MySQL
    • HashiCorp Vault
    • CILogon
  • Custos Services

    • Custos Core Service
    • Custos Integration Service
    • Custos Rest Proxy
   cd custos-utilities/ide-integration/src/main/containers
   docker-compose up

Bootstrapping Custos

If all services were successfully ran. Custos bootstrap service needs to be run to create a Super tenant to launch Custos Portal

 cd custos-utilities/custos-bootstrap-service/
 mvn spring-boot:run

The above command should create the super tenant and it outputs super tenant credentials. Copy those credentials to configure Custos Portal.

Install Custos Portal Locally

Following the following link to access portal deployment instructions

custos portal

Roadmap

Contributing

Questions or need help?