myasnikovdaniil 5826d5fd7d docs(harbor): fix SeaweedFS discovery key described as annotation (#3293)
## What this PR does

Corrects a factual error in the Harbor app's prerequisites
documentation.

The prerequisites section described the resolved SeaweedFS class as
being surfaced on the tenant namespace as the
`namespace.cozystack.io/seaweedfs` **annotation**. It is a **label**.
`packages/apps/tenant/templates/namespace.yaml` renders that key under
`metadata.labels` — in the block commented "Labels for network
policies", alongside the sibling `namespace.cozystack.io/etcd`,
`/ingress`, `/gateway`, `/monitoring` and `/host` keys. No annotation of
that name exists anywhere in the tree.

Why the wrong noun matters: it sends an operator to the wrong field at
exactly the moment they are already debugging. The README documents that
a Harbor release which cannot provision its registry bucket stays
unreconciled waiting on `BucketInfo`, and the natural check is to
confirm the tenant chain actually resolved a SeaweedFS class. Following
the text and inspecting `.metadata.annotations` returns nothing even on
a perfectly healthy tenant, which invites the conclusion that the tenant
chain is misconfigured and sends the investigation away from the real
cause.

The change is one word. I checked the rest of the tree for the same
error class — grepping for `namespace.cozystack.io/` together with
"annotation" across all of `packages/` and then across the whole
repository — and this README was the only occurrence.
`packages/extra/gateway/README.md` already describes the sibling keys
correctly as labels.

Note on the file being partially generated:
`packages/apps/harbor/README.md` has a `generate:` target in its
Makefile that runs `cozyvalues-gen ... -r README.md`, but that generator
only rewrites the `## Parameters` tables from the `@param` comments in
`values.yaml`. The corrected sentence lives in the hand-maintained prose
section, which the generator preserves verbatim — confirmed by running
cozyvalues-gen v1.6.0 (the version CI pins) against a copy of the
package: the corrected wording survives regeneration byte-for-byte, so
this introduces no codegen drift. Editing the README directly is the
correct fix here; there is no separate upstream source to change.

Downstream consequence worth flagging for reviewers: the cozystack
website generates the Harbor app page from this README, so the published
v1.5 Harbor page currently carries the same error. It will be corrected
when the site re-syncs from this file.

### Screenshots

Not applicable — documentation-only change, no UI surface.

### Release note

```release-note
docs(harbor): fix SeaweedFS discovery key in prerequisites — it is the `namespace.cozystack.io/seaweedfs` namespace label, previously documented as an annotation
```


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Documentation**
* Updated Harbor prerequisites to clarify that the resolved SeaweedFS
class is exposed through a namespace label.


<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-15 13:08:47 +05:00
2025-10-08 09:43:34 +05:00
2025-04-01 18:48:14 +02:00
2024-02-08 12:04:32 +01:00

Cozystack Cozystack

Open Source Apache-2.0 License Support Active GitHub Release GitHub Commit OpenSSF Best Practices OpenSSF Scorecard

Cozystack

Cozystack is a free platform and framework for building clouds.

Cozystack is a CNCF Sandbox Level Project that was originally built and sponsored by Ænix.

With Cozystack, you can transform a bunch of servers into an intelligent system with a simple REST API for spawning Kubernetes clusters, Database-as-a-Service, virtual machines, load balancers, HTTP caching services, and other services with ease.

Use Cozystack to build your own cloud or provide a cost-effective development environment.

Cozystack user interface

Use-Cases

Documentation

The documentation is located on the cozystack.io website.

Read the Getting Started section for a quick start.

If you encounter any difficulties, start with the troubleshooting guide and work your way through the process that we've outlined.

Versioning

Versioning adheres to the Semantic Versioning principles.
A full list of the available releases is available in the GitHub repository's Release section.

Contributions

Contributions are highly appreciated and very welcomed!

In case of bugs, please check if the issue has already been opened by checking the GitHub Issues section. If it isn't, you can open a new one. A detailed report will help us replicate it, assess it, and work on a fix.

You can express your intention to on the fix on your own. Commits are used to generate the changelog, and their author will be referenced in it.

If you have a concrete feature request, open an issue. For a cross-cutting or architectural change, open a design proposal in the community repo. For questions or early ideas, use GitHub Discussions. See CONTRIBUTING.md for the full routing.

Community

You are welcome to join our Telegram group and come to our weekly community meetings. Add them to your Google Calendar or iCal for convenience.

License

Cozystack is licensed under Apache 2.0.
The code is provided as-is with no warranties.

Commercial Support

A list of companies providing commercial support for this project can be found on official site.

Languages
Go 47.2%
Shell 37.6%
TypeScript 7%
Go Template 5.4%
Makefile 1.4%
Other 1.2%