Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow runtime configuration of nginx listening port #3219

Merged
merged 1 commit into from
Oct 19, 2023

Conversation

sarayourfriend
Copy link
Collaborator

@sarayourfriend sarayourfriend commented Oct 18, 2023

Fixes

Related to https://github.com/WordPress/openverse-infrastructure/pull/648

Description

ECS FARGATE requires that container and host ports match on a container definition. In the related PR we tried to map Nuxt to a different host port, in order to allow Nginx to listen on 8443 so that the target group port doesn't need to change. We did that by juggling the host ports, but we can't have different host and container ports. Nuxt lets you override the port by passing -p, but we need to enable runtime configuration of the Nginx port by using an environment variable.

The net change in this PR is that you should be able to pass OPENVERSE_NGINX_LISTEN_PORT environment variable to the container and have Nginx listen on a port other than 8080. Proof that it works is in the fact that it still listens to 8080 now, as that is set as the default for that variable in the container build.

Testing Instructions

Run just build frontend_nginx && just frontend/up and confirm you can still access the frontend_nginx service at localhost:50290. You also need to run the frontend locally on port 8443 using just frontend/dev

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • [N/A] I added or updated tests for the changes I made (if applicable).
  • [N/A] I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • [N/A] I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@sarayourfriend sarayourfriend added 🟨 priority: medium Not blocking but should be addressed soon 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🧱 stack: frontend Related to the Nuxt frontend 🧱 stack: infra Related to the Terraform config and other infrastructure labels Oct 18, 2023
@sarayourfriend sarayourfriend requested a review from a team as a code owner October 18, 2023 02:22
@github-actions
Copy link

Size Change: 0 B

Total Size: 934 kB

ℹ️ View Unchanged
Filename Size
./frontend/.nuxt/dist/client/241.js 343 B
./frontend/.nuxt/dist/client/241.modern.js 346 B
./frontend/.nuxt/dist/client/242.js 1.85 kB
./frontend/.nuxt/dist/client/app.js 124 kB
./frontend/.nuxt/dist/client/app.modern.js 115 kB
./frontend/.nuxt/dist/client/commons/app.js 90 kB
./frontend/.nuxt/dist/client/commons/app.modern.js 81 kB
./frontend/.nuxt/dist/client/commons/components/v-error-section/components/v-external-search-form/components/v-external-source-li/e4094511.js 5.18 kB
./frontend/.nuxt/dist/client/commons/components/v-error-section/components/v-external-search-form/components/v-external-source-li/e4094511.modern.js 5.62 kB
./frontend/.nuxt/dist/client/components/loading-icon.js 729 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 735 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 515 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 6.82 kB
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 6.63 kB
./frontend/.nuxt/dist/client/components/v-audio-collection.js 4.51 kB
./frontend/.nuxt/dist/client/components/v-audio-collection.modern.js 4.38 kB
./frontend/.nuxt/dist/client/components/v-audio-control.js 1.51 kB
./frontend/.nuxt/dist/client/components/v-audio-control.modern.js 1.5 kB
./frontend/.nuxt/dist/client/components/v-audio-list.js 1.44 kB
./frontend/.nuxt/dist/client/components/v-audio-list.modern.js 1.42 kB
./frontend/.nuxt/dist/client/components/v-audio-result.js 1.12 kB
./frontend/.nuxt/dist/client/components/v-audio-result.modern.js 1.1 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 959 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 961 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.71 kB
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.66 kB
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 636 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 642 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 636 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.35 kB
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.35 kB
./frontend/.nuxt/dist/client/components/v-collection-header.js 1.31 kB
./frontend/.nuxt/dist/client/components/v-collection-header.modern.js 1.31 kB
./frontend/.nuxt/dist/client/components/v-content-link.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-page.js 530 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 534 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 492 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 496 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.79 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB
./frontend/.nuxt/dist/client/components/v-copy-button.js 3.99 kB
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.34 kB
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.31 kB
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 795 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.51 kB
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.47 kB
./frontend/.nuxt/dist/client/components/v-error-section.js 5.2 kB
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 4.57 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.js 4.1 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 3.43 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.js 2.63 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 1.99 kB
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.57 kB
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.57 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.53 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.53 kB
./frontend/.nuxt/dist/client/components/v-hide-button.js 577 B
./frontend/.nuxt/dist/client/components/v-hide-button.modern.js 573 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.28 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.26 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.82 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.79 kB
./frontend/.nuxt/dist/client/components/v-image-cell.js 2.24 kB
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 2.23 kB
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.51 kB
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.38 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 643 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B
./frontend/.nuxt/dist/client/components/v-load-more.js 1.18 kB
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-media-details.js 5.81 kB
./frontend/.nuxt/dist/client/components/v-media-details.modern.js 5.65 kB
./frontend/.nuxt/dist/client/components/v-media-license.js 931 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 940 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 3 kB
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.97 kB
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 B
./frontend/.nuxt/dist/client/components/v-media-tags.js 830 B
./frontend/.nuxt/dist/client/components/v-media-tags.modern.js 823 B
./frontend/.nuxt/dist/client/components/v-metadata-value.js 587 B
./frontend/.nuxt/dist/client/components/v-metadata-value.modern.js 593 B
./frontend/.nuxt/dist/client/components/v-metadata.js 1.3 kB
./frontend/.nuxt/dist/client/components/v-metadata.modern.js 1.31 kB
./frontend/.nuxt/dist/client/components/v-modal.js 980 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 973 B
./frontend/.nuxt/dist/client/components/v-no-results.js 2.67 kB
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 2.03 kB
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.01 kB
./frontend/.nuxt/dist/client/components/v-related-audio.js 824 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 742 B
./frontend/.nuxt/dist/client/components/v-related-audio/pages/search/audio.js 4.51 kB
./frontend/.nuxt/dist/client/components/v-related-audio/pages/search/audio.modern.js 4.38 kB
./frontend/.nuxt/dist/client/components/v-related-images.js 803 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 720 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.72 kB
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.72 kB
./frontend/.nuxt/dist/client/components/v-safety-wall.js 1.44 kB
./frontend/.nuxt/dist/client/components/v-safety-wall.modern.js 1.44 kB
./frontend/.nuxt/dist/client/components/v-scroll-button.js 892 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 891 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 617 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 620 B
./frontend/.nuxt/dist/client/components/v-single-result-controls.js 1.17 kB
./frontend/.nuxt/dist/client/components/v-single-result-controls.modern.js 1.17 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 915 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.7 kB
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.7 kB
./frontend/.nuxt/dist/client/components/v-tag.js 411 B
./frontend/.nuxt/dist/client/components/v-tag.modern.js 415 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B
./frontend/.nuxt/dist/client/pages/about.js 1.42 kB
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 17.4 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 16.3 kB
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.js 15.7 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 14.7 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.js 4.96 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.73 kB
./frontend/.nuxt/dist/client/pages/index.js 6.38 kB
./frontend/.nuxt/dist/client/pages/index.modern.js 6.35 kB
./frontend/.nuxt/dist/client/pages/preferences.js 1.47 kB
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.46 kB
./frontend/.nuxt/dist/client/pages/privacy.js 1.26 kB
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.26 kB
./frontend/.nuxt/dist/client/pages/search-help.js 1.62 kB
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB
./frontend/.nuxt/dist/client/pages/search.js 5.78 kB
./frontend/.nuxt/dist/client/pages/search.modern.js 8.13 kB
./frontend/.nuxt/dist/client/pages/search/audio.js 499 B
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 503 B
./frontend/.nuxt/dist/client/pages/search/image.js 453 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 455 B
./frontend/.nuxt/dist/client/pages/search/index.js 313 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 320 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 244 B
./frontend/.nuxt/dist/client/pages/sensitive-content.js 1.53 kB
./frontend/.nuxt/dist/client/pages/sensitive-content.modern.js 1.53 kB
./frontend/.nuxt/dist/client/pages/sources.js 1.54 kB
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB
./frontend/.nuxt/dist/client/runtime.js 2.79 kB
./frontend/.nuxt/dist/client/runtime.modern.js 2.79 kB
./frontend/.nuxt/dist/client/vendors/app.js 68.3 kB
./frontend/.nuxt/dist/client/vendors/app.modern.js 68.1 kB

compressed-size-action

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

I tried changing the port from 8080 to something else locally, and saw that docker-compose.yaml port needs to change, too:

- "50290:8080"

Can we set the env variable on the parent directory? Or do we need to add documentation saying that the port needs to be updated if the env variable inside frontend/ directory is set to something different than 8080?

@obulat obulat requested a review from dhruvkb October 18, 2023 07:10
@sarayourfriend
Copy link
Collaborator Author

sarayourfriend commented Oct 18, 2023

Can we set the env variable on the parent directory? Or do we need to add documentation saying that the port needs to be updated if the env variable inside frontend/ directory is set to something different than 8080?

We can, but it's just support for testing a feature that shouldn't need to be tested after this. I guess if we want it to be an end-to-end test, we can set the variable in docker-compose.yml. What is your suggested change?

@obulat
Copy link
Contributor

obulat commented Oct 19, 2023

Can we set the env variable on the parent directory? Or do we need to add documentation saying that the port needs to be updated if the env variable inside frontend/ directory is set to something different than 8080?

We can, but it's just support for testing a feature that shouldn't need to be tested after this. I guess if we want it to be an end-to-end test, we can set the variable in docker-compose.yml. What is your suggested change?

I guess we will not change the 8080 locally anyways, so I'm going to approve this PR. I'm not sure if we should add a comment in docker-compose saying that 8080 can be changed using an environment variable in the frontend/.env.

Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

LGTM!

@obulat obulat merged commit 93b64b5 into main Oct 19, 2023
71 checks passed
@obulat obulat deleted the add/match-frontend-nginx-ports branch October 19, 2023 07:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend 🧱 stack: infra Related to the Terraform config and other infrastructure
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants