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

Enable dynamic modules & high level doc #38295

Merged
merged 26 commits into from
Feb 6, 2025

Conversation

mathetake
Copy link
Member

@mathetake mathetake commented Feb 3, 2025

Commit Message: Enable dynamic modules & Add high level doc
Additional Description:

This adds a high level documentation of dynamic_modules feature
that has been developed over the last few months and has finally
become usable for users.

closes #2053
closes #24230
closes #32502

Risk Level: low
Testing: existing ones
Docs Changes: n/a
Release Notes: n/a
Platform Specific Features: n/a

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Copy link

As a reminder, PRs marked as draft will not be automatically assigned reviewers,
or be handled by maintainer-oncall triage.

Please mark your PR as ready when you want it to be reviewed!

🐱

Caused by: #38295 was opened by mathetake.

see: more, trace.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Copy link

CC @envoyproxy/api-shepherds: Your approval is needed for changes made to (api/envoy/|docs/root/api-docs/).
envoyproxy/api-shepherds assignee is @markdroth
CC @envoyproxy/api-watchers: FYI only for changes made to (api/envoy/|docs/root/api-docs/).

🐱

Caused by: #38295 was synchronize by mathetake.

see: more, trace.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
--------------------------

We have a dedicated repository for the dynamic module examples to help you get started.
The repository is available at `envoyproxy/dynamic-modules-examples <https://github.com/envoyproxy/envoyproxy/dynamic-modules-examples>`_
Copy link
Member Author

Choose a reason for hiding this comment

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

note: I chatted with @.phlax offline that using the existing examples repository is not suitable for dynamic modules due to some reasons. The biggest reason is the strict version compatibility requirement makes it impossible to make it part of the CI. For example, when the ABI file gets modified, then the example verify CI will fail indefinitely.

The other reason i personally feel is we want to show users that they don't need the envoy specific build settings like bazel etc to build modules and instead they can simply use the standard language tooling (at this point cargo/rustc). The new repository comes with bazel just in case to be alined with Envoy main repo settings, but will also be used as a standalone example repo with native toolchains.

The repository is here https://github.com/envoyproxy/dynamic-modules-examples - i will work on it after this gets merged and the build image becomes available

Copy link
Member Author

Choose a reason for hiding this comment

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

Suggested change
The repository is available at `envoyproxy/dynamic-modules-examples <https://github.com/envoyproxy/envoyproxy/dynamic-modules-examples>`_
The repository is available at `envoyproxy/dynamic-modules-examples <https://github.com/envoyproxy/dynamic-modules-examples>`_

@mathetake mathetake marked this pull request as ready for review February 4, 2025 22:28
@mathetake
Copy link
Member Author

/assign @phlax
/assign @mattklein123

@mathetake
Copy link
Member Author

/retest

@phlax
Copy link
Member

phlax commented Feb 5, 2025

/docs

Copy link

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/38295/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: a #38295 (comment) was created by @phlax.

see: more, trace.

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

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

great! thanks for all your hard work on this @mathetake

mathetake and others added 10 commits February 5, 2025 09:40
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Co-authored-by: phlax <phlax@users.noreply.github.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

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

Nice this is amazing!

@repokitteh-read-only repokitteh-read-only bot removed the api label Feb 6, 2025
@mattklein123 mattklein123 merged commit fe58ab1 into envoyproxy:main Feb 6, 2025
25 checks passed
@mathetake mathetake deleted the dynamicmodulesdoc branch February 6, 2025 17:31
phlax pushed a commit that referenced this pull request Feb 6, 2025
docs: adds a release note about dynamic_modules

This is a follow up on #38295 

Signed-off-by: Takeshi Yoneda <t.y.mathetake@gmail.com>
@codefromthecrypt
Copy link
Contributor

PR of the year already?!

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