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

docs: Add section for filtering by subnet tags in ENI mode #15635

Merged

Conversation

christarazi
Copy link
Member

Users frequently ask how to properly filter subnets by tag in ENI mode.
This commit adds a dedicated section to the AWS ENI guide on just that.

Signed-off-by: Chris Tarazi chris@isovalent.com

@christarazi christarazi requested review from a team as code owners April 10, 2021 21:37
@christarazi christarazi added area/eni Impacts ENI based IPAM. area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. kind/enhancement This would improve or streamline existing functionality. release-note/misc This PR makes changes that have no direct user impact. labels Apr 10, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Apr 10, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot removed the dont-merge/needs-release-note-label The author needs to describe the release impact of these changes. label Apr 10, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot added this to In progress in 1.10.0 Apr 10, 2021
Copy link
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

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

One minor nit. I didn't try it out and don't have much AWS background but the example seems like it will be very useful to have around.

Create a `cni-config.yaml` file based on the template below. Fill in the
``subnet-tags`` field:

.. code:: yaml
Copy link
Member

Choose a reason for hiding this comment

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

I think these all need to be code-block, code is rST while code-block is sphinx syntax which allows the sphinx-specific syntax highlighting to work correctly.

Suggested change
.. code:: yaml
.. code-block:: yaml

Documentation/gettingstarted/aws-eni.rst Show resolved Hide resolved
@christarazi christarazi force-pushed the pr/christarazi/update-eks-subnet-tags-docs branch 2 times, most recently from 45093dc to 3e7a74d Compare April 12, 2021 22:12
Users frequently ask how to properly filter subnets by tag in ENI mode.
This commit adds a dedicated section to the AWS ENI guide on just that.

Signed-off-by: Chris Tarazi <chris@isovalent.com>
@christarazi christarazi force-pushed the pr/christarazi/update-eks-subnet-tags-docs branch from 3e7a74d to b4e6ce6 Compare April 12, 2021 22:36
@christarazi
Copy link
Member Author

Marking ready for merge, as we have approvals and the docs build passed.

@christarazi christarazi added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Apr 15, 2021
@qmonnet qmonnet merged commit a571fb6 into cilium:master Apr 15, 2021
1.10.0 automation moved this from In progress to Done Apr 15, 2021
@christarazi christarazi deleted the pr/christarazi/update-eks-subnet-tags-docs branch April 15, 2021 18:24
@maintainer-s-little-helper maintainer-s-little-helper bot added this to Needs backport from master in 1.9.6 Apr 16, 2021
@maintainer-s-little-helper maintainer-s-little-helper bot removed this from Needs backport from master in 1.9.6 Apr 16, 2021
@joestringer
Copy link
Member

Usually we would backport docs fixes like this, but apparently the v1.9 chart doesn't support eni sub-options so we would also need to address that if we were to backport this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. area/eni Impacts ENI based IPAM. kind/enhancement This would improve or streamline existing functionality. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants