Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added the optional parameters section.
  • Loading branch information
Auger Casasnovas authored and lwolf committed May 7, 2019
1 parent b6e9dce commit 54a1c24
Showing 1 changed file with 18 additions and 31 deletions.
49 changes: 18 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,37 +30,6 @@ kubectl logs -f $(kubectl get pods --namespace default -l "run=cleanup-operator"
kubectl create -f https://k8s.io/examples/controllers/job.yaml
```

### Parameters
```
Usage of ./kube-cleanup-operator:
-alsologtostderr
log to standard error as well as files
-dry-run
Print only, do not delete anything.
-keep-failures int
Number of hours to keep faild jobs, -1 - forever (default) 0 - never, >0 number of hours (default -1)
-keep-pending int
Number of hours to keep pending jobs, -1 - forever (default) >0 number of hours (default -1)
-keep-successful int
Number of hours to keep successful jobs, -1 - forever, 0 - never (default), >0 number of hours
-log_backtrace_at value
when logging hits line file:N, emit a stack trace
-log_dir string
If non-empty, write log files in this directory
-logtostderr
log to standard error instead of files
-namespace string
Watch only this namespaces
-run-outside-cluster
Set this flag when running outside of the cluster.
-stderrthreshold value
logs at or above this threshold go to stderr
-v value
log level for V logs
-vmodule value
comma-separated list of pattern=N settings for file-filtered logging
```


## Docker images

Expand Down Expand Up @@ -105,3 +74,21 @@ Usage of ./bin/kube-cleanup-operator:
$ ./bin/kube-cleanup-operator --run-outside-cluster --namespace=default --keep-successful=0 --keep-failures=-1 --keep-pending=-1
```


### Optional parameters

DISCLAIMER: These parameters are not supported on this project since they are implemented by the underlying libraries. Any malfunction regarding the use them is not covered by this GitHub repository. They are included in this documentation since the debugging process is simplified.

```
-alsologtostderr
log to standard error as well as files
-log_backtrace_at value
when logging hits line file:N, emit a stack trace
-log_dir string
If non-empty, write log files in this directory
-logtostderr
log to standard error instead of files
-vmodule value
comma-separated list of pattern=N settings for file-filtered logging
```

0 comments on commit 54a1c24

Please sign in to comment.