Skip to content

Commit 36d5c31

Browse files
committed
docs(api): stop listing helm-install-timeout carriers in rest.go
The comment next to the timeout overrides named the kinds that set helm-install-timeout and gave each one's reason. The list had already fallen behind the ApplicationDefinitions that carry the annotation, and nothing checks it, so it drifts every time a kind opts in. Say where the annotations live and when a kind should set them instead. Which kinds set them is recorded in their ApplicationDefinitions, and a comment should not restate it. Assisted-by: LLM Signed-off-by: Aleksei Sviridkin <[email protected]>
1 parent ff0b851 commit 36d5c31

1 file changed

Lines changed: 5 additions & 8 deletions

File tree

  • pkg/registry/apps/application

‎pkg/registry/apps/application/rest.go‎

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1616,14 +1616,11 @@ func (r *REST) convertApplicationToHelmRelease(app *appsv1alpha1.Application) (*
16161616
// - HelmUpgradeTimeout (release.cozystack.io/helm-upgrade-timeout)
16171617
// then overrides only Upgrade.Timeout, so a kind can carry an
16181618
// asymmetric budget (short install, long upgrade or vice versa).
1619-
// kubernetes-rd and tenant-rd carry helm-install-timeout today: the
1620-
// Kubernetes Application's parent chart contains CAPI/Kamaji
1621-
// resources whose admin-kubeconfig Secret is provisioned
1622-
// asynchronously and Kamaji cold-start routinely exceeds flux's
1623-
// default wait budget, and the Tenant parent chart bootstraps the
1624-
// seaweedfs-db CNPG cluster whose first reconcile exceeds it too.
1625-
// Any future kind with the same shape can opt in by setting the
1626-
// same annotation.
1619+
// Both annotations live on the kind's ApplicationDefinition (for a
1620+
// kind shipped in this repo, the cozyrds manifest of its -rd
1621+
// package), so a kind whose chart can legitimately outlast the
1622+
// global wait budget opts in there rather than raising the default
1623+
// for every kind.
16271624
installTimeout := r.releaseConfig.HelmReleaseInstallTimeout
16281625
upgradeTimeout := r.releaseConfig.HelmReleaseUpgradeTimeout
16291626
if r.releaseConfig.HelmInstallTimeout > 0 {

0 commit comments

Comments
 (0)