README: Installation steps added in README#2
README: Installation steps added in README#2arushi09-hub wants to merge 11 commits intodevtron-labs:mainfrom
Conversation
README.md
Outdated
|
|
||
| **STEP 2** | ||
|
|
||
| Execute the following command to apply the deployment manifest for installing winter soldier. |
There was a problem hiding this comment.
let's call it 'winter-soldier controller' instead of 'deployment manifest'
| @@ -0,0 +1,36 @@ | |||
| apiVersion: pincher.devtron.ai/v1alpha1 | |||
There was a problem hiding this comment.
Can we include some regular use case hibernator examples? A hibernator named test is not helping people to understand what exactly it does. Some cases to cover:
- weekend hibernator
- night-time hibernator
- temporary deployments (delete after 5 days)
README.md
Outdated
|
|
||
| **STEP 2** | ||
|
|
||
| Execute the following command to apply the winter-soldier controller for installing winter soldier. |
There was a problem hiding this comment.
Execute the following command to install winter-soldier
| - exclusions: | ||
| - objectSelector: | ||
| name: "" | ||
| type: "ro,deployment" |
There was a problem hiding this comment.
use rollout instead of ro so that it is clear to users in all the examples
README.md
Outdated
|
|
||
| You can either use the above template and customize it or create your own. | ||
|
|
||
| **STEP 4** |
There was a problem hiding this comment.
Step 4 doesn't makes any sense, remove it.
README.md
Outdated
|
|
||
| **STEP 3** | ||
|
|
||
| After installing winter soldier, customize or create our own hibernator.yaml template which will contains the included and excluded resources on which winter soldier will be applied. |
There was a problem hiding this comment.
After installing winter-soldier, create your own hibernator-policies, you can refer some example policies we have included in
2 participants
Added installation steps for winter soldier using kubectl and helm in the readme section.
Added deployment template and hibernator.yaml to the repo.