Deployment Configuration for VMware Tanzu Kubernetes Grid

For VMware Tanzu Kubernetes Grid configuration, use the deploy.settings file available in the $TCSA_WORK_SPACE/tcx-deployer/scripts/deployment/ directory.

Update the parameters in the deploy.settings file.

To obtain the <config> for the following snippet, see Obtaining KUBECONFIG File from VMware Tanzu Kubernetes Grid Workload Cluster.

# ========== General configuration ========== #
# Mandatory: Path to the <config> of the Kubernetes cluster inside the deployment container (for example: /root/.kube/<config>
KUBECONFIG=

Update the VMware Telco Cloud Service Assurance details and deployment timeout period.

# ========== Product details  ========== #
# Name of the product to be deployed/installed
PRODUCT=tcsa
# Product helm config

# allowed values for footprint "demo", "25k", "50k", "75k", "100k", "125k", "150k", "175k", "200k"
FOOTPRINT=
# Time to wait for the deployment to complete, in seconds. Maximum timeout is 3600 seconds. 
# For deployment above 50K footprint, specify the deployment timeout value in seconds to a higher value.
PRODUCT_DEPLOYMENT_TIMEOUT=1800

# ========== Deployment Location ========== #
# LOCATION can be "on-prem", "aws", "tkg", or "azure"
LOCATION=tkg
 
# ========= Deployment modes and actions ========== #
# Options are "init", "deploy-all", "deploy-apps" or "cleanup"
DEPLOYMENT_ACTION="deploy-all"
## Set this to '--force' if you want to cleanup by force without waiting for user confirmation
DELETE_ARGS=

If you are using secure Harbor registry with certificate based authentication (https), then update the following fields for the registry details. For the registry URL, use the format as harbor-registry-fqdn/project-name/tcx. For example, REGISTRY_URL=harbor-registry.com/tcsa/tcx. URL must be given without https or http and must end with /tcx.
If you are using docker login <harbor-registry-fqdn> command, then you do not have to update <REGISTRY_USERNAME> and <REGISTRY_PASSWORD> in deploy.settings file. For more information, see Prerequisites for Setting up Deployment Container.
```
# ========== Registry details ========== #
# Note: The "/tcx" suffix is mandatory
# Mandatory
REGISTRY_URL=<harbor-registry-fqdn>/<project-name>/tcx
# Mandatory
REGISTRY_USERNAME=<your registry username>
# Mandatory
REGISTRY_PASSWORD=<your registry password>
# Optional: If the registry uses certificates, path to the certificates file (.crt)
REGISTRY_CERTS_PATH=<path to your registry ca certificate file>
```
For information about using secure Harbor registry with certificate based authentication (https) in TKG workload cluster, see Configure VMware Tanzu Kubernetes Grid Cluster for Secure Harbor Registry.
If you are using Harbor without certificate based authentication (http), then update the following fields for the registry details. For the registry URL, use the format as harbor-registry-fqdn/project-name/tcx. URL must be given without https or http and must end with /tcx.
```
# ========== Registry details ========== #
# Note: The "/tcx" suffix is mandatory
# Mandatory
REGISTRY_URL=<harbor-registry-fqdn>/<project-name>/tcx
# Mandatory
REGISTRY_USERNAME=<your registry username>
# Mandatory
REGISTRY_PASSWORD=<your registry password>
```
Update the values-user-overrides.yaml which is available in the <TCSA_WORK_SPACE>/product-helm-chart/tcsa directory. Uncomment and update the values in the file.
```
# (Mandatory)
ingressHostname:
  product: <ClusterIP>
  edgeServices: null

grafana:
  accessIp: <ClusterIP>
```
If you want to update the metrics retention interval period during deployment, see Configure Metrics Retention Interval Period topic.

Note: If you want to deploy on vSAN without any other storage available for AWS S3 compatible storage, you must deploy MinIO. For more information, see Customizing Backup and Restore Configurations topic.