Skip to content
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.

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

From host sync docs with examples #458

Merged
merged 10 commits into from
Feb 19, 2025
Merged

From host sync docs with examples #458

merged 10 commits into from
Feb 19, 2025

Conversation

hidalgopl
Copy link
Contributor

Content Description

  1. Adds docs for config maps from host sync
  2. Adds a fragment with a guide how to use config map from host sync
  3. Adds docs for secrets from host sync
  4. Adds a fragment with a guide how to use secret from host sync
  5. Adds docs for namespaced custom resources from host sync
  6. Adds a fragment with a guide how to use namespaced custom resources from host sync

Preview Link

Internal Reference

Closes DOC-401

Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for vcluster-docs-site ready!

Name Link
🔨 Latest commit 7ae86e9
🔍 Latest deploy log https://app.netlify.com/sites/vcluster-docs-site/deploys/67b5b8ce7584ad000822aed0
😎 Deploy Preview https://deploy-preview-458--vcluster-docs-site.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

vcluster/_fragments/sync-from-host-secret-example.mdx|80 col 78| [Google.FirstPerson] Avoid first-person pronouns such as 'my'.
vcluster/_fragments/sync-from-host-secret-example.mdx|83 col 5| [Google.We] Try to avoid using first-person plural like 'Let's'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|12 col 21| [Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|15 col 10| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|18 col 15| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|24 col 88| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|24 col 157| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|26 col 22| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|28 col 35| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|30 col 91| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|57 col 45| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'namespace(s)'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|73 col 200| [Loft.no-vcluster-platform] Prefer using 'the platform' instead of 'vCluster Platform'
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|87 col 25| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'map(s)'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|123 col 6| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|144 col 65| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/configmaps.mdx|145 col 173| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|12 col 21| [Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|15 col 10| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|18 col 15| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|24 col 88| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|24 col 157| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|26 col 22| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|30 col 88| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|32 col 35| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|54 col 41| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'namespace(s)'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|71 col 197| [Loft.no-vcluster-platform] Prefer using 'the platform' instead of 'vCluster Platform'
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|86 col 18| [Google.OptionalPlurals] Don't use plurals in parentheses such as in 'secret(s)'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|122 col 6| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|143 col 62| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|144 col 173| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|15 col 102| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|15 col 194| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|19 col 10| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|22 col 4| [Google.Headings] 'Cluster Scope Example' should use sentence-style capitalization.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|34 col 4| [Google.Headings] 'Namespaced Scope CRDs' should use sentence-style capitalization.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|35 col 21| [Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|37 col 15| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|43 col 88| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|43 col 157| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|45 col 22| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|55 col 10| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|60 col 35| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|62 col 97| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|64 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|64 col 4| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|64 col 66| [Google.We] Try to avoid using first-person plural like 'our'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|98 col 205| [Loft.no-vcluster-platform] Prefer using 'the platform' instead of 'vCluster Platform'
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|146 col 5| [Google.Headings] 'Pro Patches' should use sentence-style capitalization.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|150 col 6| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|173 col 70| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|174 col 173| [Google.Will] Avoid using 'will'.

Signed-off-by: Paweł Bojanowski <[email protected]>
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

vale

vcluster/configure/vcluster-yaml/sync/from-host/secrets.mdx|144 col 173| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|15 col 102| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|15 col 194| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|19 col 10| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|22 col 4| [Google.Headings] 'Cluster Scope Example' should use sentence-style capitalization.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|34 col 4| [Google.Headings] 'Namespaced Scope CRDs' should use sentence-style capitalization.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|35 col 21| [Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|37 col 15| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|43 col 88| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|43 col 157| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|45 col 22| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|55 col 10| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|60 col 35| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|62 col 97| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|64 col 1| [Google.We] Try to avoid using first-person plural like 'We'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|64 col 4| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|64 col 66| [Google.We] Try to avoid using first-person plural like 'our'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|98 col 205| [Loft.no-vcluster-platform] Prefer using 'the platform' instead of 'vCluster Platform'
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|146 col 5| [Google.Headings] 'Pro Patches' should use sentence-style capitalization.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|150 col 6| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|173 col 70| [Google.Will] Avoid using 'will'.
vcluster/configure/vcluster-yaml/sync/from-host/custom-resources.mdx|174 col 173| [Google.Will] Avoid using 'will'.

Signed-off-by: Paweł Bojanowski <[email protected]>
@hidalgopl hidalgopl requested a review from a team February 17, 2025 14:50
Copy link
Contributor

@johannesfrey johannesfrey left a comment

Choose a reason for hiding this comment

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

Mostly nits.

Signed-off-by: Paweł Bojanowski <[email protected]>
…ple at the top, bullet point list of assumptions

Signed-off-by: Paweł Bojanowski <[email protected]>
Signed-off-by: Paweł Bojanowski <[email protected]>
Copy link
Contributor

@Piotr1215 Piotr1215 left a comment

Choose a reason for hiding this comment

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

Thank you for the pr @hidalgopl , added some suggestions and comments. Key takeaways:

  • vCluster vs virtual cluster. We refer to virtrual cluster for everyting that is running as a cluster and to vCluster as the mechanism enabling it.
  • I've reviewed the secrets.mdx since configmaps.mdx isa copy of it, so all comments apply there too.

@Piotr1215
Copy link
Contributor

There are a few small style tweaks, but I don't want to block the PR and will do it later. Thanks @hidalgopl !

@Piotr1215 Piotr1215 merged commit 86d81eb into main Feb 19, 2025
7 checks passed
@Piotr1215 Piotr1215 deleted the from-host-sync-docs branch February 19, 2025 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants