Skip to content

Commit 8724d13

Browse files
committed
docs(marketplace): stop calling the controller an operator
These pages address operators, meaning cluster administrators, so reusing the word for the thing doing the reconciliation reads as the reader being told to pull the artifact. Also name what kubectl prints in that column. Signed-off-by: IvanHunters <[email protected]>
1 parent bc888bf commit 8724d13

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎content/en/docs/next/marketplace/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Installing an application from a connected repository runs its charts in your ma
4141

4242
Connecting is a standing subscription rather than a one-time fetch. Both connect paths create an `OCIRepository` pinned to a **tag**, with `interval: 5m`, so Flux re-resolves that tag every five minutes and a new revision behind it is pulled and its `PackageSource` resources re-applied. What the new revision drops is removed as well: a package the publisher stops shipping disappears from every connected cluster, and an installed `Package` left behind goes `Ready=False` with `PackageSourceNotFound`. Whoever controls the tag controls what your cluster reads from then on: re-pushing the same tag reaches every connected cluster within the interval. `cozypkg tap` rejects digest references, so pinning an immutable digest at connect time is not an option.
4343

44-
Signature verification happens at **publication** time, not at connect time. `cozypkg tap` validates an artifact's structure before it creates anything; the dashboard connect does not, it records the source and leaves the operator to pull the artifact, check its digest and materialize the `PackageSource` resources afterwards, so a broken chart surfaces later as a failed install. Neither verifies a cosign signature, and neither sets `spec.verify` on the `OCIRepository`. The verification point is the community index CI gate, which pins each release to the entry's recorded cosign identity; it attests the artifact as of the moment the entry merged, not whatever the tag resolves to later.
44+
Signature verification happens at **publication** time, not at connect time. `cozypkg tap` validates an artifact's structure before it creates anything; the dashboard connect does not, it records the source, and the pull, the digest check and the materialization of the `PackageSource` resources all happen in the cluster afterwards, so a broken chart surfaces later as a failed install. Neither verifies a cosign signature, and neither sets `spec.verify` on the `OCIRepository`. The verification point is the community index CI gate, which pins each release to the entry's recorded cosign identity; it attests the artifact as of the moment the entry merged, not whatever the tag resolves to later.
4545

4646
Setting `spec.verify` on the `OCIRepository` in `cozy-system` by hand is what closes that gap: Flux then checks the signature on every pull, including the ones the interval triggers. Connecting the same repository again from the dashboard replaces the source's whole spec and drops the field, so re-add it after a reconnect. See [Publishing a Repository]({{% ref "/docs/next/marketplace/publishing" %}}#the-community-index) for the publication side.
4747

‎content/en/docs/next/marketplace/connecting.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,13 +92,13 @@ kubectl get ocirepositories --namespace cozy-system \
9292
--output custom-columns=NAME:.metadata.name,URL:.spec.url,SECRET:.spec.secretRef.name
9393
```
9494

95-
An empty `SECRET` column on a private repository means the credential was dropped; tapping again with `--secret` restores it.
95+
A `SECRET` column reading `<none>` on a private repository means the credential was dropped; tapping again with `--secret` restores it.
9696

9797
## Connect from the dashboard
9898

9999
The dashboard "Repositories" view is backed by the `Tap` resource and covers the same flow without the CLI. Open it from the sidebar, choose **Connect**, and provide the `oci://` reference and, for a private repository, the name of a pull-credential `Secret` in `cozy-system`. Connected repositories are listed with their status; a tapped repository still connecting or blocked by a name collision shows its message there, and tapped repositories can be disconnected from the same view.
100100

101-
Two differences from the CLI. The dashboard skips the structural validation `cozypkg tap` runs, so a repository whose charts are broken connects cleanly and fails later, when an application from it is installed. And connecting here only records the intent: the call writes the Flux source and returns `connecting`, then the operator pulls the artifact, checks its digest against the source, reads the `PackageSource` resources and applies the same name-collision check in the background. So an unreachable reference is accepted rather than refused up front the way the CLI refuses it; the outcome arrives as the repository's status in the view, and `cozypkg list` does not show the source until that has finished.
101+
Two differences from the CLI. The dashboard skips the structural validation `cozypkg tap` runs, so a repository whose charts are broken connects cleanly and fails later, when an application from it is installed. And connecting here only records the intent: the call writes the Flux source and returns `connecting`, and the cluster then pulls the artifact, checks its digest against the source, reads the `PackageSource` resources and applies the same name-collision check in the background. So an unreachable reference is accepted rather than refused up front the way the CLI refuses it; the outcome arrives as the repository's status in the view, and `cozypkg list` does not show the source until that has finished.
102102

103103
## Install applications
104104

0 commit comments

Comments
 (0)