Skip to content
This repository has been archived by the owner on Jul 11, 2023. It is now read-only.

design doc: Per Service Filter Chains #2858

Closed
9 tasks
draychev opened this issue Mar 15, 2021 · 2 comments
Closed
9 tasks

design doc: Per Service Filter Chains #2858

draychev opened this issue Mar 15, 2021 · 2 comments
Assignees
Labels
area/documentation work items associated with the improvements or additions to documentation
Milestone

Comments

@draychev
Copy link
Contributor

With #1725 we implemented filter chain per outbound service.

This GitHub issue is for documenting the the OSM documentation around per-service filterchains.

  • Document filterchoin per outbound service -- since this is not a standalone feature - we need to also as port of this issue find the best place for this. Not sure whether this belongs to a design doc or as part of on existing doc around SMI policy (Traffic Target? TCP Route?)

  • Create a small demo with sample apps and SMI showing how this feature works

    • What are the SMI policies that affect this feature? What causes OSM to create these filter chains?
    • Give examples of Envoy configuration with and without these filterchains.
  • List Common Issues

    • Are there known issues that may arise from this design?
    • What happens if pods on the cluster churn quickly?
  • Create Troubleshooting Guide - what tools and techniques could be used to troubleshoot this? Can we use OSM CLI to fetch Envoy config and observe JSON then compare w/ actual Kubernetes context/services/endpoints?

  • Automate Troubleshooting Guide in pkg/troubleshooter (create appropriate functions) - alternatively create a GitHub Issue with the stub of the function that could be eventually created within pkg/troubleshooter package to automatically troubleshoot this feature.

@draychev draychev added area/documentation work items associated with the improvements or additions to documentation priority/P0 P0 priority labels Mar 15, 2021
@draychev draychev changed the title doc: Per Service Filterchain doc: Per Service Filter Chains Mar 15, 2021
@draychev draychev added this to the v0.10.0 milestone May 21, 2021
@shashankram
Copy link
Member

If we document this, kindly drop this in a design doc instead of user-facing docs. User's don't care about knowing the internals of Envoy configurations which can get quite complex based on configurations.

@bridgetkromhout bridgetkromhout changed the title doc: Per Service Filter Chains design doc: Per Service Filter Chains May 21, 2021
@draychev draychev mentioned this issue May 27, 2021
30 tasks
@draychev draychev removed this from the v0.10.0 milestone Jun 28, 2021
@draychev draychev removed priority/P0 P0 priority size/M 7 days (~1.5 week) labels Jun 28, 2021
@draychev draychev added this to the v0.10.0 milestone Jun 28, 2021
@eduser25
Copy link
Contributor

We'll look forward to move it into docs if needed
https://docs.google.com/document/d/1LD0Ntc3arh2EJNoB8wCCmtIK0oSAqI2dYx8bZZDNtZg/edit

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area/documentation work items associated with the improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants