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

feature: Allow installing extra requirements when using the credentials role - #169

Merged
kewne merged 1 commit into
opencraft-release/koa.3from
joaocabrita/bb_4342-credentials_extra_requirements_koa
Jun 25, 2021
Merged

feature: Allow installing extra requirements when using the credentials role#169
kewne merged 1 commit into
opencraft-release/koa.3from
joaocabrita/bb_4342-credentials_extra_requirements_koa

Conversation

@kewne

@kewne kewne commented Jun 25, 2021

Copy link
Copy Markdown

This makes the credentials role support the use of edx_django_service_extra_requirements
as done originally in !6400

The changes here are cherry-picked from the upstream work in https://github.com/edx/configuration/pull/6449

Related links:

Testing

  1. Launch devstack with credentials service: make dev.up.credentials
  2. In the configuration repo, create a docker_inventory.ini file containing just
credentials ansible_connection=docker ansible_host=edx.devstack.credentials
  1. Create a playbook credentials_test.yml:
- name: Deploy edX Credentials Service
  hosts: all
  become: True
  gather_facts: True
  vars:
    ENABLE_DATADOG: False
    ENABLE_NEWRELIC: False
    CLUSTER_NAME: 'credentials'
  roles:
    - credentials
  1. Run the playbook from the playbooks directory (to ensure ansible.cfg is picked up): ansible-playbook credentials_test.yml -i docker_inventory.ini --skip-tags install:code -e '{ disable_edx_services: true, CREDENTIALS_EXTRA_REQUIREMENTS: [{name: 'lolcat'}], edx_django_service_is_devstack: true}'
  2. Assert lolcat is now installed in the credentials virtualenv:
make dev.shell.credentials
source /edx/app/credentials/venvs/credentials/bin/activate
echo test | lolcat 

…als` role.

This makes the `credentials` role support the use of `edx_django_service_extra_requirements`
as done originally in [!6400](https://github.com/edx/configuration/pull/6400)

Related tickets:
* [BB-4342](https://tasks.opencraft.com/browse/BB-4342)
@kewne
kewne requested a review from lgp171188 June 25, 2021 08:23
@kewne kewne self-assigned this Jun 25, 2021

@lgp171188 lgp171188 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

  • I did not test this, as it is a straightforward change that is similar to the changes done before for the ecommerce and course-discovery services.
  • I read through the code
  • I checked for accessibility issues NA
  • Includes documentation NA

@kewne
kewne merged commit 7ce36c7 into opencraft-release/koa.3 Jun 25, 2021
@kewne
kewne deleted the joaocabrita/bb_4342-credentials_extra_requirements_koa branch June 25, 2021 15:36
@pomegranited

Copy link
Copy Markdown

@kewne Could you update this PR description to link to your upstream PR? Helps us during major version updates to track what's "code drift" vs what's been merged upstream.

@kewne

kewne commented Jun 30, 2021

Copy link
Copy Markdown
Author

@pomegranited Done, thanks for the nudge.

samuelallan72 pushed a commit that referenced this pull request Oct 11, 2021
…ls_extra_requirements_koa

feature: Allow installing extra requirements when using the `credentials` role
(cherry picked from commit 7ce36c7)
samuelallan72 pushed a commit that referenced this pull request Oct 19, 2021
…ls_extra_requirements_koa

feature: Allow installing extra requirements when using the `credentials` role
(cherry picked from commit 7ce36c7)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants