Skip to content

add note about resources #296

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
pwright wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add note about resources #296

Show file tree
Hide file tree
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
11 changes: 11 additions & 0 deletions input/refdog/resources/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,17 @@ following output resources:
- A ServiceAccount, Role, and RoleBinding for running site components
- A Secret containing a signing CA for site linking

The output resources generated by the controller belong to the
`internal.skupper.io` API group. The controller acts as the field

@hash-d hash-d Jun 23, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what API group stands for, in this context. Also, a resource may have several field managers, for different sets of fields.

There are things, such as adding new labels or changing non-skupper labels that the user may be allowed to do.

I think I originally suggested mentioning that skupper works as a field manager for those resources, but on a second thought that's more noise than signal.

Perhaps we could tell them simply that they're allowed to add or change their own entries on metadata.annotations and metadata.labels (but not skupper's, as identified with internal.skupper.io), and that any changes done within spec.* are subject to be overwritten by the controller.

manager and operator for these resources. They reflect the runtime
state that the controller derives from your input resources and should
not be edited directly.

**Note:** Any manual changes made to `internal.skupper.io` resources
will be overwritten the next time the controller reconciles. To
change the behaviour of a site or link, update the corresponding
`skupper.io` input resource instead.

#### Operations

On Kubernetes:
Expand Down
11 changes: 11 additions & 0 deletions refdog/config/resources/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,17 @@ following output resources:
- A ServiceAccount, Role, and RoleBinding for running site components
- A Secret containing a signing CA for site linking

The output resources generated by the controller belong to the
`internal.skupper.io` API group. The controller acts as the field
manager and operator for these resources. They reflect the runtime
state that the controller derives from your input resources and should
not be edited directly.

**Note:** Any manual changes made to `internal.skupper.io` resources
will be overwritten the next time the controller reconciles. To
change the behaviour of a site or link, update the corresponding
`skupper.io` input resource instead.

#### Operations

On Kubernetes:
Expand Down