christianlight/tutor
6
0
Fork 0
mirror of https://github.com/ChristianLight/tutor.git synced 2024-11-11 15:51:00 +00:00
Code Issues Releases Activity
866aae5cfe
tutor/plugins/minio/README.rst

46 lines
2.0 KiB
ReStructuredText
Raw Normal View History

Working Kubernetes quickstart The k8s quickstart command is now functional, with suppport for https, xqueue, notes and minio. There are still a few bugs to get rid of, though.
2019-06-06 19:58:21 +00:00
Object storage for Open edX with `MinIO <https://www.minio.io/>`_
=================================================================
🔌 Introduce a plugin system for tutor This adds the basic feratures that we need for a working plugin system, but there are still many TODOs in the codebase.
2019-05-29 09:14:06 +00:00
Working Kubernetes quickstart The k8s quickstart command is now functional, with suppport for https, xqueue, notes and minio. There are still a few bugs to get rid of, though.
2019-06-06 19:58:21 +00:00
This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ that provides S3-like object storage for Open edX platforms. It's S3, but without the dependency on AWS. This is achieved thanks to `MinIO <https://www.minio.io/>`_, an open source project that provides object storage with an API compatible with S3.
🔌 Introduce a plugin system for tutor This adds the basic feratures that we need for a working plugin system, but there are still many TODOs in the codebase.
2019-05-29 09:14:06 +00:00
Working Kubernetes quickstart The k8s quickstart command is now functional, with suppport for https, xqueue, notes and minio. There are still a few bugs to get rid of, though.
2019-06-06 19:58:21 +00:00
In particular, this plugin is essential for `Kubernetes deployment <https://docs.tutor.overhang.io/k8s.html>`_.
Installation
------------
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
The plugin is currently bundled with the `binary releases of Tutor <https://github.com/overhangio/tutor/releases>`_. If you have installed Tutor from source, you will have to install this plugin from source, too::
🔌 Introduce a plugin system for tutor This adds the basic feratures that we need for a working plugin system, but there are still many TODOs in the codebase.
2019-05-29 09:14:06 +00:00
Migrate github repo to overhangio organization
2019-06-23 17:56:15 +00:00
git clone https://github.com/overhangio/tutor/
Working Kubernetes quickstart The k8s quickstart command is now functional, with suppport for https, xqueue, notes and minio. There are still a few bugs to get rid of, though.
2019-06-06 19:58:21 +00:00
pip install -e tutor/plugins/minio
Then, to enable this plugin, run::
tutor plugins enable minio
Configuration
-------------
- ``MINIO_BUCKET_NAME`` (default: ``"openedx"``)
- ``MINIO_FILE_UPLOAD_BUCKET_NAME`` (default: ``"openedxuploads"``)
- ``MINIO_COURSE_IMPORT_EXPORT_BUCKET`` (default: ``"openedxcourseimportexport"``)
- ``MINIO_HOST`` (default: ``"minio.{{ LMS_HOST }}"``)
- ``MINIO_DOCKER_REGISTRY`` (default: ``"{{ DOCKER_REGISTRY }}"``)
- ``MINIO_DOCKER_IMAGE_CLIENT`` (default: ``"minio/mc:RELEASE.2019-05-23T01-33-27Z"``)
- ``MINIO_DOCKER_IMAGE_SERVER`` (default: ``"minio/minio:RELEASE.2019-05-23T00-29-34Z"``)
These values can be modified with ``tutor config save --set PARAM_NAME=VALUE`` commands.
DNS records
-----------
It is assumed that the ``MINIO_HOST`` DNS record points to your server. When running MinIO on your laptop, you should point your services to ``minio.localhost``::
tutor config save --set MINIO_HOST=minio.localhost
Web UI
------
The MinIO web UI can be accessed at http://<MINIO_HOST>. The credentials for accessing the UI can be obtained with::
🔌 Introduce a plugin system for tutor This adds the basic feratures that we need for a working plugin system, but there are still many TODOs in the codebase.
2019-05-29 09:14:06 +00:00
Working Kubernetes quickstart The k8s quickstart command is now functional, with suppport for https, xqueue, notes and minio. There are still a few bugs to get rid of, though.
2019-06-06 19:58:21 +00:00
tutor config printvalue OPENEDX_AWS_ACCESS_KEY
tutor config printvalue OPENEDX_AWS_SECRET_ACCESS_KEY
Copy Permalink