Skip to content

Commit

Permalink
Explain about directories in FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
squaremo committed Jul 24, 2018
1 parent 95fe29e commit c2d1cb3
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions site/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ and
At present, yes it works only with a single git repository containing
Kubernetes manifests. You can have as many git repositories with
application code as you like, to be clear -- see
[below](#do-i-have-to-have-my-application-code-and-config-in-the-same-git-repo).
[below](#do-i-have-to-put-my-application-code-and-config-in-the-same-git-repo).

There's no principled reason for this, it's just
a consequence of time and effort being in finite supply. If you have a
Expand All @@ -75,13 +75,25 @@ This
[flux (daemon) operator](https://github.com/justinbarrick/flux-operator)
project may be of use for managing multiple daemons.

### Do I have to have my application code and config in the same git repo?
### Do I have to put my application code and config in the same git repo?

Nope, but they can be if you want to keep them together. Flux doesn't
need to know about your application code, since it deals with
container images (i.e., once your application code has already been
built).

### Is there any special directory layout I need in my git repo?

Nope. Flux doesn't place any significance on the directory structure,
and will descend into subdirectories in search of YAMLs. It avoids
directories that look like Helm charts.

If you have YAML files in the repo that _aren't_ for applying to
Kubernetes, use `--git-path` to constrain where Flux starts looking.

See also [requirements.md](./requirements.md) for a little more
explanation.

### Why does Flux need a deploy key?

Flux needs a deploy key to be allowed to push to the version control
Expand Down Expand Up @@ -339,4 +351,4 @@ resources when deciding whether what to apply. But it gets the
running resources by exporting them from the cluster, and that
only returns the kinds of resource mentioned above. So,
annotating a running resource only works if it's one of those
kinds; putting the annotation in the file always works.
kinds; putting the annotation in the file always works.

0 comments on commit c2d1cb3

Please sign in to comment.