Update text on patches #445
Conversation
✅ Deploy Preview for vcluster-docs-site ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
joaniekube
force-pushed
the
joan_test-patch
branch
3 times, most recently
from
70bfada to
b538209
Compare
There was a problem hiding this comment.
@joaniefromtheblock I had to approve/trigger the vale workflow (it needs to be done for all external contributors). As you can see, there are some vale rules violations. Could you please fix those? Please refer to the CONTRIBUTING.md to learn more about styling guidelines and working with vale.
Tip
you can find the exact rules violations in the Files changed tab
change file location change file location change file location change file location change file location change file location change file location change file location change file location change file location change file location remove admonitions change file location change file location change file location update update link update link update link update link update link update link update link update link update link update first line updates for linter update text for clarity update text for consistency slight rewrite
joaniekube
force-pushed
the
joan_test-patch
branch
from
fb57a04 to
4c6139c
Compare
| A reference patch allows you to link a field in one resource to another resource. During syncing, vCluster rewrites the reference and imports the linked resource from a host cluster into its corresponding virtual cluster, if the resource exists. | ||
| You can use reference patches to share resources, such as `Secrets` or `ConfigMaps`, between clusters without manually recreating or duplicating them. | ||
|
|
||
| For example, if you have a custom resource in your virtual cluster that references a `Secret` named `my-secret-ref`, you can define a reference patch in your `vcluster.yaml` using the following configuration: |
There was a problem hiding this comment.
references a
Secretnamedmy-secret-ref
I don't think this is quite right. I think Reference patch for this example can be explained by these statements
In this example, the pod with the references annotation - exists on the host
Say Annotation could be my-secret-ref: "my-example-secret" on the pod
And if "my-example-secret" exists on the host cluster, vCluster automatically imports it into the virtual cluster.
This example here has a similar explanation.
There was a problem hiding this comment.
Thanks for comment above @sowmyav27. I got a little tripped up reading the docs, so proposed the suggested rewrite.
Just so I understand is this what is happening?
If a pod in the host cluster has an annotation that references a secret, and the secret "my-example-secret" exists on a pod in the host cluster, vCluster automatically imports it into the virtual cluster. This allows workloads inside the vCluster to access the secret without requiring manual synchronization.
Is this correct?
There was a problem hiding this comment.
Also this was rewritten so the example you are linking to will not be in the updated docs. Should it still be included?
Co-authored-by: nebelsprachen <[email protected]>
Content Description
contextvariablePreview Link
Internal Reference
N/A