Remote Cluster Management demo ready - willing to contribute/upstream it

[MA3CIN]

Feature Request

The Remote Cluster Management docs could be improved upon. I have created a complete demo of Remote Cluster Management with a guide, scripts and all necessary yaml files. Github link to the demo: https://github.com/MA3CIN/chaos-mesh-remote-cluster-management-demo
The script, when run will:

• Create two multi-node kind k8s clusters,
• Deploy a workload on one of them,
• Install Chaos Mesh on both,
• Create a kubeconfig and adjust it to allow networking between clusters,
• Setup a RemoteCluster object, with the kubeconfig extracted from the external cluster,
• Run a remote Chaos Experiment on the 2nd cluster

I have also created several other chaos experiments, and a teardown script.
I'm willing to upstream/contribute this demo - would you be interested in this contribution?

[MA3CIN]

@STRRL @g1eny0ung @cwen0 Let me know if you'd be interested in this contribution

[g1eny0ung]

@MA3CIN 🤩 That's great! I'm going to take a look first. Your contributions are greatly appreciated. However, to ensure the quality of our documentation, I will need to review your submission before merging it in the future. Thank you for your understanding.

/cc @STRRL @cwen0 @dcalvin

[MA3CIN]

Of course - let me know how i should proceed.

[MA3CIN]

If you do choose to integrate part of this PoC into Chaos Mesh (docs, or anything else) - please let me know and ping me, so i will get notified

[MA3CIN]

I'm closing this issue due to lack of activity.

[g1eny0ung]

I'm sorry about that, @MA3CIN. I overlooked this issue. The National Day holiday in China is recent, and I have just returned to work, so I plan to take a look this weekend.

[g1eny0ung]

If you do choose to integrate part of this PoC into Chaos Mesh (docs, or anything else) - please let me know and ping me, so i will get notified

My thinking is that Chaos Mesh needs this demo document (This document will definitely be merged into the main document, and there's no reason for us to create another tutorial with the same content over and over again.). It's a good example for everyone. I just wanted to verify it for myself before giving some comments.

[MA3CIN]

Happy to hear that, @g1eny0ung
Please tag me when you look into the example that i prepared, and let me know how to proceed, I'll be happy to split it into PR's to be integrated into Chaos-Mesh

[g1eny0ung]

I browsed the README and some shell scripts, especially kind-setup-clusters.sh. If we want to translate them into a document, I see several problems:

1. Too many hidden details in shell scripts, a doc should explicitly show the steps that need to be run and keep them as simple as possible. For example, let users create clusters individually instead of letting them run a script. This won’t help them to make a deeper impression.
2. It's also related to the first problem, the current documentation is missing tutorials (or examples), but this demo doesn't look like a tutorial. If someone doesn't want to run the script, they can't get more details.

So my idea is that I will extract the key steps from this demo to write a document and then refer to this demo you wrote. if users are more interested they can get more details from this demo. What do you think? After I open a PR, I will @ you to review it to ensure accuracy.

[MA3CIN]

Sure, that sounds great - please @ me in the PR, and I'll make sure to review it. Also I'd be happy to help expand on the document in the future

[g1eny0ung]

Sure, that sounds great - please @ me in the PR, and I'll make sure to review it. Also I'd be happy to help expand on the document in the future

That would be great!

[bennavj]

Hi g1eny0ung/MA3CIN, could you please help with #4248. Thanks