Create kube-timer-instruction.md #2
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Can we replace the content in README.md instead of creating a new doc? |
nilo19
reviewed
Jul 4, 2022
| ## Parameters of kube-timer | ||
| | Parameter | Description | | ||
| | --------- | ------------- | | ||
| | -f | The yaml file for resources provision | |
There was a problem hiding this comment.
Can we specify which ones are required flags?
nilo19
reviewed
Jul 4, 2022
| You could run the below command in the terminal to install kube-timer tool. | ||
|
|
||
| ```shell | ||
| go install github.com/nilo19/kube-timer |
nilo19
reviewed
Jul 4, 2022
|
|
||
| This articles provides the instructions about how get the provision/deletion time of kubernetes resources. It contains the installtion steps, description of parameters and samples outputs. | ||
|
|
||
| ## How to install kube-timer |
nilo19
reviewed
Jul 4, 2022
|
|
||
| # Use kube-timer to get the provision/deletion time of kubernetes resources | ||
|
|
||
| This articles provides the instructions about how get the provision/deletion time of kubernetes resources. It contains the installtion steps, description of parameters and samples outputs. |
There was a problem hiding this comment.
Can we make it: "kube-time is a xxxxx"
nilo19
reviewed
Jul 4, 2022
Comment on lines
+26
to
+33
| | -c | The number of resource | | ||
| | -a | Create all the resources together and wait for the previous resouces to be ready. The time of single resource creation would contain waiting in queue time. Without this parameter, the resources are created one by one; the next resource will only be created once the previous one is ready.| | ||
| | -d | Delete the resource | | ||
| | -n | Name of the resource to be leleted | | ||
| | -D | Delete all the resources together | | ||
| | --started-event-reason | The reason of event. It can be used as the start time of provision/deletion | | ||
| | --finished-event-reason | The reason of event. It can be used as the end time of provision/deletion | | ||
| | --namespace | The namespace of resources | |
There was a problem hiding this comment.
Currently, these only work for service.
nilo19
reviewed
Jul 4, 2022
|
|
||
| #### Do not contain waiting-in-queue time | ||
|
|
||
| As we do not specify `-a`, all the services will be created one by one. The next service is only be created once the previous one is ready. |
There was a problem hiding this comment.
This is the behavior of the cloud provider azure, we shouldn't assume all providers work like that.
nilo19
reviewed
Jul 4, 2022
| 2. Sample YAML definition: | ||
|
|
||
| ```yml | ||
| kind: Service |
There was a problem hiding this comment.
Can we prettify the yaml by removing redundant comments?
There was a problem hiding this comment.
Can we address that the generateName is needed?
nilo19
reviewed
Jul 4, 2022
| ``` | ||
|
|
||
| 4.Sample output: | ||
|  |
nilo19
reviewed
Jul 4, 2022
|  | ||
|
|
||
|
|
||
| #### Contains waiting-in-queue time |
There was a problem hiding this comment.
Again, we need to put it clear that this behavior varies from each cloud provider.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.