EOEPCA Minio Bucket API

This repository includes the EOEPCA Minio Bucket API component
Explore the docs »
View Demo · Report Bug · Request Feature

Table of Contents

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

About The Project

During workspace creation the workspace-api needs to create an object storage bucket for the user. The method by which the bucket is created is a function of the hosting infrastructure object storage layer - i.e. there is no ‘common’ approach for the workspace-api to perform the bucket creation.

In order to allow this bucket creation step to be customised by the platform integrator, the workspace-api is configured with a webhook endpoint that is invoked to effect the bucket creation on behalf of the workspace-api.

The Minio Bucket API provides an implementation of a Bucket Creation Webhook for a Minio S3 Object Storage backend. This is used as the default but should be replaced for a production deployment with an appropriate webhook to integrate with the object storage solution of the deployment environment.

Built With

• FastAPI
• Kubernetes Python API

Getting Started

Installation

The Minio Bucket API is deployed via the rm-minio-bucket-api helm chart from the EOEPCA Helm Chart Repository - ref. Helm Chart for the Minio Bucket API.

helm install --version 0.0.4 --values minio-bucket-api-values.yaml
--repo https://eoepca.github.io/helm-charts
rm-minio-bucket-api rm-minio-bucket-api

Documentation

The component documentation can be found at https://deployment-guide.docs.eoepca.org/current/eoepca/workspace/#bucket-creation-webhook

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

License

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

Contact

Project Link: https://github.com/EOEPCA/rm-minio-bucket-api

Acknowledgements

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