Dry Run feature for k8s

[CodeWithEmad]

The proposed dry run command for tutor would significantly enhance the deployment process by allowing users to preview the changes to the Open edX configuration before actually applying them to the Kubernetes cluster. This would help identify potential issues and avoid unintended disruptions in the live environment, ensuring a smoother deployment experience.
A subcommand of k8s, like :

tutor k8s dry  # I'm not sure about the naming

If there are no objections, I'll be happy to implement this.

[DawoudSheraz]

@CodeWithEmad Hi. Can you give some examples and context on what this would achieve or help with? Thanks

[CodeWithEmad]

Hey @DawoudSheraz. It can:

• Preview configuration changes before applying them.
• Identify potential conflicts or errors in advance.
• Reduce the risk of unexpected issues in the live environment.
• Save time by catching problems early in the deployment process.

This feature would be especially valuable for complex setups or when making significant changes to the Open edX configuration.

[DawoudSheraz]

Hey @DawoudSheraz. It can:

• Preview configuration changes before applying them.
• Identify potential conflicts or errors in advance.
• Reduce the risk of unexpected issues in the live environment.
• Save time by catching problems early in the deployment process.

This feature would be especially valuable for complex setups or when making significant changes to the Open edX configuration.

Right. Will it be a wrapper to k8s dry run commands? Anyway, I get the potential use cases for this. Thanks for suggesting this.
@regisb What are your thoughts?

[CodeWithEmad]

Will it be a wrapper to k8s dry run commands?

Yes, it will be a wrapper around kubectl apply --dry-run.

[regisb]

You mean, like make test-k8s or tutor k8s apply --dry-run=client --validate=true? Tutor already provides an API for kubectl apply. Maybe all we need is better documentation on this feature?

[DawoudSheraz]

You mean, like make test-k8s or tutor k8s apply --dry-run=client --validate=true? Tutor already provides an API for kubectl apply. Maybe all we need is better documentation on this feature?

Ah, nice. make test-* inherently implies we are running some sort of tests (at least in Open edX ecosystem). I agree that documenting it differently can make it more visible.

[CodeWithEmad]

And now I feel dumb :D
I didn't know about the tutor k8s apply command. I'll close this one and will come up with some changes in the docs.