-
Notifications
You must be signed in to change notification settings - Fork 21
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
README: Installation steps added in README #2
base: main
Are you sure you want to change the base?
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
let's call it 'winter-soldier controller' instead of 'deployment manifest'
config/hibernator.yaml
Outdated
@@ -0,0 +1,36 @@ | |||
apiVersion: pincher.devtron.ai/v1alpha1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Execute the following command to install winter-soldier
- exclusions: | ||
- objectSelector: | ||
name: "" | ||
type: "ro,deployment" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After installing winter-soldier, create your own hibernator-policies, you can refer some example policies we have included in
Added installation steps for winter soldier using kubectl and helm in the readme section.
Added deployment template and hibernator.yaml to the repo.