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.

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

Update nodes.mdx #467

Merged
merged 3 commits into from
Feb 24, 2025
Merged

Update nodes.mdx #467

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b4cae7
Update nodes.mdx
kmadel Feb 21, 2025
a016202
Update nodes.mdx
kmadel Feb 21, 2025
c1c48ed
update typo
joaniekube Feb 24, 2025
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
14 changes: 7 additions & 7 deletions vcluster/configure/vcluster-yaml/sync/from-host/nodes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@
{/*
`nodes.enabled`:
- covered by the generic section here: https://www.vcluster.com/docs/syncer/config#enable-or-disable-synced-resources
- exists from the beginning. I believe one would need this to schedule any pods
- exists from the beginning. This is needed to schedule any pods
- may be possible to disable this in the "control plane" vCluster when using [Isolated Control Plane](https://www.vcluster.com/pro/docs/features/isolated_control_planes), where all the workloads are scheduled to the workload cluster (where nodes syncing would be enabled)

Check warning on line 14 in vcluster/configure/vcluster-yaml/sync/from-host/nodes.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.

Raw Output:
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disable'.", "location": {"path": "vcluster/configure/vcluster-yaml/sync/from-host/nodes.mdx", "range": {"start": {"line": 14, "column": 22}}}, "severity": "WARNING"}

`nodes.syncBackChanges`:
- replaces deprecated flag `--sync-node-changes`
Expand All @@ -26,21 +26,21 @@
- sets `--sync-all-nodes` syncer flag, see also [Example: Sync All Nodes](https://www.vcluster.com/docs/architecture/nodes#example-sync-all-nodes)

`nodes.selector.labels`:
- selects node labels that will be synced to the vCluster. This allows controlling which nodes can be used by the vCluste
- Some example use cases:
- selects specific node labels to sync with the vCluster. This allows control over which nodes the vCluster can use.
- some example use cases include:
- only allow nodes in a region
- only allow nodes with a particular architecture
- only use spot instances
- prevent vClusters from sharing resources with critical infrastructure
- prevent vCluster from sharing resources with critical infrastructure
*/}

By default, this is disabled.

Check warning on line 37 in vcluster/configure/vcluster-yaml/sync/from-host/nodes.mdx

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.

Raw Output:
{"message": "[Google.WordList] Use 'turn off' or 'off' instead of 'disabled'.", "location": {"path": "vcluster/configure/vcluster-yaml/sync/from-host/nodes.mdx", "range": {"start": {"line": 37, "column": 21}}}, "severity": "WARNING"}

vCluster syncs psuedo nodes from the host cluster where there are virtual cluster pods running. Pseudo nodes only have real values for the CPU, architecture, and operating system, while everything else is randomly generated. A single pseudo node can either represent a single real node on the host cluster, or it can represent multiple real nodes. If there are no more pods on a node, vCluster deletes the pseudo node.

However, when you need to access specific node information, you can choose to sync real nodes from the host cluster to the virtual cluster. This requires a cluster role.

### Sync pseudo nodes (Default)
### Sync pseudo nodes (default)

Sync pseudo nodes to the virtual cluster. This default configuration does not require a cluster role.

Expand All @@ -67,7 +67,7 @@

### Sync pseudo nodes with label selector

Sync pseudo nodes nodes that match a given label selector. This example sets the node selector to the same values when syncing a pod from virtual cluster to host cluster:
Sync pseudo nodes that match a given label selector. This example sets the node selector to the same values when syncing a pod from virtual cluster to host cluster:
```YAML
sync:
fromHost:
Expand All @@ -81,7 +81,7 @@

### Sync real nodes with label selector

Sync real nodes nodes that match a given label selector. This example sets the node selector to the same values when syncing a pod from virtual cluster to host cluster:
Sync real nodes that match a given label selector. This example sets the node selector to the same values when syncing a pod from virtual cluster to host cluster:
```YAML
sync:
fromHost:
Expand Down
Loading