Skip to content

Commit d158d89

Browse files
committed
Updates docs with ExternalArtifact source
Signed-off-by: Renato Vassão <renatomvd@hotmail.com>
1 parent d3b238f commit d158d89

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ that extends Flux with advanced source composition and decomposition patterns.
1414
The source-watcher controller implements the [ArtifactGenerator](docs/README.md) API,
1515
which allows Flux users to:
1616

17-
- 🔗 **Compose** multiple Flux sources (GitRepository, OCIRepository, Bucket, HelmChart) into a single deployable artifact
17+
- 🔗 **Compose** multiple Flux sources (GitRepository, OCIRepository, Bucket, HelmChart, ExternalArtifact) into a single deployable artifact
1818
- 📦 **Decompose** monorepos into multiple independent artifacts with separate deployment lifecycles
1919
- 🎯 **Optimize** reconciliation by only triggering updates when specific paths change
2020
- 🏗️ **Structure** complex deployments from distributed sources maintained by different teams

docs/spec/v1beta1/artifactgenerators.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The ArtifactGenerator is an extension of Flux APIs that allows source composition and decomposition.
66
It enables the generation of [ExternalArtifacts][externalartifact] from multiple sources
7-
([GitRepositories][gitrepository], [OCIRepositories][ocirepository], [Buckets][bucket] and [HelmChart][helmchart])
7+
([GitRepositories][gitrepository], [OCIRepositories][ocirepository], [Buckets][bucket], [HelmCharts][helmchart] and [ExternalArtifacts][externalartifact])
88
or the splitting of a single source into multiple artifacts.
99

1010
## Source Composition Example
@@ -203,7 +203,7 @@ for artifact generation. Each source must specify:
203203
- `alias`: A unique identifier used to reference the source in copy operations.
204204
Alias names must be unique within the same ArtifactGenerator and can only contain
205205
alphanumeric characters, dashes and underscores.
206-
- `kind`: The type of Flux source resource (`GitRepository`, `OCIRepository`, `Bucket` or `HelmChart`)
206+
- `kind`: The type of Flux source resource (`GitRepository`, `OCIRepository`, `Bucket`, `HelmChart`, or `ExternalArtifact`)
207207
- `name`: The name of the source resource
208208
- `namespace` (optional): The namespace of the source resource if different from the ArtifactGenerator namespace
209209

0 commit comments

Comments
 (0)