Skip to content

Commit

Permalink
clarify usage of ref for multiple sources doc
Browse files Browse the repository at this point in the history
Signed-off-by: Anthony Goddard <[email protected]>
  • Loading branch information
agoddard authored Dec 1, 2024
1 parent 9136064 commit 105e7f6
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/user-guide/multiple_sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,11 @@ spec:
ref: values
```

In the above example, the `prometheus` chart will use the value file from `git.example.gom/org/value-files.git`.
`$values` resolves to the root of the `value-files` repository. The `$values` variable may only be specified at the
beginning of the value file path.
In the above example, the `prometheus` chart will use the value file from `git.example.com/org/value-files.git`.
For Argo to reference the external Git repository containing the value files, you must set the `ref` parameter on
the repository. In the above example, the parameter `ref: values` maps to the variable `$values`, which resolves
to the root of the `value-files` repository.
Note that the `$values` variable can only be used at the beginning of the value file path.

If the `path` field is set in the `$values` source, Argo CD will attempt to generate resources from the git repository
at that URL. If the `path` field is not set, Argo CD will use the repository solely as a source of value files.
Expand Down

0 comments on commit 105e7f6

Please sign in to comment.