Skip to content
This repository has been archived by the owner on Oct 13, 2021. It is now read-only.

Commit

Permalink
spell out flags in config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Daniel Morsing committed Nov 5, 2019
1 parent 74538cf commit c228f5e
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions docs/3_configuration.md
Expand Up @@ -41,11 +41,24 @@ This somewhat cumbersome distinction exists because Kubernetes doesn't
allow cross-namespace ownership. For a simple setup, it's recommended
that you use a single ClusterGitTrack to handle your entire cluster.

Faros can be restricted to only handling GitTracks or ClusterGitTracks
with the `--gittrack-mode` and `--clustergittrack-mode` flags.
A Faros controller can be restricted to only handling GitTracks or ClusterGitTracks
with the `--gittrack-mode` and `--clustergittrack-mode` flags. `--gittrack-mode` takes the following options

Furthermore, you can restrict Faros to only handling GitTracks within
one namespace with the `--namespace=<namespace` flag
* `Disabled`: Don't handle `gittracks`
* `Enabled`: Handle `gittracks`

When a Faros controller is handling `gittracks`, you can restrict it to only
handling `GitTracks` within one namespace with the `--namespace=$namespace`
flag. If the flag is empty, all namespaces are handled.

`--clustergittrack-mode` takes the following options

* `Disabled`: No `ClusterGitTracks` are handled
* `ExcludeNamespaced`: Only cluster-scoped resources within a `ClusterGitTrack` are handled
* `IncludeNamespaced`: all resources are handled by a `ClusterGitTrack`, including namespaced ones.

When `--clustergittrack-mode` is enabled, you cannot restrict it to a given
namespace because of kubernetes internals limitations

### Leader Election

Expand Down

0 comments on commit c228f5e

Please sign in to comment.