Skip to content

Conversation

@alexvaque
Copy link

@alexvaque alexvaque commented Feb 21, 2024

Description

about module deactivation in Helmchart the documentation saids that we need to disable module with
module: {}
but must be
module: false

Related Issues

List related issues.

Testing

I deployed in my infrastructure
module: {}

but this did not work

Checklist

  • Does my change need to be backported to a previous release?

    • What backport versions were discussed with the Maintainers in the Issue?
  • I made sure to update CHANGELOG.md.

    Remember, the CHANGELOG needs to mention:

    • Any new features
    • Any changes to our included version of Envoy
    • Any non-backward-compatible changes
    • Any deprecations
  • This is unlikely to impact how Ambassador performs at scale.

    Remember, things that might have an impact at scale include:

    • Any significant changes in memory use that might require adjusting the memory limits
    • Any significant changes in CPU use that might require adjusting the CPU limits
    • Anything that might change how many replicas users should use
    • Changes that impact data-plane latency/scalability
  • My change is adequately tested.

    Remember when considering testing:

    • Your change needs to be specifically covered by tests.
      • Tests need to cover all the states where your change is relevant: for example, if you add a behavior that can be enabled or disabled, you'll need tests that cover the enabled case and tests that cover the disabled case. It's not sufficient just to test with the behavior enabled.
    • You also need to make sure that the entire area being changed has adequate test coverage.
      • If existing tests don't actually cover the entire area being changed, add tests.
      • This applies even for aspects of the area that you're not changing – check the test coverage, and improve it if needed!
    • We should lean on the bulk of code being covered by unit tests, but...
    • ... an end-to-end test should cover the integration points
  • I updated DEVELOPING.md with any any special dev tricks I had to use to work on this code efficiently.

  • The changes in this PR have been reviewed for security concerns and adherence to security best practices.

@alexvaque alexvaque marked this pull request as draft February 21, 2024 14:50
@alexvaque alexvaque marked this pull request as ready for review February 21, 2024 14:52
@alexvaque alexvaque marked this pull request as draft February 21, 2024 14:52
@alexvaque alexvaque force-pushed the documentation_update branch from a70aca0 to 717e250 Compare February 21, 2024 15:01
@alexvaque alexvaque marked this pull request as ready for review February 21, 2024 15:02
@alexvaque
Copy link
Author

Hi @alexgervais or @AliceProxy, I noticed that you are listed as project maintainers.

Could we please merge this README update? It is a basic change in the code comments nothing else

The documentation has been somewhat confusing as it suggests using module: {} for module deactivation using the Helmchart. However, after conducting personal tests, I found that deactivating the module is achieved with module: false.

To prevent further confusion, I have updated the README accordingly.

Thank you.

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.

2 participants