Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document openedx/core/djangoapps/video_pipeline feature toggles

Browse Source
This commit is contained in:
Régis Behmo
2020-08-19 22:11:44 +02:00
parent 8aa049be75
commit 39a3770a6f
2 changed files with 71 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
openedx/core/djangoapps/video_pipeline/config/waffle.py
View File

@@ -8,8 +8,37 @@ from openedx.core.djangoapps.waffle_utils import CourseWaffleFlag, WaffleFlag, W
# Videos Namespace
WAFFLE_NAMESPACE = 'videos'
# Waffle flag telling whether youtube is deprecated.
"""
.. toggle_name: videos.deprecate_youtube
.. toggle_implementation: WaffleFlag
.. toggle_default: False
.. toggle_description: Waffle flag telling whether youtube is deprecated. When enabled,
videos are no longer uploaded to YouTube as part of the video pipeline.
.. toggle_category: videos
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2018-08-03
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/18765
.. toggle_status: supported
"""
DEPRECATE_YOUTUBE = 'deprecate_youtube'
"""
.. toggle_name: videos.enable_devstack_video_uploads
.. toggle_implementation: WaffleFlag
.. toggle_default: False
.. toggle_description: When enabled, use Multi-Factor Authentication (MFA) for
authenticating to AWS. These short-lived access tokens are well suited for
development (probably?).
.. toggle_category: videos
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2020-03-12
.. toggle_expiration_date: None
.. toggle_warnings: Enabling this feature requires that the ROLE_ARN,
MFA_SERIAL_NUMBER, MFA_TOKEN settings are properly defined.
.. toggle_tickets: https://github.com/edx/edx-platform/pull/23375
.. toggle_status: supported
"""
ENABLE_DEVSTACK_VIDEO_UPLOADS = 'enable_devstack_video_uploads'
ENABLE_VEM_PIPELINE = 'enable_vem_pipeline'

44
openedx/core/djangoapps/video_pipeline/models.py
View File

@@ -50,6 +50,19 @@ class VEMPipelineIntegration(ConfigurationModel):
Manages configuration for connecting to the video encode manager service and using its API.
.. no_pii:
.. toggle_name: VEMPipelineIntegration.enabled
.. toggle_implementation: ConfigurationModel
.. toggle_default: False
.. toggle_description: Send videos to the Video Encode Manager (VEM) as part of the
video pipeline.
.. toggle_category: video_pipeline
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2020-06-04
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/24093
.. toggle_status: supported
"""
client_name = models.CharField(
max_length=100,
@@ -80,9 +93,22 @@ class VEMPipelineIntegration(ConfigurationModel):
@python_2_unicode_compatible
class VideoUploadsEnabledByDefault(ConfigurationModel):
"""
Enables video uploads enabled By default feature across the platform.
Enables video uploads across the platform.
.. no_pii:
.. toggle_name: VideoUploadsEnabledByDefault.enabled_for_all_courses
.. toggle_implementation: ConfigurationModel
.. toggle_default: False
.. toggle_description: Allow video uploads for all courses of the platform. This
enables the "Video Uploads" menu in the CMS.
.. toggle_category: video_pipeline
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-11-10
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/16536
.. toggle_status: supported
"""
# this field overrides course-specific settings
enabled_for_all_courses = models.BooleanField(default=False)
@@ -122,10 +148,22 @@ class VideoUploadsEnabledByDefault(ConfigurationModel):
@python_2_unicode_compatible
class CourseVideoUploadsEnabledByDefault(ConfigurationModel):
"""
Enables video uploads enabled by default feature for a specific course. Its global feature must be
enabled for this to take effect.
Enables video uploads for a specific course.
.. no_pii:
.. toggle_name: CourseVideoUploadsEnabledByDefault.course_id
.. toggle_implementation: ConfigurationModel
.. toggle_default: False
.. toggle_description: Allow video uploads for a specific course. This enables the
"Video Uploads" menu in the CMS.
.. toggle_category: video_pipeline
.. toggle_use_cases: open_edx
.. toggle_creation_date: 2017-11-10
.. toggle_expiration_date: None
.. toggle_warnings: None
.. toggle_tickets: https://github.com/edx/edx-platform/pull/16536
.. toggle_status: supported
"""
KEY_FIELDS = ('course_id',)