Method UpdateName

runtime/controller.go:567–614

UpdateName renames a resource and updates annotations, and enqueues it for reconciliation. If called from outside the resource's reconciler and the resource is currently reconciling, the current reconciler will be cancelled first.

(ctx context.Context, name, newName, owner *runtimev1.ResourceName, paths []string)

// UpdateName renames a resource and updates annotations, and enqueues it for reconciliation.
// If called from outside the resource's reconciler and the resource is currently reconciling, the current reconciler will be cancelled first.
func (c *Controller) UpdateName(ctx context.Context, name, newName, owner *runtimev1.ResourceName, paths []string) error {
	if err := c.checkRunning(); err != nil {
		return err
	}
	if ctx.Err() != nil {
		return ctx.Err()
	}
	c.lock(ctx, false)
	defer c.unlock(ctx, false)

	if !c.isReconcilerForResource(ctx, name) {
		c.cancelIfRunning(name)
		c.enqueue(name)
	}

	// Check resource exists (otherwise, DAG lookup may panic)
	r, err := c.catalog.get(name, false, false)
	if err != nil {
		return err
	}

	// All resources pointing to the old name need to be reconciled (they'll pointing to a void resource after this)
	if !c.catalog.isCyclic(name) {
		ns := c.catalog.dag.Children(name)
		for _, n := range ns {
			c.enqueue(n)
		}
	}

	err = c.safeRename(name, newName)
	if err != nil {
		return err
	}
	c.enqueue(newName)

	err = c.catalog.updateMeta(newName, r.Meta.Refs, owner, paths)
	if err != nil {
		return err
	}

	// We updated a name, so it may have broken previous cyclic references
	ns := c.catalog.retryCyclicRefs()
	for _, n := range ns {
		c.enqueue(n)
	}

	return nil
}

// UpdateSpec updates a resource's spec and enqueues it for reconciliation.
// If called from outside the resource's reconciler and the resource is currently reconciling, the current reconciler will be cancelled first.