forked from openedx-unsupported/devstack
-
Notifications
You must be signed in to change notification settings - Fork 1
/
options.mk
100 lines (87 loc) · 5.12 KB
/
options.mk
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# DEFAULT DEVSTACK OPTIONS
# Included into Makefile and exported to command environment.
# Defaults are listed in this file.
# Local git-ignored overrides can be configured by creating `options.local.mk`.
# WHEN ADDING NEW OPTIONS TO THIS FILE:
# 1. Provide an explanation of what the option is for.
# 2. Explain what values it can be overriden to.
# 3. Set the default value with `?=` (i.e., "set if not already set") such that values
# set in `options.local.mk` or passed in via the environment are not clobbered.
# Include local overrides to options.
# You can use this file to configure your Devstack. It is ignored by git.
-include options.local.mk # Prefix with hyphen to tolerate absence of file.
# Folder in which we looks for repositories.
# Defaults to parent of this repository.
DEVSTACK_WORKSPACE ?= $(shell pwd)/..
# Open edX named release branch (omitting open-release/ prefix).
# For example, `hawthorn.master` or `zebrawood.rc1`.
# By deafult, this value is undefined (it's only listed here as documentation).
# If it is defined in options.local.mk or the environment, then Devstack will try
# to use the Docker images and Git repo branches that correspond to that release.
# If the release does not exist, you will see errors.
# OPENEDX_RELEASE ?=
# Name of Docker Compose project.
# Volumes and network are namespaced based on this value,
# so changing it will give you a separate set of databases.
# See https://docs.docker.com/compose/reference/envvars/#compose_project_name
# If OPENEDX_RELAESE is defined, defaults to `devstack-${OPENEDX_RELEASE}`;
# otherwise, it defaults to `devstack`.
# Be sure to bring down services before changing the value of `COMPOSE_PROJECT_NAME`.
ifdef OPENEDX_RELEASE
COMPOSE_PROJECT_NAME ?= devstack-${OPENEDX_RELEASE}
else
COMPOSE_PROJECT_NAME ?= devstack
endif
# Docker Compse HTTP timeout, in seconds.
# By default, increased so that devstack provisioning does not fail in unstable networks.
COMPOSE_HTTP_TIMEOUT ?= 180
# Whether we should always copy programs to LMS cache upon LMS startup.
# If 'true', then run `make dev.cache-programs` whenever we bring up
# containers.
# Defaults to false. Case-sensitive.
ALWAYS_CACHE_PROGRAMS ?= false
# FileSystem Synchronization Strategy.
# How should we synchronize files between the host machine and the Docker containers?
# Options are 'local-mount', 'nfs', and 'docker-sync'.
# Note that 'local-mount' is the most tested and supported with edX's Devstack
# and 'docker-sync' the least.
FS_SYNC_STRATEGY ?= local-mounts
# Services that are to be pulled, provisioned, run, and checked by default
# when no services are specified manually.
# Should be a subset of $(EDX_SERVICES).
# Separated by plus signs. Listed in alphabetical order for clarity.
# WARNING: You may remove services from this list in order to make Devstack lighter,
# but beware that some services have implicit, undocumented dependencies on
# other ones. For example, Discovery depends on both LMS and Ecommerce being
# provisioned and started in order to provision correctly.
# Tread at your own risk.
# TODO: Re-evaluate this list and consider paring it down to a tighter core.
# The current value was chosen such that it would not change the existing
# Devstack behavior.
DEFAULT_SERVICES ?= \
credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-gradebook+frontend-app-payment+frontend-app-publisher+frontend-app-learning+lms+studio
# All edX services, whether or not they are run by default.
# Separated by plus signs.
# Separated by plus signs. Listed in alphabetical order for clarity.
EDX_SERVICES ?= \
credentials+discovery+ecommerce+edx_notes_api+forum+frontend-app-account+frontend-app-course-authoring+frontend-app-gradebook+frontend-app-learning+frontend-app-library-authoring+frontend-app-payment+frontend-app-program-console+frontend-app-publisher+insights+lms+lms_watcher+registrar+registrar-worker+studio+studio_watcher+xqueue+xqueue_consumer
# Services with database migrations.
# Should be a subset of $(EDX_SERVICES).
# Separated by plus signs. Listed in alphabetical order for clarity.
# Services must provide a Makefile target named: $(service)-update-db
# Note: This list should contain _all_ db-backed services, even if not
# configured to run; the list will be filtered later against $(DEFAULT_SERVICES).
DB_SERVICES ?= \
credentials+discovery+ecommerce+lms+registrar+studio
# Services with static assets to be built.
# Should be a subset of $(EDX_SERVICES).
# Services must provide a Makefile target named: dev.migrate.$(service)
# Separated by plus signs. Listed in alphabetical order for clarity.
# Note: This list should contain _all_ services with static asse to compile ts, even if not
# configured to run; the list will be filtered later against $(DEFAULT_SERVICES).
ASSET_SERVICES ?= \
credentials+discovery+ecommerce+insights+lms+registrar+studio
# All third-party services.
# Separated by plus signs. Listed in alphabetical order for clarity.
THIRD_PARTY_SERVICES ?= \
chrome+coursegraph+devpi+elasticsearch+elasticsearch7+elasticsearch710+firefox+memcached+mongo+mysql+mysql57+redis+namenode+datanode+resourcemanager+nodemanager+sparkmaster+sparkworker+vertica