rm COMMENTED version sections and common product name template vars

pivotal-cf · Mar 25, 2024 · afe57e7 · afe57e7
1 parent ab6f20e
commit afe57e7
Show file tree

Hide file tree

Showing 293 changed files with 3,995 additions and 5,206 deletions.
diff --git a/_add-clusters-workloads.html.md.erb b/_add-clusters-workloads.html.md.erb
@@ -2,7 +2,7 @@
     1. Add more workloads and create an additional cluster. For more information, see
 <a href="maintain-uptime.html#upgrades">About Cluster Upgrades</a> in _Maintaining Workload Uptime_ and
 <a href="create-cluster.html">Creating Clusters</a>.
-    1. Monitor the <%= vars.product_short %> control plane in the <strong><%= vars.product_tile %></strong> tile > <strong>Status</strong> tab.
-    Review the load and resource usage data for the <%= vars.control_plane %> and <%= vars.control_plane_db %> VMs.
+    1. Monitor the Tanzu Kubernetes Grid Integrated Edition control plane in the <strong>Tanzu Kubernetes Grid Integrated Edition</strong> tile > <strong>Status</strong> tab.
+    Review the load and resource usage data for the TKGI API and TKGI Database VMs.
     If any levels are at capacity, scale up the VMs.
     <br>
diff --git a/_api.html.md.erb b/_api.html.md.erb
@@ -1,23 +1,23 @@
 Perform the following steps:
 
-1. Click **<%= vars.control_plane %>**.
+1. Click **TKGI API**.
 
-1. Under **Certificate to secure the <%= vars.control_plane %>**, provide a certificate and private key pair.
+1. Under **Certificate to secure the TKGI API**, provide a certificate and private key pair.
   <br>
-  ![<%= vars.control_plane %> pane configuration](images/tkgi-api.png)
+  ![TKGI API pane configuration](images/tkgi-api.png)
   <br>
-  The certificate that you supply must cover the specific subdomain that routes to the <%= vars.control_plane %> VM with TLS termination on the ingress. 
+  The certificate that you supply must cover the specific subdomain that routes to the TKGI API VM with TLS termination on the ingress. 
   If you use UAA as your OIDC provider, this certificate must be a proper certificate chain and have a SAN field.  
   <p class="note warning"><strong>Warning:</strong> TLS certificates generated for wildcard DNS records only work for a single domain level.
   For example, a certificate generated for <code>&#42;.tkgi.EXAMPLE.com</code> does not permit communication to <code>&#42;.api.tkgi.EXAMPLE.com</code>.
-  If the certificate does not contain the correct FQDN for the <%= vars.control_plane %>, calls to the API will fail.</p>
+  If the certificate does not contain the correct FQDN for the TKGI API, calls to the API will fail.</p>
   You can enter your own certificate and private key pair, or have Ops Manager generate one for you.
 <br>
   To generate a certificate using Ops Manager:
     1. Click **Generate RSA Certificate** for a new install or **Change** to update a previously-generated certificate.
-    1. Enter the domain for your API hostname. This must match the domain you configure under **<%= vars.control_plane %>** > **API Hostname (FQDN)** below, in the same pane. It can be a standard FQDN or a wildcard domain.
+    1. Enter the domain for your API hostname. This must match the domain you configure under **TKGI API** > **API Hostname (FQDN)** below, in the same pane. It can be a standard FQDN or a wildcard domain.
     1. Click **Generate**.<br>
-    ![<%= vars.control_plane %> certificate generation](images/tkgi-api-cert-gen.png)
+    ![TKGI API certificate generation](images/tkgi-api-cert-gen.png)
     <% if current_page.data.iaas == "GCP" %>
     <p class="note"><strong>Note</strong>: If you deployed a global HTTP load balancer for Ops Manager without a certificate,
       you can configure the load balancer to use this newly-generated certificate.
@@ -26,14 +26,14 @@ Perform the following steps:
        <em>Preparing to Deploy Ops Manager on GCP Manually</em>.</p>
     <% else %>
     <% end %>
-1. Under **API Hostname (FQDN)**, enter the FQDN that you registered to point to the <%= vars.control_plane %> load balancer, such as `api.tkgi.example.com`.
-To retrieve the public IP address or FQDN of the <%= vars.control_plane %> load balancer, 
+1. Under **API Hostname (FQDN)**, enter the FQDN that you registered to point to the TKGI API load balancer, such as `api.tkgi.example.com`.
+To retrieve the public IP address or FQDN of the TKGI API load balancer, 
 log in to your IaaS console.
-<p class="note"><strong>Note</strong>: The FQDN for the <%= vars.k8s_runtime_abbr %> API must not contain uppercase letters or trailing whitespace.</p>
+<p class="note"><strong>Note</strong>: The FQDN for the TKGI API must not contain uppercase letters or trailing whitespace.</p>
 1. Under **Worker VM Max in Flight**, enter the maximum number of non-canary worker instances to create, update or upgrade in parallel within an availability zone.
 	<br><br>
 	This field sets the `max_in_flight` variable value. 
-  The `max_in_flight` setting limits the number of component instances the <%= vars.k8s_runtime_abbr %> CLI creates or starts simultaneously 
+  The `max_in_flight` setting limits the number of component instances the TKGI CLI creates or starts simultaneously 
   when running `tkgi create-cluster` or `tkgi update-cluster`. By default, `max_in_flight` is set to `4`, 
-  limiting the <%= vars.k8s_runtime_abbr %> CLI to creating or starting a maximum of four component instances in parallel.  
+  limiting the TKGI CLI to creating or starting a maximum of four component instances in parallel.  
 1. Click **Save**.  
diff --git a/_azs-networks-azure.html.md.erb b/_azs-networks-azure.html.md.erb
@@ -1,9 +1,9 @@
-To configure the networks used by the <%= vars.product_short %> control plane:
+To configure the networks used by the Tanzu Kubernetes Grid Integrated Edition control plane:
 
 1. Click **Assign Networks**.
 
     ![Assign Networks pane in Ops Manager](images/azure/azs-networks-azure.png)
 
-1. Under **Network**, select the infrastructure subnet that you created for <%= vars.product_short %> component VMs, such as the <%= vars.control_plane %> and <%= vars.control_plane_db %> VMs. For example, `infrastructure`.
+1. Under **Network**, select the infrastructure subnet that you created for Tanzu Kubernetes Grid Integrated Edition component VMs, such as the TKGI API and TKGI Database VMs. For example, `infrastructure`.
 1. Under **Service Network**, select the services subnet that you created for Kubernetes cluster VMs. For example, `services`.
 1. Click **Save**.
diff --git a/_azs-networks.html.md.erb b/_azs-networks.html.md.erb
@@ -1,15 +1,15 @@
 To configure the availability zones (AZs) and networks 
-used by the <%= vars.product_short %> control plane:
+used by the Tanzu Kubernetes Grid Integrated Edition control plane:
 
 1. Click **Assign AZs and Networks**.
 
 1. Under **Place singleton jobs in**, select the AZ where you want to deploy the 
-<%= vars.control_plane %> and <%= vars.control_plane_db %>.
+TKGI API and TKGI Database.
 
     ![Assign AZs and Networks pane in Ops Manager](images/azs-networks.png) 
-1. Under **Balance other jobs in**, select the AZ for balancing other <%= vars.product_short %> control plane jobs.  
-    <p class="note"><strong>Note</strong>: You must specify the <strong>Balance other jobs in</strong> AZ, but the selection has no effect in the current version of <%= vars.product_short %>.
+1. Under **Balance other jobs in**, select the AZ for balancing other Tanzu Kubernetes Grid Integrated Edition control plane jobs.  
+    <p class="note"><strong>Note</strong>: You must specify the <strong>Balance other jobs in</strong> AZ, but the selection has no effect in the current version of Tanzu Kubernetes Grid Integrated Edition.
     </p>
-1. Under **Network**, select the infrastructure subnet that you created for <%= vars.product_short %> component VMs, such as the <%= vars.control_plane %> and <%= vars.control_plane_db %> VMs.
+1. Under **Network**, select the infrastructure subnet that you created for Tanzu Kubernetes Grid Integrated Edition component VMs, such as the TKGI API and TKGI Database VMs.
 1. Under **Service Network**, select the services subnet that you created for Kubernetes cluster VMs.
 1. Click **Save**.
diff --git a/_bbr-supported-components.html.md.erb b/_bbr-supported-components.html.md.erb
@@ -1,6 +1,6 @@
 BBR can back up the following components:
 
 * BOSH Director
-* <%= vars.product_short %> control plane API VM and its ETCD database
-* <%= vars.product_short %> control plane database VM (MySQL)
-* <%= vars.product_short %> cluster data, from the clusters' ETCD databases
+* Tanzu Kubernetes Grid Integrated Edition control plane API VM and its ETCD database
+* Tanzu Kubernetes Grid Integrated Edition control plane database VM (MySQL)
+* Tanzu Kubernetes Grid Integrated Edition cluster data, from the clusters' ETCD databases
diff --git a/_bosh-ssh-api.html.md.erb b/_bosh-ssh-api.html.md.erb
@@ -1,6 +1,6 @@
 1. Log in to the BOSH Director. For instructions, see [Log in to the BOSH Director VM](diagnostic-tools.html#alias).
 
-1. To identify your <%= vars.k8s_runtime_abbr %> deployment name, run the following command:  
+1. To identify your TKGI deployment name, run the following command:  
 
     ```
     bosh -e ENVIRONMENT deployments
@@ -12,10 +12,10 @@
     ```console
     $ bosh -e tkgi deployments
     ```  
-    Your <%= vars.k8s_runtime_abbr %> deployment name begins with `pivotal-container-service` and includes
+    Your TKGI deployment name begins with `pivotal-container-service` and includes
     a BOSH-generated identifier.  
 
-1. To identify your <%= vars.control_plane %> VM name, run the following command:  
+1. To identify your TKGI API VM name, run the following command:  
 
     ```
     bosh -e ENVIRONMENT -d DEPLOYMENT vms
@@ -24,20 +24,20 @@
     Where:  
 
      * `ENVIRONMENT` is the BOSH environment alias.  
-     * `DEPLOYMENT` is your <%= vars.k8s_runtime_abbr %> deployment name.  
+     * `DEPLOYMENT` is your TKGI deployment name.  
 
     For example:
     ```console
     $ bosh -e tkgi -d pivotal-container-service-a1b2c333d444e5f66a77 vms
     ```
 
-    Your <%= vars.control_plane %> VM name begins with `pivotal-container-service` and includes a
+    Your TKGI API VM name begins with `pivotal-container-service` and includes a
     BOSH-generated identifier.  
-    <p class="note"><strong>Note:</strong> The <%= vars.control_plane %> VM identifier is different from the identifier in your <%= vars.k8s_runtime_abbr %>
+    <p class="note"><strong>Note:</strong> The TKGI API VM identifier is different from the identifier in your TKGI
     deployment name.
     </p>
 
-1. To SSH into the <%= vars.control_plane %> VM:  
+1. To SSH into the TKGI API VM:  
 
     ```
     bosh -e ENVIRONMENT -d DEPLOYMENT ssh TKGI-API-VM
@@ -46,8 +46,8 @@
     Where:  
 
     * `ENVIRONMENT` is the BOSH environment alias.  
-    * `DEPLOYMENT` is your <%= vars.k8s_runtime_abbr %> deployment name.  
-    * `TKGI-API-VM` is your <%= vars.control_plane %> VM name.  
+    * `DEPLOYMENT` is your TKGI deployment name.  
+    * `TKGI-API-VM` is your TKGI API VM name.  
 
     For example:  
     ```console

diff --git a/_bosh-ssh-db.html.md.erb b/_bosh-ssh-db.html.md.erb
@@ -1,6 +1,6 @@
 1. Log in to the BOSH Director. For instructions, see [Log in to the BOSH Director VM](diagnostic-tools.html#alias).
 
-1. To identify your <%= vars.k8s_runtime_abbr %> deployment name:  
+1. To identify your TKGI deployment name:  
 
     ```
     bosh -e ENVIRONMENT deployments
@@ -12,10 +12,10 @@
     ```console
     $ bosh -e tkgi deployments
     ```
-    Your <%= vars.k8s_runtime_abbr %> deployment name begins with `pivotal-container-service` and includes
+    Your TKGI deployment name begins with `pivotal-container-service` and includes
     a BOSH-generated identifier.  
 
-1. To identify your <%= vars.control_plane_db %> VM names:  
+1. To identify your TKGI Database VM names:  
 
     ```
     bosh -e ENVIRONMENT -d DEPLOYMENT vms
@@ -24,18 +24,18 @@
     Where:  
 
      * `ENVIRONMENT` is the BOSH environment alias.  
-     * `DEPLOYMENT` is your <%= vars.k8s_runtime_abbr %> deployment name.  
+     * `DEPLOYMENT` is your TKGI deployment name.  
 
     For example:  
     ```console
     $ bosh -e tkgi -d pivotal-container-service-a1b2c333d444e5f66a77 vms
     ```
 
-    Your <%= vars.control_plane_db %> VM names begin with `pks-db` and include a
+    Your TKGI Database VM names begin with `pks-db` and include a
     BOSH-generated identifier.  
 
-1. Choose one of the returned <%= vars.control_plane_db %> VMs as the database VM to SSH into.  
-1. To SSH into the selected <%= vars.control_plane_db %> VM, run the following command:  
+1. Choose one of the returned TKGI Database VMs as the database VM to SSH into.  
+1. To SSH into the selected TKGI Database VM, run the following command:  
 
     ```
     bosh -e ENVIRONMENT -d DEPLOYMENT ssh TKGI-DB-VM
@@ -44,8 +44,8 @@
     Where:  
 
     * `ENVIRONMENT` is the BOSH environment alias.  
-    * `DEPLOYMENT` is your <%= vars.k8s_runtime_abbr %> deployment name.  
-    * `TKGI-DB-VM` is the name of the <%= vars.control_plane_db %> VM to SSH into.  
+    * `DEPLOYMENT` is your TKGI deployment name.  
+    * `TKGI-DB-VM` is the name of the TKGI Database VM to SSH into.  
 
     For example:  
     ```console

diff --git a/_cloud-provider.html.md.erb b/_cloud-provider.html.md.erb
@@ -1,4 +1,4 @@
-In the procedure below, you use credentials for vCenter master VMs. You must have provisioned the service account with the correct permissions. For more information, see [Create the Master Node Service Account](vsphere-prepare-env.html#create-master) in _Preparing vSphere Before Deploying <%= vars.product_short %>_.
+In the procedure below, you use credentials for vCenter master VMs. You must have provisioned the service account with the correct permissions. For more information, see [Create the Master Node Service Account](vsphere-prepare-env.html#create-master) in _Preparing vSphere Before Deploying Tanzu Kubernetes Grid Integrated Edition_.
 
 To configure your Kubernetes cloud provider settings, follow the procedure below:
 
@@ -7,7 +7,7 @@ To configure your Kubernetes cloud provider settings, follow the procedure below
     <img src="images/cloud-vsphere.png" alt="vSphere pane configuration">
 1. Ensure the values in the following procedure match those in the **vCenter Config** section of the Ops Manager tile:  
     1. Enter your **vCenter Master Credentials**. Enter the vCenter Server user name using the format `user@domainname`, for example: "[email protected]_". 
-    For more information about the master node service account, see [Preparing vSphere Before Deploying <%= vars.product_short %>](vsphere-prepare-env.html).  
+    For more information about the master node service account, see [Preparing vSphere Before Deploying Tanzu Kubernetes Grid Integrated Edition](vsphere-prepare-env.html).  
         <p class="note warning"><strong>Warning</strong>: The vSphere Container Storage Plug-in will not function if you do not specify the domain name for active directory users.</p>
     1. Enter your **vCenter Host**. For example, `vcenter-example.com`.  
       <p class="note"><strong>Note</strong>: The FQDN for the vCenter Server cannot contain uppercase letters.</p>  
@@ -16,7 +16,7 @@ To configure your Kubernetes cloud provider settings, follow the procedure below
     Populate **Datastore Name** with the Persistent Datastore name configured in your **BOSH Director** tile under **vCenter Config** > **Persistent Datastore Names**.
     Enter only a single Persistent datastore in the **Datastore Name** field.
 
-        - The vSphere datastore type must be Datastore. <%= vars.product_short %> does not support the use of vSphere Datastore Clusters with or without Storage DRS. For more information, see <a href="https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.monitoring.doc/GUID-408D2430-A252-495E-BDB1-4D1940CBC6E1.html">Datastores and Datastore Clusters</a> in the vSphere documentation.
+        - The vSphere datastore type must be Datastore. Tanzu Kubernetes Grid Integrated Edition does not support the use of vSphere Datastore Clusters with or without Storage DRS. For more information, see <a href="https://docs.vmware.com/en/VMware-vSphere/6.7/com.vmware.vsphere.monitoring.doc/GUID-408D2430-A252-495E-BDB1-4D1940CBC6E1.html">Datastores and Datastore Clusters</a> in the vSphere documentation.
         - The <strong>Datastore Name</strong> is the default datastore used if the Kubernetes cluster <code>StorageClass</code> does not define a <code>StoragePolicy</code>. Do not enter a datastore that is a list of BOSH Job/VMDK datastores. For more information, see <a href="./vsphere-persistent-storage.html">PersistentVolume Storage Options on vSphere</a>.
         - For multi-AZ and multi-cluster environments, your <strong>Datastore Name</strong> must be a shared Persistent datastore available to each vSphere cluster. Do not enter a datastore that is local to a single cluster. For more information, see <a href="./vsphere-persistent-storage.html">PersistentVolume Storage Options on vSphere</a>.