Skip to content
This repository was archived by the owner on Aug 1, 2024. It is now read-only.

Commit 3fc1e0c

Browse files
Merge pull request #987 from openedx/iamsobanjaved/native-docker-registrar
feat: modify config for native registrar docker image
2 parents 3e8bfee + 177c4fc commit 3fc1e0c

5 files changed

Lines changed: 85 additions & 11 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -435,7 +435,7 @@ dev.shell.ecommerce:
435435
docker-compose exec ecommerce env TERM=$(TERM) /edx/app/ecommerce/devstack.sh open
436436

437437
dev.shell.registrar:
438-
docker-compose exec registrar env TERM=$(TERM) /edx/app/registrar/devstack.sh open
438+
docker-compose exec registrar env TERM=$(TERM) /bin/bash
439439

440440
dev.shell.xqueue:
441441
docker-compose exec xqueue env TERM=$(TERM) /edx/app/xqueue/devstack.sh open

configuration_files/registrar.yml

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
API_ROOT: http://localhost:18734/api
2+
BACKEND_SERVICE_EDX_OAUTH2_KEY: registrar-backend-service-key
3+
BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL: http://localhost:18000/oauth2
4+
BACKEND_SERVICE_EDX_OAUTH2_SECRET: registrar-backend-service-secret
5+
CACHES:
6+
default:
7+
BACKEND: django.core.cache.backends.memcached.MemcachedCache
8+
KEY_PREFIX: registrar
9+
LOCATION:
10+
- edx.devstack.memcached:11211
11+
CELERY_ALWAYS_EAGER: false
12+
CELERY_BROKER_HOSTNAME: ''
13+
CELERY_BROKER_PASSWORD: ''
14+
CELERY_BROKER_TRANSPORT: ''
15+
CELERY_BROKER_USER: ''
16+
CELERY_BROKER_VHOST: ''
17+
CELERY_DEFAULT_EXCHANGE: registrar
18+
CELERY_DEFAULT_QUEUE: registrar.default
19+
CELERY_DEFAULT_ROUTING_KEY: registrar
20+
CERTIFICATE_LANGUAGES:
21+
en: English
22+
es_419: Spanish
23+
CORS_ORIGIN_WHITELIST: []
24+
CSRF_COOKIE_SECURE: false
25+
CSRF_TRUSTED_ORIGINS: []
26+
DATABASES:
27+
default:
28+
ATOMIC_REQUESTS: false
29+
CONN_MAX_AGE: 60
30+
ENGINE: django.db.backends.mysql
31+
HOST: edx.devstack.mysql
32+
NAME: registrar
33+
OPTIONS:
34+
connect_timeout: 10
35+
init_command: SET sql_mode='STRICT_TRANS_TABLES'
36+
PASSWORD: password
37+
PORT: '3306'
38+
USER: registrar001
39+
DISCOVERY_BASE_URL: null
40+
EDX_DRF_EXTENSIONS:
41+
OAUTH2_USER_INFO_URL: http://edx.devstack.lms:18000/oauth2/user_info
42+
EXTRA_APPS: []
43+
JWT_AUTH:
44+
JWT_AUTH_COOKIE_HEADER_PAYLOAD: edx-jwt-cookie-header-payload
45+
JWT_AUTH_COOKIE_SIGNATURE: edx-jwt-cookie-signature
46+
JWT_ISSUERS:
47+
- AUDIENCE: lms-key
48+
ISSUER: http://localhost:18000/oauth2
49+
SECRET_KEY: lms-secret
50+
JWT_PUBLIC_SIGNING_JWK_SET: ''
51+
LANGUAGE_CODE: en
52+
LANGUAGE_COOKIE_NAME: openedx-language-preference
53+
LMS_BASE_URL: null
54+
MEDIA_STORAGE_BACKEND:
55+
DEFAULT_FILE_STORAGE: django.core.files.storage.FileSystemStorage
56+
MEDIA_ROOT: /edx/var/registrar/media
57+
MEDIA_URL: /api/media/
58+
REGISTRAR_SERVICE_USER: registrar_service_user
59+
SECRET_KEY: hBiEM5pDr8GsZv1lh6GKmD0c9SF5Z00TFEoRY1zSmCxijFrR
60+
SEGMENT_KEY: null
61+
SESSION_EXPIRE_AT_BROWSER_CLOSE: false
62+
SOCIAL_AUTH_EDX_OAUTH2_ISSUER: http://127.0.0.1:8000
63+
SOCIAL_AUTH_EDX_OAUTH2_KEY: registrar-sso-key
64+
SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL: http://localhost:18000/logout
65+
SOCIAL_AUTH_EDX_OAUTH2_SECRET: registrar-sso-secret
66+
SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT: http://127.0.0.1:8000
67+
SOCIAL_AUTH_REDIRECT_IS_HTTPS: false
68+
STATICFILES_STORAGE: django.contrib.staticfiles.storage.StaticFilesStorage
69+
STATIC_ROOT: /edx/var/registrar/staticfiles
70+
TIME_ZONE: UTC

docker-compose-host.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,10 @@ services:
3737
- ${DEVSTACK_WORKSPACE}/src:/edx/src
3838
registrar:
3939
volumes:
40-
- ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar/registrar
40+
- ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar
4141
registrar-worker:
4242
volumes:
43-
- ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar/registrar
43+
- ${DEVSTACK_WORKSPACE}/registrar:/edx/app/registrar
4444
studio:
4545
volumes:
4646
- ${DEVSTACK_WORKSPACE}/edx-platform:/edx/app/edxapp/edx-platform

docker-compose.yml

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -527,7 +527,7 @@ services:
527527
- ${PWD}/configuration_files/analytics_api.yml:/edx/etc/analytics_api.yml
528528

529529
registrar:
530-
command: bash -c 'source /edx/app/registrar/registrar_env && while true; do python /edx/app/registrar/registrar/manage.py runserver 0.0.0.0:18734; sleep 2; done'
530+
command: bash -c 'while true; do python /edx/app/registrar/manage.py runserver 0.0.0.0:18734; sleep 2; done'
531531
container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.registrar"
532532
hostname: registrar.devstack.edx
533533
depends_on:
@@ -555,7 +555,9 @@ services:
555555
CELERY_BROKER_VHOST: 10
556556
CELERY_BROKER_PASSWORD: password
557557
DJANGO_WATCHMAN_TIMEOUT: 30
558-
image: edxops/registrar:${OPENEDX_RELEASE:-latest}
558+
ANALYTICS_DASHBOARD_CFG: /edx/etc/registrar.yml
559+
image: edxops/registrar-dev:${OPENEDX_RELEASE:-latest}
560+
working_dir: /edx/app/registrar
559561
networks:
560562
default:
561563
aliases:
@@ -564,9 +566,11 @@ services:
564566
- "18734:18734"
565567
volumes:
566568
- /edx/var/registrar/
569+
- ${PWD}/configuration_files/registrar.yml:/edx/etc/registrar.yml
570+
567571

568572
registrar-worker:
569-
command: bash -c 'source /edx/app/registrar/registrar_env && cd /edx/app/registrar/registrar && celery -A registrar worker -l debug -c 2'
573+
command: bash -c 'cd /edx/app/registrar && celery -A registrar worker -l debug -c 2'
570574
container_name: "edx.${COMPOSE_PROJECT_NAME:-devstack}.registrar-worker"
571575
hostname: registrar-worker.devstack.edx
572576
depends_on:
@@ -589,7 +593,7 @@ services:
589593
CELERY_BROKER_VHOST: 10
590594
CELERY_BROKER_PASSWORD: password
591595
DJANGO_WATCHMAN_TIMEOUT: 30
592-
image: edxops/registrar:${OPENEDX_RELEASE:-latest}
596+
image: edxops/registrar-dev:${OPENEDX_RELEASE:-latest}
593597
networks:
594598
default:
595599
aliases:

provision-registrar.sh

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ port=18734
1010
docker-compose up -d $name
1111

1212
echo -e "${GREEN}Installing requirements for ${name}...${NC}"
13-
docker-compose exec -T ${name} bash -e -c 'source /edx/app/registrar/registrar_env && cd /edx/app/registrar/registrar && make requirements' -- "$name"
13+
docker-compose exec -T ${name} bash -e -c 'cd /edx/app/registrar && make requirements' -- "$name"
1414

1515
echo -e "${GREEN}Running migrations for ${name}...${NC}"
16-
docker-compose exec -T ${name} bash -e -c 'source /edx/app/registrar/registrar_env && cd /edx/app/registrar/registrar && make migrate' -- "$name"
16+
docker-compose exec -T ${name} bash -e -c 'cd /edx/app/registrar && make migrate' -- "$name"
1717

1818
echo -e "${GREEN}Creating super-user for ${name}...${NC}"
19-
docker-compose exec -T ${name} bash -e -c 'source /edx/app/registrar/registrar_env && cd /edx/app/registrar/registrar && make createsuperuser' -- "$name"
19+
docker-compose exec -T ${name} bash -e -c 'cd /edx/app/registrar && make createsuperuser' -- "$name"
2020

2121
./provision-ida-user.sh ${name} ${name} ${port}
2222

2323
# Compile static assets last since they are absolutely necessary for all services. This will allow developers to get
2424
# started if they do not care about static assets
2525
echo -e "${GREEN}Compiling static assets for ${name}...${NC}"
26-
docker-compose exec -T ${name} bash -e -c ' if ! source /edx/app/registrar/registrar_env && cd /edx/app/registrar/registrar && make static 2>registrar_make_static.err; then echo "------- Last 100 lines of stderr"; tail regsitrar_make_static.err -n 100; echo "-------"; fi;' -- "$name"
26+
docker-compose exec -T ${name} bash -e -c ' if ! cd /edx/app/registrar && make static 2>registrar_make_static.err; then echo "------- Last 100 lines of stderr"; tail regsitrar_make_static.err -n 100; echo "-------"; fi;' -- "$name"

0 commit comments

Comments
 (0)