Multi cluster doc improve #533
Conversation
# Conflicts: # hack/toolchain.sh
# Conflicts: # hack/toolchain.sh
- fix broken image link in the doc
…rove # Conflicts: # docs/guides/getstarted.md # docs/guides/multi-sn.md
zijun726911
force-pushed
the
multi-cluster-doc-improve
branch
from
b7a97a0 to
ed548e3
Compare
There was a problem hiding this comment.
Need to make it crisp(er). Documents describes "How" to setup, but does not explain "Why" it's recommended way.
Picture is complicated and mix of different ideas. Different names - "my-hotel", "my-httproute", "service". My-hotel looks foreign (or others?). We should have it clear what are k8s and aws/lattice concepts in picture. May be dont mix them together, if you want them on the same picture try to use layers.
|
I can change "my-hotel" to "my-gateway". The old doc didn't mention why it's recommended. I can add few sentences in the new doc to explain it.
I think the only lattice resource needed in the graph is service network, since its not exactly 1:1 map to the k8s gateway. for other k8s resource I can use k8s icon and word "k8s" to make it clear. Not quite sure how the layers looks like |
docs/guides/multi-cluster.md
Outdated
| - Multiple `HTTPRoute(s)`,`GRPCRoute(s)`, that have rules backendRefs to `ServiceImport(s)` that referring kubernetes application service(s) in workload cluster(s) | ||
|
|
||
|
|
||
| You can see this similar production use case at Airbnb: [airbnb mullti-cluster setup](https://www.youtube.com/watch?v=1D8lg36ZNHs) |
There was a problem hiding this comment.
I think we should remove this, instead we should have good reasons for this recommendation
There was a problem hiding this comment.
Any idea on what good reasons we could say?
zijun726911
force-pushed
the
multi-cluster-doc-improve
branch
from
2ba72eb to
699a38c
Compare
zijun726911
force-pushed
the
multi-cluster-doc-improve
branch
from
28567cf to
a93d35e
Compare
zijun726911
force-pushed
the
multi-cluster-doc-improve
branch
from
657b78a to
5e5f66b
Compare
What type of PR is this? documentation
Which issue does this PR fix: Add new multi cluster doc and diagram to reflect the new controller behaviour, deprecate the outdated description
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.