diff --git a/docs/pages/o11y/metrics/monitoring_vcluster.mdx b/docs/pages/o11y/metrics/monitoring_vcluster.mdx index d50717901..a5dcf7ce6 100644 --- a/docs/pages/o11y/metrics/monitoring_vcluster.mdx +++ b/docs/pages/o11y/metrics/monitoring_vcluster.mdx @@ -9,7 +9,7 @@ vCluster is able to rewrite node stats and metrics. This means monitoring a vClu You need to make sure that vCluster has access to the host clusters nodes. [Enabling real nodes synchronization](../../architecture/nodes.mdx) will create the required RBAC permissions. ::: -Please follow the [official Kuberentes documentation](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/) on how to monitor a Kubernetes cluster. +Please follow the [official Kubernetes documentation](https://kubernetes.io/docs/tasks/debug-application-cluster/resource-usage-monitoring/) on how to monitor a Kubernetes cluster. ### How does it work? diff --git a/docs/pages/security/other-topics.mdx b/docs/pages/security/other-topics.mdx index 58201300e..4c8fa1510 100644 --- a/docs/pages/security/other-topics.mdx +++ b/docs/pages/security/other-topics.mdx @@ -16,7 +16,7 @@ The above mentioned methods also work for isolating workloads inside the vCluste ### Secret based Service Account tokens By default vCluster will create Service Account Tokens for each pod and inject them as an annotation in the respective pods -metadata. This can be a security risk in certain senarios. To mitigate this there's a flag `--service-account-token-secrets` in vCluster +metadata. This can be a security risk in certain scenarios. To mitigate this there's a flag `--service-account-token-secrets` in vCluster which creates separate secrets for each pods Service Account Token and mounts it accordingly using projected volumes. This option is not enabled by default but can be enabled on demand. To enable this one can use the `extraArgs` options of the vCluster chart as follows @@ -24,4 +24,4 @@ is not enabled by default but can be enabled on demand. To enable this one can u syncer: extraArgs: - --service-account-token-secrets=true -``` \ No newline at end of file +``` diff --git a/docs/pages/storage.mdx b/docs/pages/storage.mdx index 7ee8d7849..e4643cf48 100644 --- a/docs/pages/storage.mdx +++ b/docs/pages/storage.mdx @@ -11,7 +11,7 @@ sidebar_label: Storage Since the vCluster's syncer synchronizes pods to the underlying host cluster to schedule them, vCluster users can use the storage classes of the underlying host cluster to create persistent volume claims and to mount persistent volumes. By default, the host's storage classes can be used without the need to create it in the vCluster, but this can be configured by [enabling sync of "storageclasses" or "hoststorageclasses"](./syncer/core_resources.mdx). -vCluster provides helm values to adjust this behavior during vCluster installation or upgrade. Find out more below. +vCluster provides helm values to adjust this behavior during vCluster installation or upgrade. Find out more below. ### Sync Persistent Volumes @@ -72,7 +72,7 @@ spec: storage: 5Gi ``` -This only happens if persistent volume sync is enabled in the vCluster. There might be cases where you want to disable this automatic rewriting of PVCs (for example if you want to mount an already existing PV of the host cluster to a PVC in the vCluster), for that case you can set the annotation called `vcluster.loft.sh/skip-translate` to `true`, which will tell vCluster to not rewrite the PVC `volumeName`, `storageClass`, `selectors` or `dataSource`. +This only happens if persistent volume sync is enabled in the vCluster. There might be cases where you want to disable this automatic rewriting of PVCs (for example if you want to mount an already existing PV of the host cluster to a PVC in the vCluster), for that case you can set the annotation called `vcluster.loft.sh/skip-translate` to `true`, which will tell vCluster to not rewrite the PVC `volumeName`, `storageClass`, `selectors` or `dataSource`. ### Sync Volume Snapshots @@ -81,13 +81,13 @@ Kubernetes VolumeSnapshot resource represents a snapshot of a volume on a storag By default, VolumeSnapshot syncing is disabled, and creating a VolumeSnapshot custom resource in the vCluster will have no effect. Following chapters describe how to enable this feature in the vCluster. #### Host prerequisites -Vcluster relies fully on the volume snapshot capabilities of the host cluster, which has to fullfil certain criteria. +Vcluster relies fully on the volume snapshot capabilities of the host cluster, which has to fulfill certain criteria. Host cluster must have all relevant [snapshot CRDs](https://github.com/kubernetes-csi/external-snapshotter/tree/master/client/config/crd) installed, without which the vCluster will fail to start when volume snapshots sync is enabled. Host cluster should have a common snapshot controller installed, as well as a compatible CSI driver. Without these the volume snapshots will not be created in the storage backend. -It is also recommended for the host cluster to have [the volume snapshots validating webhook](https://github.com/kubernetes-csi/external-snapshotter#validating-webhook) installed. +It is also recommended for the host cluster to have [the volume snapshots validating webhook](https://github.com/kubernetes-csi/external-snapshotter#validating-webhook) installed. #### Create a vCluster with volume snapshots sync @@ -103,8 +103,8 @@ then create or upgrade the vCluster with: vcluster create my-vcluster --upgrade -f values.yaml ``` -:::info -It is recommend to install [the volume snapshots validating webhook](https://github.com/kubernetes-csi/external-snapshotter#validating-webhook) in your vCluster instance. +:::info +It is recommend to install [the volume snapshots validating webhook](https://github.com/kubernetes-csi/external-snapshotter#validating-webhook) in your vCluster instance. ::: #### How does it work? diff --git a/docs/pages/syncer/config.mdx b/docs/pages/syncer/config.mdx index 79d1a7cc4..a3891582d 100644 --- a/docs/pages/syncer/config.mdx +++ b/docs/pages/syncer/config.mdx @@ -5,7 +5,7 @@ sidebar_label: Configuration ## Enable or disable synced resources -To enable a resource syncronization, for example persistent volumes, and automatically create the necessary RBAC permissions, add the following to your `values.yaml`: +To enable a resource synchronization, for example persistent volumes, and automatically create the necessary RBAC permissions, add the following to your `values.yaml`: ``` sync: persistentvolumes: @@ -17,7 +17,7 @@ then create or upgrade the vCluster with: vcluster create my-vcluster --upgrade -f values.yaml ``` -To disable a resource that is synced by default, for example if you don't want to sync services, set the following in your `values.yaml`: +To disable a resource that is synced by default, for example if you don't want to sync services, set the following in your `values.yaml`: ``` sync: services: @@ -30,7 +30,7 @@ vcluster create my-vcluster --upgrade -f values.yaml ``` :::warning Correct Cluster Functionality -Disabling certain resources such as services, endpoints or pods can lead to a non-functional virtual Kubernetes cluster, so be careful with what resources you are deactivating. +Disabling certain resources such as services, endpoints or pods can lead to a non-functional virtual Kubernetes cluster, so be careful with what resources you are deactivating. ::: ## Sync all Secrets and Configmaps @@ -56,4 +56,4 @@ sync: ephemeralContainers: true # Sync readiness gates to host cluster status: true -``` \ No newline at end of file +``` diff --git a/docs/pages/syncer/core_resources.mdx b/docs/pages/syncer/core_resources.mdx index 29396fb57..29774732f 100644 --- a/docs/pages/syncer/core_resources.mdx +++ b/docs/pages/syncer/core_resources.mdx @@ -32,6 +32,6 @@ This section lists all resources that can be synced or mirrored by vCluster curr | csinodes | Mirrors CSINode objects from host cluster to vCluster. Enabled automatically when [virtual scheduler](../architecture/scheduling.mdx#separate-vcluster-scheduler) is enabled. Disabling this syncer while using virtual scheduler may result in incorrect pod scheduling. | No _*_ | | csistoragecapacities | Mirrors CSIStorageCapacity Objects from host cluster to vCluster if the .nodeTopology matches a synced node. Enabled automatically when [virtual scheduler](../architecture/scheduling.mdx#separate-vcluster-scheduler) is enabled. Disabling this syncer while using virtual scheduler may result in incorrect pod scheduling. | No _*_ | -_\* refer to the description column for claryfying information about default behavior._ +_\* refer to the description column for clarifying information about default behavior._ -By default, vCluster runs with a minimal set of RBAC permissions to allow execution in restricted environments. Certain resources require extra permissions, which will be automatically given to the vCluster ServiceAccount if you enable the resource sync with the associated helm value \ No newline at end of file +By default, vCluster runs with a minimal set of RBAC permissions to allow execution in restricted environments. Certain resources require extra permissions, which will be automatically given to the vCluster ServiceAccount if you enable the resource sync with the associated helm value diff --git a/docs/pages/using-vclusters/access.mdx b/docs/pages/using-vclusters/access.mdx index 6b3ab74ed..93bc79208 100644 --- a/docs/pages/using-vclusters/access.mdx +++ b/docs/pages/using-vclusters/access.mdx @@ -42,7 +42,7 @@ spec: - backend: service: name: my-vcluster - port: + port: number: 443 path: / pathType: ImplementationSpecific @@ -54,7 +54,7 @@ kubectl apply -f ingress.yaml ``` :::info Enable SSL Passthrough Feature -If you are using the ingress nginx controller, please make sure you have [enabled the SSL passthrough feature](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#ssl-passthrough) as it is disabled by default. +If you are using the ingress nginx controller, please make sure you have [enabled the SSL passthrough feature](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#ssl-passthrough) as it is disabled by default. ::: :::warning SSL Passthrough required @@ -107,7 +107,7 @@ spec: - backend: service: name: my-vcluster - port: + port: number: 443 path: / pathType: ImplementationSpecific @@ -140,7 +140,7 @@ vcluster create my-vcluster --expose kubectl get ns ``` -Thats it, your vCluster is now externally reachable through a LoadBalancer service. +That's it, your vCluster is now externally reachable through a LoadBalancer service. :::warning Check the costs first Even though using a LoadBalancer is the easiest option, if you use a cloud provider it will be costly to create one Loadbalancer per cluster. Check your cloud vendor about the cost of each LoadBalancer. In general using an Ingress is the most cost effective method.