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

Start with --traefik/--traefik_local option. Closes #2305 #2351

Merged
merged 13 commits into from
Jun 5, 2024

Conversation

agnorance
Copy link

Description

This pull request reworked the --traefik option for a (more or less) production ready setup and also adds a --traefik_local option for users only testing things out (without HTTPS, logs and some more traefik options) using the latest version of Traefik v3.0.

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality).

Checklist

  • I have read and understood the rules about how to Contribute to this project
  • The pull request is for the branch develop
  • A new plugin (analyzer, connector, visualizer, playbook, pivot or ingestor) was added or changed, in which case:
    • I strictly followed the documentation "How to create a Plugin"
    • [] Usage file was updated.
    • Advanced-Usage was updated (in case the plugin provides additional optional configuration).
    • I have dumped the configuration from Django Admin using the dumpplugin command and added it in the project as a data migration. ("How to share a plugin with the community")
    • If a File analyzer was added and it supports a mimetype which is not already supported, you added a sample of that type inside the archive test_files.zip and you added the default tests for that mimetype in test_classes.py.
    • If you created a new analyzer and it is free (does not require any API key), please add it in the FREE_TO_USE_ANALYZERS playbook by following this guide.
    • Check if it could make sense to add that analyzer/connector to other freely available playbooks.
    • I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
    • If the plugin interacts with an external service, I have created an attribute called precisely url that contains this information. This is required for Health Checks.
    • If the plugin requires mocked testing, _monkeypatch() was used in its class to apply the necessary decorators.
    • I have added that raw JSON sample to the MockUpResponse of the _monkeypatch() method. This serves us to provide a valid sample for testing.
  • If external libraries/packages with restrictive licenses were used, they were added in the Legal Notice section.
  • Linters (Black, Flake, Isort) gave 0 errors. If you have correctly installed pre-commit, it does these checks and adjustments on your behalf.
  • I have added tests for the feature/bug I solved (see tests folder). All the tests (new and old ones) gave 0 errors.
  • If changes were made to an existing model/serializer/view, the docs were updated and regenerated (check CONTRIBUTE.md).
  • If the GUI has been modified:
    • I have a provided a screenshot of the result in the PR.
    • I have created new frontend tests for the new component or updated existing ones.
  • After you had submitted the PR, if DeepSource, Django Doctors or other third-party linters have triggered any alerts during the CI checks, I have solved those alerts.

Important Rules

  • If you miss to compile the Checklist properly, your PR won't be reviewed by the maintainers.
  • Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review. After being reviewed and received a "change request", you should explicitly ask for a review again once you have made the requested changes.

Notes

This is my first time creating a pull request for such a project - so please bear with me. I have tried to follow your guidelines as good as possible, but as I changed the initialization I couldn't do much more tests than running it and check if it works. At least I didn't find any related documentation for this kind of contribution. I'll gladly test it more, if there is a way to do it automatically.

Cheers!

Ubuntu and others added 3 commits May 29, 2024 16:38
Copy link
Member

@mlodic mlodic left a comment

Choose a reason for hiding this comment

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

thank you for your PR! :)

@@ -1,36 +1,75 @@
version: '3.8'

services:
Copy link
Member

Choose a reason for hiding this comment

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

would you mind optimizing this docker file?
Ideally I would expect a base traefik.yml override with what is shared between the 2 cases.
Then 2 different traefik_prod.yml and traefix_local.yml with what they need to add from the base.
That would help us a lot in maintaining it over time.

Copy link
Author

Choose a reason for hiding this comment

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

Sure, will do.

Copy link
Author

Choose a reason for hiding this comment

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

Hey @mlodic

I have split the configuration files into traefik.yml, traefik.override.prod.yml and traefik.override.local.yml as you wished...

I'm not sure if there are really benefits like this... but in any other way it's not possible, because for example the command key doesn't get merged, but rather it just takes the values of the last file provided.

Copy link
Author

Choose a reason for hiding this comment

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

And sorry for changing the naming and not squashing... I was in a hurry. I can fix that, if you need me to.

Copy link
Author

@agnorance agnorance May 31, 2024

Choose a reason for hiding this comment

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

Hey @mlodic

I have fixed the naming and squashed the commits - could you please review? No rush, just a friendly heads-up. :)

get-docker.sh Outdated
@@ -0,0 +1,741 @@
#!/bin/sh
Copy link
Member

Choose a reason for hiding this comment

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

which is the role of this script here?

Copy link
Author

Choose a reason for hiding this comment

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

I actually don't know. Is it possible that this gets generated when running the initialize.sh script?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi :)
yes, you're right. It is downloaded in initialize.sh script and never removed.
Can you please remove script from your PR and add an rm to initialize.sh script ?

tysm for pointing out :)

Copy link
Author

Choose a reason for hiding this comment

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

I've added the removal of the script.

I've added it with sudo as it also gets run with sudo - hope that is ok.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thank you! I think you can delete it without sudo as it gets downloaded with the same permission of the user launching curl.

Copy link
Author

Choose a reason for hiding this comment

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

Okai, I'll fix that and maybe the rest I mentioned above. 👍🏻

agnorance and others added 10 commits May 30, 2024 08:53
author David Mihajlovic <david.mihajlovic@protonmail.com> 1716908101 +0200
committer David Mihajlovic <david.mihajlovic@protonmail.com> 1717135119 +0200

add traefik config and options for dev and prod

working config with traefik

finish traefik config prod/dev

add documentation

Vulners#1257 (intelowlproject#2340)

* vulners

* vulners wrapper

* docs

* lesser variables

* migrations

* code quality

* migration

* code

---------

Co-authored-by: g4ze <bhaiyajionline@gmail.com>

bump 6.0.3

updated docs

Bump django-ses from 4.0.0 to 4.1.0 in /requirements (intelowlproject#2342)

Bumps [django-ses](https://github.com/django-ses/django-ses) from 4.0.0 to 4.1.0.
- [Release notes](https://github.com/django-ses/django-ses/releases)
- [Changelog](https://github.com/django-ses/django-ses/blob/main/CHANGES.md)
- [Commits](django-ses/django-ses@v4.0.0...v4.1.0)

---
updated-dependencies:
- dependency-name: django-ses
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

rework prod/local traefik and add deletion of get-docker.sh

split traefik compose into base, prod and local

get-docker.sh deletion without sudo

change traefik compose naming
@mlodic mlodic merged commit 1cd7c42 into intelowlproject:develop Jun 5, 2024
11 checks passed
@mlodic
Copy link
Member

mlodic commented Jun 5, 2024

:)

@agnorance
Copy link
Author

Nice, thank you!

I'll try to follow the project closely and see if I'm able to put some more time in. ;-)

Cheers!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants