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

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

Merged
pomegranited merged 1 commit into
openedx-unsupported:masterfrom
open-craft:joaocabrita/bb_4342-credentials_extra_requirements
Jul 5, 2021
Merged

feature: Allow installing extra requirements when using the credentials role#6449
pomegranited merged 1 commit into
openedx-unsupported:masterfrom
open-craft:joaocabrita/bb_4342-credentials_extra_requirements

Conversation

@kewne

@kewne kewne commented Jun 17, 2021

Copy link
Copy Markdown
Contributor

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

The end-goal of this is to support theming of the credentials service as described here

Related tickets:

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 

@openedx-webhooks

openedx-webhooks commented Jun 17, 2021

Copy link
Copy Markdown

Thanks for the pull request, @kewne! I've created OSPR-5867 to keep track of it in JIRA, where we prioritize reviews. Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed open-source-contribution PR author is not from Axim or 2U labels Jun 17, 2021
@natabene

Copy link
Copy Markdown
Contributor

@kewne Thank you for your contribution. Please let me know once it is ready for our review.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 22, 2021
@kewne
kewne marked this pull request as ready for review June 22, 2021 11:33
@openedx-webhooks openedx-webhooks added needs triage waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. needs triage labels Jun 22, 2021
@kewne
kewne force-pushed the joaocabrita/bb_4342-credentials_extra_requirements branch from fc15d1f to 5775df3 Compare June 25, 2021 08:17

@lgp171188 lgp171188 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@kewne, 👍. Before the edX/core committer review, can you edit the description of this PR to mention that this is going to be used to install a theme in the credentials service as documented here?

@lgp171188

Copy link
Copy Markdown
Contributor

@natabene, this is now ready for edX/core committer review. The workflows configured for PRs in this repository haven't run for this PR, and there is a message that says First-time contributors need a maintainer to approve running workflows.. So can you approve running the workflows for this PR?

@pomegranited, will you be able to review this PR as a core committer since you reviewed the very similar https://github.com/edx/configuration/pull/6400? Thanks!

@kewne

kewne commented Jun 25, 2021

Copy link
Copy Markdown
Contributor Author

@lgp171188

can you edit the description of this PR

Done, thanks!

@pomegranited pomegranited self-assigned this Jun 30, 2021
@pomegranited
pomegranited self-requested a review June 30, 2021 06:27
@pomegranited pomegranited added core committer and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Jun 30, 2021
@pomegranited

Copy link
Copy Markdown
Contributor

👍 Works perfectly, thank you @kewne !

  • I tested this using the beautiful PR test instructions, which made it quick and easy to verify.
  • I read through the code
  • I checked for accessibility issues N/A
  • Includes documentation -- and thanks for updating the PR description with the purpose of this change!
  • Commit structure follows OEP-0051 -- close enough 😄
    @kewne Technically, you should have used the prefix feat:, not feature: cf OEP-0051: Conventional Commits#Type.

I'll merge this in 2 days if there are no objections from @edx/devops .

@kewne

kewne commented Jun 30, 2021

Copy link
Copy Markdown
Contributor Author

@pomegranited oops! I can amend this to match the expected format, it's not too much trouble.

@pomegranited

Copy link
Copy Markdown
Contributor

Sure if you want to @kewne :)

…` 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 force-pushed the joaocabrita/bb_4342-credentials_extra_requirements branch from 5775df3 to e2afa0d Compare June 30, 2021 14:35
@openedx-webhooks openedx-webhooks added waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. and removed core committer labels Jun 30, 2021

@pomegranited pomegranited left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Approved, see previous comment 👍

@pomegranited
pomegranited merged commit b0f7e53 into openedx-unsupported:master Jul 5, 2021
@openedx-webhooks

Copy link
Copy Markdown

@kewne 🎉 Your pull request was merged!

Please take a moment to answer a two question survey so we can improve your experience in the future.

@pomegranited
pomegranited deleted the joaocabrita/bb_4342-credentials_extra_requirements branch July 5, 2021 00:32
@openedx-webhooks openedx-webhooks added merged and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels Jul 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

merged open-source-contribution PR author is not from Axim or 2U

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants