| `prune_propagation_policy` | The deletion propagation policy that [should be used for pruning](https://github.com/kubernetes/apimachinery/blob/44113beed5d39f1b261a12ec398a356e02358307/pkg/apis/meta/v1/types.go#L456-L470). Can be: `orphan`, `background`, or `foreground`. Default is `foreground`. |
| `inventory_policy` | Determines whether an inventory object can take over objects that belong to another inventory object or don't belong to any inventory object. This is done by determining if the apply/prune operation can go through for a resource based on comparison of the `inventory-id` value in the package and the `owning-inventory` annotation (`config.k8s.io/owning-inventory`) [in the live object](https://github.com/kubernetes-sigs/cli-utils/blob/d6968048dcd80b1c7b55d9e4f31fc25f71c9b490/pkg/inventory/policy.go#L12-L66). Can be: `must_match`, `adopt_if_no_inventory`, or `adopt_all`. Default is `must_match`. |
## GitOps annotations
The GitLab agent for Kubernetes has annotations you can use to:
-**Sort resources**: Apply or delete resources in a specific order.
-**Use apply-time mutation**: Dynamically substitute fields from one resource configuration to another.
The agent has [default sorting](https://github.com/kubernetes-sigs/cli-utils/blob/d7d63f4b62897f584ca9e02b6faf4d2f327a9b09/pkg/ordering/sort.go#L74),
but with annotations, you can fine-tune the order and apply time-value injection.
To provide the GitOps functionality, the GitLab agent for Kubernetes uses the [`cli-utils` library](https://github.com/kubernetes-sigs/cli-utils/),
a Kubernetes SIG project. You can read more about the available annotations in the [`cli-utils` documentation](https://github.com/kubernetes-sigs/cli-utils/blob/master/README.md#apply-sort-ordering).
## Additional resources
The following documentation and examples can help you get started with a GitOps workflow.
@@ -6,6 +6,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w
# Advanced Kubernetes resource management
The GitLab agent for Kubernetes has annotations you can use to:
-**Sort resources**: Apply or delete resources in a specific order.
-**Use apply-time mutation**: Dynamically substitute fields from one resource configuration to another.
The agent has [default ordering](https://github.com/kubernetes-sigs/cli-utils/blob/...),
but with annotations, you can fine-tune the order and apply time-value injection.
To provide this functionality, the GitLab agent for Kubernetes uses the `cli-utils` library,
a Kubernetes SIG project.
There are special situations where the out-of-the-box resource ordering or configuration options are not good enough for a specific use case. The GitOps engine behind the GitLab agent for Kubernetes provides annotations in order to achieve:
-**Sorting**: adds optional resource sorting functionality to apply or delete objects in a particular order.
