more review feedback

Author: rosenhouse

private-ai-services/README.md

@@ -14,21 +14,19 @@ PAIS 2.0 is operated via two new Custom Resource Definitions (CRDs) into your Su
 - `PAISConfiguration` is a singleton per-namespace, where you specify a database, certificates, authentication, and other configuration for a PAIS "instance" within that namespace, including a PAIS API server and web UI.
 - `ModelEndpoint`s configure inference servers for a given AI model, using VMs within your namespace, with routing via the namespace-level PAIS API server.
 
-After you've installed the PAIS Supervisor Service, you can use [`kubectl explain`][kubectl-explain] to see the full documentation for each of these resources.  For example
+After you've installed the PAIS Supervisor Service, you can use [`kubectl explain`][kubectl-explain] to see the full documentation for each of these resources.  For example:
 ```
-kubectl explain paisconfiguration.spec.auth.oidc
+kubectl explain paisconfiguration.spec
 ```
 or
 ```
-kubectl explain modelendpoint.spec
+kubectl explain modelendpoint.spec.engine
 ```
 
-will provide detailed API docs.
-
 
 ## Example resources
 
-Here we're publishing some example YAML files to help you get started with Private AI Services on VCF 9.
+Here we're publishing example YAML files to help you get started with Private AI Services on VCF 9.
 
 You must first [install the Private AI Services (PAIS) Supervisor Service][pdf-docs].
 

private-ai-services/paisconfiguration.yaml

@@ -1,6 +1,7 @@
 # Example PAISConfiguration
 #
-# Please review and edit where needed
+# Please review and edit where needed.
+#
 # Several dependencies, like ConfigMaps and Secrets, must be created too.
 # All such dependencies must be in the same namespace as this PAISConfiguration.
 #
@@ -52,13 +53,22 @@ spec:
   vksControlPlane:
     virtualMachineClassName: my-vm-class-choice-eg-best-effort-large
     storageClassName: my-preferred-storage-class
+
+  # This is an optional configuration block that will cause PAIS to install
+  # the NVIDIA GPU Operator to enable GPU-accelerated model inferencing.
+  # The licenseConfigRef and imagePullSecretRef correspond to the
+  # licensing-config and ngc-secret resources that are documented
+  # here: https://docs.nvidia.com/ai-enterprise/deployment/vmware/latest/tanzu.html#deploy-nvidia-gpu-operator
   nvidiaConfig:
     licenseConfigRef:
-      # name of a configmap with a gridd.conf and client_configuration_token.tok fields
+      # Name of a configmap with a gridd.conf and client_configuration_token.tok fields
       name: my-nvidia-licensing-configmap
     imagePullSecretRef:
-      # name of an image pull secret
+      # Name of an image pull secret used for pulling the vGPU Driver Image and
+      # other components of the GPU Operator.
       name: my-ngc-pull-secret
     gpuOperatorOverridesRef:
-      # optional ref to a ConfigMap containing a values.yaml
+      # Optional ref to a ConfigMap containing a values.yaml
+      # Use this to customize the gpu-operator Helm chart
+      # see: https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/getting-started.html#common-chart-customization-options
       name: my-gpu-operator-chart-values