From 39a3770a6fb556d22958e28eabdc1c3da7814997 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9gis=20Behmo?= Date: Wed, 19 Aug 2020 22:11:44 +0200 Subject: [PATCH] Document openedx/core/djangoapps/video_pipeline feature toggles --- .../video_pipeline/config/waffle.py | 31 ++++++++++++- .../core/djangoapps/video_pipeline/models.py | 44 +++++++++++++++++-- 2 files changed, 71 insertions(+), 4 deletions(-) diff --git a/openedx/core/djangoapps/video_pipeline/config/waffle.py b/openedx/core/djangoapps/video_pipeline/config/waffle.py index ce7a4cc861..1cc5c378b2 100644 --- a/openedx/core/djangoapps/video_pipeline/config/waffle.py +++ b/openedx/core/djangoapps/video_pipeline/config/waffle.py @@ -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' diff --git a/openedx/core/djangoapps/video_pipeline/models.py b/openedx/core/djangoapps/video_pipeline/models.py index 4911a15ae0..d1550e5500 100644 --- a/openedx/core/djangoapps/video_pipeline/models.py +++ b/openedx/core/djangoapps/video_pipeline/models.py @@ -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',)