[enriqueavindi]

This is by an automated agent, not a human.

Fixes #111

Docs-only change: aligns docs/ with the types in api/v1alphav1/. No Go code is touched.

What changed

docs/quickstart.md

• Adds a "Create the Custom Resources" section: the Overcommit singleton (metadata.name: cluster, required overcommitLabel) and OvercommitClass (required cpuOvercommit, memoryOvercommit, excludedNamespaces), how to label workloads, and how to verify (kubectl get overcommitclass shows CPU/Memory/Default).
• Notes that the Helm chart does not create the CRs by default (createOvercommit/createClasses: false).

docs/overcommitClass-example.yaml

• Adds the required excludedNamespaces field (previously missing, so the example could not be applied).
• Documents the optional nodeSelector / tolerations fields present in OvercommitClassSpec.

docs/architecture.md

• Component table: fixes the wrong cross-links (pod mutating webhook ↔ OvercommitClass validator) and the controller locations.
• Webhook decision diagram now reflects excludedNamespaces (enforced as a match condition), fallback to the default class, and the idempotency annotation overcommit.inditex.dev/applied.
• Admission webhooks section replaced the invented example with the real generated MutatingWebhookConfiguration (per class, pods on CREATE, pods/resize on UPDATE, failurePolicy: Fail, object selector, extra default-* webhook when isDefault: true) and the validating webhooks.
• Full field tables for OvercommitSpec and OvercommitClassSpec (types, required/optional, validation) plus the status shapes.
• Calculation snippet replaced with the actual mutateContainers logic; generated resource names listed; metrics section now uses the real k8s_overcommit_operator_* names.
• TOC completed.

Verification

• All YAML snippets in the three files parse; example OvercommitClass matches the CRD schema (required fields, value ranges).
• Relative links resolve; no Go files changed (git diff --stat → only docs/).

Limitations

• No runtime/UI behaviour changes, so no before/after screenshots apply.
• README.md carries a similar (also outdated) configuration section; it was left untouched as it is outside the requested files.

[enriqueavindi]

This is by an automated agent, not a human.

Added the required Signed-off-by: enriqueavindi <146724635+enriqueavindi@users.noreply.github.com> trailer (commit 6a20f11). The GPG-signature warning is a capability limitation of the automation environment; this docs-only PR needs a human signature or merge decision for that item.

[luisreciomelero]

LGTM

[signoff-validator]

Contribution License Agreement - Warnings 🟠

This PR contains external contributions without proper signoff. Please @enriqueavindi ensure everything is acceptable.

Commits with issues

5632572a docs: align quickstart, OvercommitClass example and architecture with api/v1alphav1 types

Author: enriqueavindi <146724635+enriqueavindi@users.noreply.github.com> 👤 External
Sign-offs: enriqueavindi <146724635+enriqueavindi@users.noreply.github.com> 👤
Issues:

• This commit does not include a GPG signature. Please sign your commit with a valid GPG key.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[enriqueavindi]

Closing: this was an internal tooling trial, not a change proposed for review. The documentation findings are being handled separately.