From 01dde3d3f98024c0f2e9a230aaee75aad14df828 Mon Sep 17 00:00:00 2001 From: hellouz818 Date: Sun, 8 Sep 2024 17:32:27 +0900 Subject: [PATCH] [Proposal] Add a Istio chaos fault --- proposals/istio.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) create mode 100644 proposals/istio.md diff --git a/proposals/istio.md b/proposals/istio.md new file mode 100644 index 00000000000..522ce3458ad --- /dev/null +++ b/proposals/istio.md @@ -0,0 +1,79 @@ +| title | authors | creation-date | last-updated | +|-------|------------------------------------------|---------------|--------------| +| title | [@hellouz818](https://github.com/hellouz818) | 2024-09-08 | 2024-09-08 | + +# Adding a New Chaos Fault - istio + +This is the title of the enhancement. It should be short, clear, and descriptive. + +- [Summary](#summary) +- [Motivation](#motivation) + - [Goals](#goals) + - [Non-Goals](#non-goals) +- [Proposal](#proposal) + - [Use Cases](#use-cases) + - [Implementation Details](#implementation-details) +- [Risks and Mitigations](#risks-and-mitigations) +- [Upgrade / Downgrade Strategy](#upgrade--downgrade-strategy) +- [Drawbacks](#drawbacks) +- [Alternatives](#alternatives) +- [References](#references) + +## Summary + +The `Summary` section should be a short description of the enhancement. Before you get started this documentation, We recommend that you read the [CONTRIBUTING.md](https://github.com/litmuschaos/litmus/blob/master/CONTRIBUTING.md) and check whether the enhancement you are proposing is already in the [issues](https://github.com/litmuschaos/litmus/issues). + +## Motivation + +This section is for explicitly listing the motivation, goals and non-goals of this proposal. Describe why the change is important and the benefits to users. + +### Goals + +List the specific goals of the proposal. How will we know that this has succeeded? + +### Non-Goals + +What is out of scope for this proposal? Listing non-goals helps to focus discussion and make progress. + +## Proposal + +This is where we get down to the nitty gritty of what the proposal actually is. + +### Use Cases + +Detail the things that people will be able to do if this is `implemented`. + +#### Use case 1 + +#### Use case 2 + +### Implementation Details + +What are the caveats to the implementation? What are some important details that didn't come across above? Go into as much detail as necessary here. This is a good place to discuss core concepts and their relationships. + +If you want to use images, store images in the `proposals/images` directory. + +## Risks and Mitigations + +What are the risks of this proposal and how do we mitigate. Think broadly. For example, consider both `security` and how this will `impact the Litmus ecosystem`. + +## Upgrade / Downgrade Strategy + +If applicable, how will the component be upgraded and downgraded? Make sure this is in the test plan. + +Consider the following in developing an upgrade/downgrade strategy for this enhancement: + +- What changes (in invocations, configurations, API use, etc.) is an existing cluster required to make on upgrade in order to keep previous behavior? +- What changes (in invocations, configurations, API use, etc.) is an existing cluster required to make on upgrade in order to make use of the enhancement? + +## Drawbacks + +The idea is to find the best form of an argument why this enhancement should not be implemented. + +## Alternatives + +Similar to the `Drawbacks` section the `Alternatives` section is used to highlight and record other possible approaches to delivering the value proposed by an enhancement. + +## References + +Is their any reference for this proposal? If yes, please mention here.