Skip to content

Commit d3934fb

Browse files
committed
update docs
On-behalf-of: @SAP [email protected]
1 parent 78bebb4 commit d3934fb

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

docs/getting-started.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,12 @@ itself and a reference to the kubeconfig secret we just created.
6969
# Required: the name of the APIExport in kcp that this Sync Agent is supposed to serve.
7070
apiExportName: test.example.com
7171

72-
# Required: This Agent's public name, purely for informational purposes.
73-
# If not set, defaults to the Helm release name.
72+
# Required: This Agent's public name, used to signal ownership over locally synced objects.
73+
# This value must be a valid Kubernetes label value, see
74+
# https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set
75+
# for more information.
76+
# Changing this value after the fact will make the agent ignore previously created objects,
77+
# so beware and relabel if necessary.
7478
agentName: unique-test
7579

7680
# Required: Name of the Kubernetes Secret that contains a "kubeconfig" key,

0 commit comments

Comments
 (0)