Fixing broken hyperlinks and typos in Basics section #184

kakabisht · 2025-05-23T06:51:35Z

No description provided.

sunilarjun

Thanks for the fixes @kakabisht! I've left edits for some grammar ("Refer to the..."), adjusted the note admonition to the Docusaurus syntax, and added an internal link to the "System Requirements" section as well to be in line with the page standard.
Could you also apply these changes to the appropriate v5.4, v5.3, and v5.2 docs versioned folders as well as currently the changes are only reflected in the "Next" version. Please let me know if you have any questions, thank you!

sunilarjun · 2025-06-10T21:11:18Z

docs/01.basics/01.overview/01.overview.md

@@ -67,7 +67,7 @@ Here is a general architecture overview of NeuVector. Not shown is the separate

 ### Deployment Examples

-For common deployment patterns and best practices see the [Onboarding/Best Practices section](/deploying/production?target=_blank#best-practices-tips-qa-for-deploying-and-managing-neuvector).
+For common deployment patterns and best practices refer the [Onboarding/Best Practices section](/deploying/production?target=_blank#best-practices-tips-qa-for-deploying-and-managing-neuvector).


Suggested change

For common deployment patterns and best practices refer the [Onboarding/Best Practices section](/deploying/production?target=_blank#best-practices-tips-qa-for-deploying-and-managing-neuvector).

For common deployment patterns and best practices refer to the [Onboarding/Best Practices section](/deploying/production?target=_blank#best-practices-tips-qa-for-deploying-and-managing-neuvector).

sunilarjun · 2025-06-10T21:28:28Z

docs/01.basics/02.requirements/02.requirements.md

+|--|---|--|--|----|
+| Controller | min. 1<br />3 for HA (odd # only) | 1                | 1GB            | vCPU core may be shared  |
+| Enforcer   | 1 per node/VM                     | 1+               | 1GB            | One or more dedicated vCPU for higher network throughput in Protect mode  |
+| Scanner    | min. 1<br />2+ for HA/Performance | 1                | 1GB            | CPU core may be shared for standard workloads.<br />Dedicate 1 or more CPU for high volume (10k+) image scanning.<br />Registry image scanning is performed by the scanner and managed by the controller and the image is pulled by the scanner and expanded in memory.<br />The minimum memory recommendation assumes images to be scanned are not larger than .5GB.<br />When scanning images larger than 1GB, scanner memory should be calculated by taking the largest image size and adding .5GB.<br /> For example,  largest image size = 1.3GB, the scanner container memory should be 1.8GB |


Suggested change

| Scanner | min. 1 2+ for HA/Performance | 1 | 1GB | CPU core may be shared for standard workloads. Dedicate 1 or more CPU for high volume (10k+) image scanning. Registry image scanning is performed by the scanner and managed by the controller and the image is pulled by the scanner and expanded in memory. The minimum memory recommendation assumes images to be scanned are not larger than .5GB. When scanning images larger than 1GB, scanner memory should be calculated by taking the largest image size and adding .5GB. For example, largest image size = 1.3GB, the scanner container memory should be 1.8GB |

| Scanner | min. 1 2+ for HA/Performance | 1 | 1GB | CPU core may be shared for standard workloads. Dedicate 1 or more CPU for high volume (10k+) image scanning. Registry image scanning is performed by the scanner and managed by the controller and the image is pulled by the scanner and expanded in memory. The minimum memory recommendation assumes images to be scanned are not larger than .5GB. When scanning images larger than 1GB, scanner memory should be calculated by taking the largest image size and adding .5GB. For example, if the largest image size is 1.3GB, the scanner container memory should be 1.8GB. |

sunilarjun · 2025-06-10T21:28:56Z

docs/01.basics/02.requirements/02.requirements.md

+| Scanner    | min. 1<br />2+ for HA/Performance | 1                | 1GB            | CPU core may be shared for standard workloads.<br />Dedicate 1 or more CPU for high volume (10k+) image scanning.<br />Registry image scanning is performed by the scanner and managed by the controller and the image is pulled by the scanner and expanded in memory.<br />The minimum memory recommendation assumes images to be scanned are not larger than .5GB.<br />When scanning images larger than 1GB, scanner memory should be calculated by taking the largest image size and adding .5GB.<br /> For example,  largest image size = 1.3GB, the scanner container memory should be 1.8GB |
+| Manager    | min 1<br />2+ for HA              | 1                | 1GB            | vCPU may be shared |
+
+* For configuration backup/HA, a RWX PVC of 1Gi or more. Refer to [Backups and Persistent Data section](/deploying/production#backups-and-persistent-data) for more details.


Suggested change

* For configuration backup/HA, a RWX PVC of 1Gi or more. Refer to [Backups and Persistent Data section](/deploying/production#backups-and-persistent-data) for more details.

* For configuration backup/HA, a RWX PVC of 1Gi or more. Refer to the [Backups and Persistent Data section](/deploying/production#backups-and-persistent-data) for more details.

sunilarjun · 2025-06-10T21:35:14Z

docs/01.basics/02.requirements/02.requirements.md

@@ -24,12 +24,12 @@ slug: /basics/requirements
 * CoreOS is supported (November 2023) for CVE scanning through RHEL mapping table provided by RedHat. Once an official feed is published by RedHat for CoreOS it will be supported.
 * Officially supported Kubernetes and Docker compliant container management systems. The following platforms are tested with every release of NeuVector: Kubernetes 1.19-1.32, SUSE Rancher (RKE, RKE2, K3s etc), RedHat OpenShift 4.6-4.16 (3.x to 4.12 supported prior to NeuVector 5.2.x), Google GKE, Amazon EKS, Microsoft Azure AKS, IBM IKS, native docker, docker swarm. The following Kubernetes and docker compliant platforms are supported and have been verified to work with NeuVector: VMware Photon and Tanzu, SUSE CaaS, Oracle OKE, Mirantis Kubernetes Engine, Nutanix Kubernetes Engine, docker UCP/DataCenter, docker Cloud.
 * Docker run-time version: 1.9.0 and up; Docker API version: 1.21, CE and EE.
-* Containerd and CRI-O run-times (requires changes to volume paths in sample yamls). See changes required for Containerd in the Kubernetes deployment section and CRI-O in the OpenShift deployment section.
+* Containerd and CRI-O run-times (requires changes to volume paths in sample yamls). For more information, refer to [Kubernetes deployment](../../02.deploying/02.kubernetes/02.kubernetes.md) and [OpenShift deployment](../../02.deploying/04.openshift/04.openshift.md).


Suggested change

* Containerd and CRI-O run-times (requires changes to volume paths in sample yamls). For more information, refer to [Kubernetes deployment](../../02.deploying/02.kubernetes/02.kubernetes.md) and [OpenShift deployment](../../02.deploying/04.openshift/04.openshift.md).

* Containerd and CRI-O run-times (requires changes to volume paths in sample yamls). For more information, refer to the [Kubernetes deployment](../../02.deploying/02.kubernetes/02.kubernetes.md) and [OpenShift deployment](../../02.deploying/04.openshift/04.openshift.md) documentation.

sunilarjun · 2025-06-10T21:37:35Z

docs/01.basics/02.requirements/02.requirements.md

 * NeuVector is compatible with most commercially supported CNI's. Officially tested and supported are openshift ovs (subnet/multitenant), calico, flannel, cilium, antrea and public clouds (gke, aks, iks, eks). Support for Multus was added in v5.4.0.
 * Console: Chrome or Firefox browser recommended. IE 11 not supported due to performance issues.
-* Minikube is supported for simple initial evaluation but not for full proof of concept. See below for changes required for the Allinone yaml to run on Minikube.
+* Minikube is supported for simple initial evaluation but not for full proof of concept. For more information, refer to [changes required for the Allinone yaml to run on Minikube](#minikube).


Suggested change

* Minikube is supported for simple initial evaluation but not for full proof of concept. For more information, refer to [changes required for the Allinone yaml to run on Minikube](#minikube).

* Minikube is supported for simple initial evaluation but not for full proof of concept. For more information, refer to the section regarding [changes required for the Allinone yaml to run on Minikube](#minikube).

sunilarjun · 2025-06-10T22:17:15Z