docs: add available configuration options for rollouts controller. Fixes #1914 #1921
Conversation
Codecov ReportBase: 81.55% // Head: 82.42% // Increases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #1921 +/- ##
==========================================
+ Coverage 81.55% 82.42% +0.86%
==========================================
Files 124 119 -5
Lines 18931 16913 -2018
==========================================
- Hits 15439 13940 -1499
+ Misses 2702 2282 -420
+ Partials 790 691 -99
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
docs/installation.md
Outdated
| rollouts-controller [flags] | ||
| ``` | ||
|
|
||
| ``` |
There was a problem hiding this comment.
I am not sure if it is a good idea to put the following command options in the doc as the content could be staled over time. I think the example in the PR is good enough.
There was a problem hiding this comment.
Yes, you are right. On the negative side, when a new option is added/removed, this section could contain stale information in the future. However, on the other hand, someone can see all available configuration options from docs. If this seems unnecessary I can completely remove this part and only gave an example of changing log format.
By the way, how about writing something like as follows after the example as an alternative
You can list all available cli options for rollouts controller using the following command:
docker run --rm -it quay.io/argoproj/argo-rollouts:v1.2.0 -hThere was a problem hiding this comment.
The alternative looks much better. Please go ahead with the proposed change. Thanks.
There was a problem hiding this comment.
First, thanks for the comments and review 🙂. I changed the docs as we talked but some checks are failing. I guess it is not related to the changes proposed in this pr, or is there actually something I should fix?
hcelaloner
force-pushed
the
docs/add-controller-configuration-options
branch
from
67d3900 to
6d7f3ea
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
docs/installation.md
Outdated
| @@ -26,6 +26,23 @@ This will create a new namespace, `argo-rollouts`, where Argo Rollouts controlle | |||
| You can find released container images of the controller at [Quay.io](https://quay.io/repository/argoproj/argo-rollouts?tab=tags). There are also old releases | |||
| at Dockerhub, but since the introduction of rate limiting, the Argo project has moved to Quay. | |||
|
|
|||
| ### Configuration Options | |||
|
|
|||
| For instance, logging format can be easily set as `json` via passing the following additional command-line argument in Argo Rollouts Controller Deployment: | |||
There was a problem hiding this comment.
| For instance, logging format can be easily set as `json` via passing the following additional command-line argument in Argo Rollouts Controller Deployment: | |
| For instance, logging format can be easily set as `json` via passing the following additional command-line argument in ArgoRollouts controller deployment: |
docs/installation.md
Outdated
| - --logformat=json | ||
| ```` | ||
|
|
||
| You can list all available CLI options for rollouts controller using the following command: |
There was a problem hiding this comment.
| You can list all available CLI options for rollouts controller using the following command: | |
| You can list all the available CLI options for the rollouts controller using the following command: |
|
This PR is stale because it has been open 90 days with no activity. |
hcelaloner
force-pushed
the
docs/add-controller-configuration-options
branch
from
c26e78d to
d49e172
Compare
Refs: argoproj#1914 Signed-off-by: Celal Öner <[email protected]>
hcelaloner
force-pushed
the
docs/add-controller-configuration-options
branch
from
d49e172 to
9e44a75
Compare
|
Kudos, SonarCloud Quality Gate passed!
|
|
Hi everyone, I tried to update the branch and apply all the pr suggestions. Could you review it again when you have time and merge it if it is okay for the project? |
|
Thanks to everyone who helped in the past. I'm closing this pr, it seems that there will be no activity for this pr. |
|
I'm not clear on why this was closed. I definitely could have used this documentation today! |
It seems that docs are not listing available configuration options for the controller, this is a just simple attempt to list options as in ArgoCD Server Configuration Parameters docs.
Refs: #1914
Signed-off-by: Celal Öner [email protected]
Checklist:
"fix(controller): Updates such and such. Fixes #1234".