Skip to content

docs: clarify CR ownership lifecycle #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
juliocfj wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify CR ownership lifecycle #737

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/internals/cr-ownership.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,31 @@ spec:
clusterType: Sveltos
```

#### First contribution scope: ClusterSummary and ClusterConfiguration

Issue
[projectsveltos/addon-controller#117](https://github.com/projectsveltos/addon-controller/issues/117)
tracks documenting Custom Resource ownership relationships. A small first pass
can focus on the resources generated from `ClusterProfile` and `Profile`
reconciliation:

| Relationship | Created | Updated | Deleted | Ownership notes |
| ------------ | ------- | ------- | ------- | --------------- |
| `ClusterProfile`/`Profile` -> `ClusterSummary` | When a cluster matches a `ClusterProfile` or `Profile`. | When the selected profile configuration or reconciliation status changes. | When the parent is deleted, or when the cluster stops matching and policies are withdrawn. | The `ClusterSummary` has an `ownerReferences` entry pointing to the owning `ClusterProfile` or `Profile`. |
| `ClusterProfile`/`Profile` -> `ClusterConfiguration` | When Sveltos records resources deployed to a matching cluster. | When deployed resources or Helm chart information changes. | Cleanup behavior should be verified from the live object and controller behavior for the Sveltos version in use. | `ClusterConfiguration.status.clusterProfileResources` and `ClusterConfiguration.status.profileResources` identify which profile caused resources to be deployed. |

Useful fields to inspect:

- `ClusterSummary.spec.clusterName`, `spec.clusterNamespace`, `spec.clusterType`
- `ClusterSummary.spec.clusterProfileSpec`
- `ClusterSummary.status.featureSummaries`
- `ClusterConfiguration.status.clusterProfileResources[].clusterProfileName`
- `ClusterConfiguration.status.profileResources[].profileName`
- `ClusterConfiguration.status.*.Features[].charts` and `status.*.Features[].resources`

Future focused updates can document additional ownership chains, including
`EventSource` -> `EventReport` and `Classifier` -> `ClassifierReport`.

---

### EventSource → EventReport
Expand Down