You can use the steps in this topic to configure BOSH Director in VMware Tanzu Operations Manager on Google Cloud Platform (GCP).
You can also perform the procedures in this topic using the Tanzu Operations Manager API. For more information, see Using the Tanzu Operations Manager API.
To configure BOSH Director, you must first access your Tanzu Operations Manager installation and determine how your user database is maintained.
To access Tanzu Operations Manager:
In a web browser, go to the fully qualified domain name (FQDN) of Tanzu Operations Manager that you set up in Deploying Tanzu Operations Manager on GCP.
To set up Tanzu Operations Manager authentication correctly, VMware recommends using an FQDN to access Tanzu Operations Manager. Using an ephemeral IP address to access Tanzu Operations Manager can cause authentication errors upon subsequent access.
Log in to Tanzu Operations Manager. For more information about logging in, see Log in to Tanzu Operations Manager for the First Time.
To configure your GCP tile:
In the Tanzu Operations Manager Installation Dashboard, click the BOSH Director tile.
Click Google Config and fill in the following text boxes:
your-gcp-project-id
.Google Disk Type: Click the Google Disk Type that you want to use for your BOSH-deployed VMs.
Click Save.
To configure the Director Config pane in the BOSH Director tile, you must have the correct permissions. To configure these permissions, see Required permissions in the BOSH documentation and Creating storage buckets in the GCP documentation.
To configure the Director Config pane:
Click Director Config.
In the NTP Servers (comma-delimited) text box, enter 169.254.169.254
to designate the metadata.google.internal
host as NTP server.
Leave the Bosh HM Forwarder IP Address text box blank. BOSH-reported component metrics are available in Loggregator Firehose by default. If you continue to use the BOSH HM Forwarder to consume these component metrics, you might receive duplicate data.
Select the Enable VM Resurrector Plugin check box to enable the BOSH Resurrector functionality and increase your runtime availability.
If you want to collect detailed metrics from BOSH-managed VMs, select the Enable System Metrics check box. For a list of metrics that the System Metrics Agent collects from BOSH-managed VMs, see System Metrics Agent on GitHub. When you select this check box, ensure that the System Metrics Scraper is able to connect on port 53035
to all BOSH-managed VMs.
Select Enable Post Deploy Scripts to run a post-deployment script after deployment. This script allows the job to execute additional commands against a deployment.
If you intend to install VMware Tanzu Kubernetes Grid Integrated Edition (TKGI), you must enable post-deploy scripts.
To configure your VMs to use short-lived NATS credentials during the bootstrap process, select the Enable Short Lived NATS Bootstrap Credentials check box. This increases the security of your Tanzu Operations Manager deployment by rotating the TLS certificate that the BOSH Agents in your VMs use to communicate with the BOSH Director through BOSH NATS.
For more information, see Using Short-Lived NATS Bootstrap credentials.
Configuring your VMs to use short-lived NATS bootstrap credentials restarts the BOSH Agent in all VMs as they are being created, so VMs are created somewhat more slowly.
This configuration affects all new deployments of Tanzu Operations Manager. If you want to configure VMs in existing Tanzu Operations Manager deployments to use short-lived bootstrap credentials, you must recreate them.
Select Recreate VMs deployed by the BOSH Director to force BOSH to recreate BOSH-deployed VMs on the next deployment. This process does not recreate the BOSH Director VM or destroy any persistent disk data. This check box is cleared automatically after a successful redeployment.
Select Recreate BOSH Director VM to force the BOSH Director VM to be recreated on the next deploy. This process does not destroy any persistent disk data. This check box is cleared automatically after a successful redeployment.
Select Recreate All Persistent Disks to force BOSH to migrate and recreate persistent disks for the BOSH Director and all tiles. This process does not destroy any persistent disk data. This check box is cleared automatically after a successful redeployment.
Select Enable bosh deploy retries to instruct Tanzu Operations Manager to retry failed BOSH operations up to five times.
Select Skip Director Drain Lifecycle to prevent drain scripts from running when the BOSH Director is recreated.
Select Store BOSH Job Credentials on tmpfs (beta) to store credentials for BOSH jobs on temporary file storage (tmpfs) memory, rather than on disk. You must re-create all BOSH-deployed VMs for this setting to take effect.
Select Keep Unreachable Director VMs to preserve BOSH Director VMs after a failed deployment for troubleshooting purposes.
(Optional) Select Enable automatic rotation of the BOSH DNS CA certificate (experimental) if you want Tanzu Operations Manager to automatically rotate the BOSH DNS CA certificate and associated leaf certificates when you click Apply Changes. For more information about this feature, see Automatic rotation of BOSH DNS certificates.
(Optional) Modify the Director Workers value, which sets the number of workers available to run BOSH Director tasks. The default value is 5
.
(Optional) Max Threads sets the maximum number of threads that the BOSH Director can run simultaneously. VMware recommends that you leave the text box blank to use the default value, unless doing so results in rate limiting or errors on your IaaS.
(Optional) To add a custom URL for your BOSH Director, enter a valid hostname in the Director Hostname text box. You can also use this text box to configure a load balancer in front of your BOSH Director. For more information, see How to set up a Load Balancer in front of Tanzu Operations Manager Director.
(Optional) To set a custom banner that users see when you log in to the BOSH Director using SSH, enter text in the Custom SSH Banner text box.
(Optional) Enter your comma-separated custom Identification Tags. For example, iaas:foundation1, hello:world
. You can use the tags to identify your foundation when viewing VMs or disks from your IaaS.
For Certificate Duration Overrides, you can choose whether certificates generated within Tanzu Operations Manager and CredHub use the default duration specified for the certificate, or a custom duration value that you specify.
On: Use this option to set a value to override the duration for certificates created by all products. If a product creates a certificate with a longer duration than the value you set, the longer duration is used.
Select HM Pager Duty Plugin to enable Health Monitor integration with PagerDuty.
Select HM Email Plugin to enable Health Monitor integration with email.
For CredHub Encryption Provider, you can choose whether BOSH CredHub stores its encryption key internally on the BOSH Director and CredHub VM, or in an external hardware security module (HSM). The HSM option is more secure.
Before configuring an HSM encryption provider in the Director Config pane, you must follow the procedures and collect information described in Preparing CredHub HSMs for configuration.
After you deploy Tanzu Operations Manager with an HSM encryption provider, you cannot change BOSH CredHub to store encryption keys internally.
Luna HSM: Use this option to use a SafeNet Luna HSM as your permanent CredHub encryption provider, and fill in the following fields:
If you use multiple HSM hosts, you must use the Tanzu Operations Manager API to set or update the HSM configuration. For more information, see Updating a staged director's properties in the Tanzu Operations Manager API documentation.
1792
.Click Blobstore Location to configure the blobstore as either an internal server or an external endpoint.
After you deploy the BOSH Director, only Tanzu Operations Manager users in Advanced Mode can change the blobstore location. For more information, see Platform operator roles and permissions in Tanzu Operations Manager.
Internal: Use this option for an internal blobstore. No additional configuration is required.
S3 Compatible Blobstore: Use this option for an external S3-compatible endpoint. To create an S3 bucket, follow the procedures in Sign up for Amazon S3 and Creating a Bucket in the AWS documentation. When you have created an S3 bucket, configure the following fields:
S3 Endpoint:
us-west-2
region, the URL you create would be https://s3.us-west-2.amazonaws.com
. Enter this URL in the S3 Endpoint field.Bucket Name: Enter the name of the S3 bucket.
S3 Backup Strategy: To configure whether and how to back up the BOSH Director’s S3 blobstore, select one of the following options:
Copy into an additional bucket: This option saves blobstore backups to a separate bucket, which is useful with blobstores that do not support versioning. This option requires you to configure the Backup Bucket Region and Backup Bucket Name fields.
iam_instance_policy
, additional steps are needed:
iam_instance_policy
to the backup_restore
job using the Operations Manager API. See Custom VM Extensions. GCS Blobstore: Use this option for an external Google Cloud Storage (GCS) endpoint.
To create a GCS bucket, follow the procedures in Creating Storage Buckets in the GCS documentation. When you have created a GCS bucket, configure the following fields:
For Database Location, if you configured an external MySQL database such as Cloud SQL, click External MySQL Database and complete the following fields. Otherwise, click Internal. For more information about creating a Cloud SQL instance, see Quickstart for Cloud SQL for MySQL in the Google Cloud documentation.
Use of an External MySQL Database only applies to the BOSH Director. UAA and CredHub do not use these settings and continue to use the Postgres database co-located with the BOSH Director.
After you deploy the BOSH Director, you cannot change the Database Location from an External MySQL Database to an Internal database or from an Internal database to an External MySQL Database.
3306
.Enable TLS: Selecting this check box enables TLS communication between the BOSH Director and the database.
If you select the Enable TLS check box, you can complete the following optional fields:
Click Save.
VMware recommends at least three availability zones (AZs) for a highly available installation.
For configuring a TAS for VMs deployment with multiple AZs, see Reference Architecture for Tanzu Operations Manager on GCP.
For TKGI best practices for distributing workloads across multiple AZs and clusters, see Maintaining Workload Uptime.
To configure the Availability Zones:
Click Create Availability Zones.
Click Add.
For Google Availability Zone:
us-central1
region and selected us-central1-a
as one of the zones for your HTTP(S) load balancer instance groups, enter us-central1-a
.Repeat the preceding step for all the AZs that you associated to instance groups in Preparing to deploy Tanzu Operations Manager on GCP.
Click Save.
Repeat the preceding step for all the AZs you are using in your deployment.
When you are done, click Save.
To create networks:
Click Create Networks.
Verify that Enable ICMP checks is not selected. GCP routers do not respond to ICMP pings.
Click Add Network. Create the three networks described in the following tables.
To use a shared VPC network, enter the shared VPC host project name before the network name in the format VPC-PROJECT-NAME/NETWORK-NAME/SUBNET-NAME/REGION-NAME
. For example, vpc-project/opsmgr/central/us-central1
. For more information, see Configuring a Shared VPC on GCP.
Network name | infrastructure |
---|---|
Google network name | Enter the name of the infrastructure network that you created in Create a GCP Network with Subnets in Preparing to Deploy Tanzu Operations Manager on GCP. The format is: pcf-virt-net/pcf-infrastructure-subnet-MY-REGION/MY-GCP-REGION |
CIDR | Enter the name of the CIDR ending in /26 that you used when you created the infrastructure subnet in GCP. For example: 192.168.101.0/26 |
Reserved IP ranges | Enter the first .1 through .9 addresses from the CIDR. For example, if the CIDR is 192.168.101.0/26 , enter the range 192.168.101.1-192.168.101.9 . |
DNS | 169.254.169.254 |
Gateway | Enter the first .1 address from the CIDR. For example, if the CIDR is 192.168.101.0/26 , enter 192.168.101.1 . |
Availability zones | Select all three AZs. |
Name | Enter the name of the runtime that you intend to deploy in this environment. For example, pas or pks . |
---|---|
Google network name | Enter the name of the runtime network that you created when you prepared your GCP environment. The format is: pcf-virt-net/pcf-RUNTIME-subnet-MY-REGION/MY-GCP-REGION |
CIDR | Enter the name of the CIDR ending in /22 that you used when you created the runtime subnet in GCP. For example: 192.168.16.0/22 |
Reserved IP ranges | Enter the first .1 through .9 addresses from the CIDR. For example, if the CIDR is 192.168.16.0/22 , enter the range 192.168.16.1-192.168.16.9 . |
DNS | 169.254.169.254 |
Gateway | Enter the first .1 address from the CIDR. For example, if the CIDR is 192.168.16.0/22 , enter 192.168.16.1 . |
Availability zones | Select all three AZs. |
Network name | services |
---|---|
Google network Name | Enter the name of the services network you created when you prepared your GCP environment. The format is: pcf-virt-net/pcf-services-subnet-MY-REGION/MY-GCP-REGION |
CIDR | Enter the name of the CIDR ending in /22 that you used when you created the services subnet in GCP. For example: 192.168.20.0/22 |
Reserved IP ranges | Enter the first .1 through .9 addresses from the CIDR. For example, if the CIDR is 192.168.20.0/22 , enter the range 192.168.20.1-192.168.20.9 . |
DNS | 169.254.169.254 |
Gateway | Enter the first .1 address from the CIDR. For example, if the CIDR is 192.168.20.0/22 , enter 192.168.20.1 . |
Availability zones | Select all three AZs. |
After you deploy Tanzu Operations Manager, you add subnets with overlapping AZs to expand your network. For more information about configuring additional subnets, see Expanding your Network with Additional Subnets.
Ensure that 169.254.169.254
, the IP address of the metadata.google.internal
metadata server, is always specified at the beginning of this step's DNS resolver lists.
To configure the Assign AZs and Networks pane:
Click Assign AZs and Networks.
Use the drop-down menu to select a Singleton Availability Zone. The BOSH Director installs in this AZ.
Under Network, click the infrastructure
network for your BOSH Director.
Click Save.
To configure security:
Click Security.
In Trusted Certificates, paste in your custom certificate authority (CA) certificates to insert into your organization’s certificate trust chain. This feature enables all BOSH-deployed components in your deployment to trust custom root certificates. If you want to use Docker registries to run TAS for VMs app instances in Docker containers, enter the certificate for your private Docker registry in this text box. For more information about running app instances in TAS for VMs using Docker registries, see Using Docker Registries.
To enter multiple certificates, paste in your certificates one after the other. For example, format your certificates as shown in the following example:
-----BEGIN CERTIFICATE----- ABCDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678AB EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF GH12345678ABCDEFGH12345678ABCDEFGH12345678... ------END CERTIFICATE------ -----BEGIN CERTIFICATE----- BCDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABB EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF GH12345678ABCDEFGH12345678ABCDEFGH12345678... ------END CERTIFICATE------ -----BEGIN CERTIFICATE----- CDEFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABBB EFGH12345678ABCDEFGH12345678ABCDEFGH12345678ABCDEF GH12345678ABCDEFGH12345678ABCDEFGH12345678... ------END CERTIFICATE------
To include both the Tanzu Operations Manager root CA and the certificates pasted into Trusted Certificates in the trusted_certs
field in the BOSH director manifest, select the Include Tanzu Ops Manager Root CA in Trusted Certs check box. BOSH Director includes this CA in the trust store of every VM that it deploys.
You must select this check box if you are using Tanzu Operations Manager to generate certificates for a load balancer or a router.
To clear the default trusted certificates from all BOSH-deployed Linux VMs, select Clear the Default Trusted Certificates Store.
If you select this check box, you must provide your own trusted certificates. All TLS communication fails if trusted certificates are not available.
Select Generate passwords or Use default BOSH password. VMware recommends using the Generate passwords option for greater security.
Click Save. To view your saved BOSH Director password, click the Credentials tab.
In the BOSH DNS Config pane, you can configure DNS for BOSH Director by adding excluded recursors, a recursor timeout, and handlers.
The text boxes in the BOSH DNS Config pane are:
Excluded Recursors: Exclude recursor addresses, which are URL redirects, so that they are not contacted by the BOSH DNS server. For more information about how the BOSH DNS release selects recursors, see Recursors in Native DNS Support in the BOSH documentation.
Recursor Timeout: Specify a timeout for the BOSH DNS server when contacting any connected recursor addresses. The time limit includes dialing, writing, and reading from the recursor. If any of these actions exceeds the time limit, the action fails.
Handlers: Specify recursor addresses that apply to specific domains. For example, you can use handlers to forward all requests to a domain to a private DNS for resolution. For more information about using handlers, see Additional handlers in Native DNS Support in the BOSH documentation.
To add excluded recursors, a recursor timeout, or handlers to the BOSH DNS release:
Click BOSH DNS Config.
(Optional) In Excluded Recursors, enter a list of prohibited recursor addresses.
(Optional) In Recursor Timeout, enter a time limit for contacting the connected recursors. This time limit must include one of the Go parse duration time units. For example, entering 5s
sets the timeout limit to five seconds. For more information about supported time units, see func ParseDuration in the Go Programming Language documentation.
(Optional) In Handlers, enter an array of custom domain handlers in JSON format. For example:
[
{
"cache": {
"enabled": true
},
"domain": "example.com",
"source": {
"type": "http",
"url": "http://example.endpoint.local"
}
}
]
Click Save.
Click Syslog.
(Optional) To send BOSH Director system logs to a remote server, select Yes.
In Address, enter the IP address or DNS name for the remote server.
In Port, enter the port number that the remote server listens on.
Using the Transport Protocol drop-down menu, select TCP or UDP to specify the transport protocol to use to send the logs to the remote server.
(Optional) Select the Enable TLS check box to send encrypted logs to remote server with TLS. After you select the check box:
Important VMware recommends that you enable TLS encryption when you are forwarding logs. Logs can contain sensitive information, such as cloud provider credentials.
(Optional) In Queue Size, enter an integer that specifies the number of log entries held in the buffer. The default value is 100,000.
(Optional) Select the Forward Debug Logs check box to forward the logs to an external source. This option is deselected by default. If you select it, you might generate a large amount of log data.
(Optional) In the Custom rsyslog Configuration text box, enter the configuration details for rsyslog
. This text box requires the rainerscript syntax.
Click Save.
To enable traffic, you must associate load balancers with the VMs in your deployment. You do this in the Resource Config pane.
To configure the Resource Config pane:
Click Resource Config.
To add a load balancer to the BOSH Director:
Click the icon next to the BOSH Director job name to see the Load Balancers text box and the Internet Connected check box.
Ensure that the Internet Connected check box is not selected for any job. The check box gives VMs a public IP address that enables outbound internet access.
In Preparing to deploy Tanzu Operations Manager on GCP, you provisioned a Network Address Translation (NAT) box to provide internet connectivity to your VMs.
For more information about using NAT in GCP, see VPC network overview in the GCP documentation.
If you install VMware Tanzu Application Service for VMs [Windows] (TAS for VMs [Windows]), provision your Main Compilation Job with at least 100 GB of disk space.
Use the Tanzu Operations Manager API to add custom properties to your VMs; associated security groups and load balancers, for example. For more information, see Managing custom VM extensions.
To complete your BOSH Director installation:
Click Installation Dashboard to return to the Installation Dashboard.
Click Review Pending Changes, then Apply Changes.
If you encounter an error message saying “Cannot reach gateway with IP [IP address] (ignorable if ICMP is disabled)”, return to the Network Config pane and ensure that you have deselected the Enable ICMP Checks check box. Click Review Pending Changes, then click Apply Changes again.
BOSH Director installation begins. This might take a few moments. When the installation process is complete, the Changes Applied dialog box appears.
After you complete this procedure, follow the instructions for the runtime you intend to install.
To deploy TAS for VMs, see Configuring TAS for VMs.
To prepare to deploy TKGI, see Creating Service Accounts in GCP for TKGI.