Troubleshooting Windows Diego Cells

This topic describes how to troubleshoot Windows Diego Cells deployed by Pivotal Application Service for Windows (PASW).

Installation Issues

This section describes issues that may occur during the installation process.

Missing Local Certificates for Windows File System Injector

Symptom

You run the winfs-injector and see the following error about certificates:

Get https://auth.docker.io/token?service=registry.docker.io&
scope=repository:cloudfoundry/windows2016fs:pull: x509:
failed to load system roots and no roots provided

Explanation

Local certificates are needed to communicate with Docker Hub.

Solution

Install the necessary certificates on your local machine. On Ubuntu, you can install certificates with the ca-certificates package.

Outdated Version for Windows File System Injector

Symptom

You run the winfs-injector and see the following error about a missing file or directory:

open ...windows2016fs-release/VERSION: no such file or directory

Explanation

You are using an outdated version of the winfs-injector.

Solution

From the Pivotal Application Service for Windows page on Pivotal Network, download the recommended version of File System Injector tool for the tile.

Missing Container Image

Symptom

You click the + icon in Ops Manager to add the PASW tile to the Installation Dashboard, and you see the error:

Error invalid release uninjected tile

Explanation

The product file you are trying to upload does not contain the Windows Server container base image.

Solution

  1. Delete the product file listing from Ops Manager by clicking its trash can icon under Import a Product.

  2. Follow the PASW installation instructions to run the winfs-injector tool locally on the product file. This step requires Internet access, can take up to 20 minutes, and adds the Windows Server container base image to the product file. For more information, see Install in Installing and Configuring PASW.

  3. Click Import a Product to upload the “injected” product file.

  4. Click the + icon next to the product listing to add the PASW tile to the Installation Dashboard.

Upgrade Issues

This section describes issues that may occur during the upgrade process.

Failure to Create Containers When Upgrading with Shared Microsoft Base Image

Symptom

The pre-start script for the windowsfs job fails, and the upgrade fails with the following output:

Task 308031 | 13:47:04 | Preparing deployment: Preparing deployment (00:00:03)

Task 308031 | 13:47:11 | Preparing package compilation: Finding packages to compile (00:00:00)

Task 308031 | 13:47:21 | Updating instance windows_diego_cell: windows_diego_cell/44c5841f-7580-4e9c-9856-89fcbe08ab0d (2) (canary) (00:00:35)

L Error: Action Failed get_task: Task 59ba76d1-14c5-4d7b-681c-08b9ec4bd64d result: 1 of 10 pre-start scripts failed. Failed Jobs: windows1803fs. Successful Jobs: set_kms_host, groot, loggregator_agent_windows, bosh-dns-windows, rep_windows, winc-network-1803, set_password, enable_ssh, enable_rdp.

Task 308031 | 13:47:56 | Error: Action Failed get_task: Task 59ba76d1-14c5-4d7b-681c-08b9ec4bd64d result: 1 of 10 pre-start scripts failed. Failed Jobs: windows1803fs. Successful Jobs: set_kms_host, groot, loggregator_agent_windows, bosh-dns-windows, rep_windows, winc-network-1803, set_password, enable_ssh, enable_rdp.

Otherwise, the post-start script for the rep_windows job fails, and the upgrade fails with the following output:

Task 8192 | 21:12:30 | Updating instance windows2019-cell: windows2019-cell/bd6d70b9-ed1f-412f-9d49-8045627f4ab3 (0) (canary) (00:17:24)
                     L Error: Action Failed get_task: Task a9555020-1a3b-40c7-677c-d6fc392ce135 result: 1 of 3 post-start scripts failed. Failed Jobs: rep_windows. Successful Jobs: route_emitter_windows, bosh-dns-windows.
Task 8192 | 21:29:55 | Error: Action Failed get_task: Task a9555020-1a3b-40c7-677c-d6fc392ce135 result: 1 of 3 post-start scripts failed. Failed Jobs: rep_windows. Successful Jobs: route_emitter_windows, bosh-dns-windows.

Explanation

When upgrading between versions of Windows rootfs that have a shared Microsoft base layer, PASW may fail to create containers. The cause is currently unknown.

Solution

For available workarounds, see Failure to create containers when upgrading with shared Microsoft base image in the Pivotal Knowledge Base.

Forward Windows Diego Cell Logs

You can use Windows Diego Cell logs to troubleshoot Windows Diego Cells. Windows Diego Cells generate the following types of logs:

  • BOSH job logs, such as rep_windows and consul_agent_windows. These logs stream to the syslog server configured in the System Logging pane of the PAS tile, along with other Pivotal Platform component logs. The names of these BOSH job logs correspond to the names of the logs emitted by Linux Diego Cells.

  • Windows event logs. These logs stream to the syslog server configured in the System Logging pane of the PASW tile.

You can forward BOSH job logs and Windows Event logs to an external syslog server in the following ways:

You can download the forwarded BOSH job logs and Window event logs in the PASW tile. For more information, see Download Diego Cell Logs.

Forward Windows Event Logs to a Syslog Server

To forward Windows event logs to an external syslog server:

  1. Navigate to the Ops Manager Installation Dashboard.

  2. Click the PASW tile.

  3. Select System Logging.

    Win syslog config

  4. Under Enable syslog for VM logs?, select Enable.

  5. Under Address, enter the hostname or IP address of your syslog server.

  6. Under Port, enter the port of your syslog server. The default port is 514.

    Note: The host must be reachable from the PAS network. Ensure your syslog server listens on external interfaces.

  7. Under Protocol, select the transport protocol to use when forwarding logs.

  8. Enable the Enable system metrics checkbox. For a list of the VM metrics that the System Metric Agent emits, see VM Metrics in the System Metrics repository on GitHub.

  9. Click Save.

Download Windows Diego Cell Logs

To download Windows Diego Cell logs:

  1. Navigate to the Ops Manager Installation Dashboard.

  2. Click the PASW tile.

  3. Click the Status tab.

  4. Under the Logs column, click the download icon for the Windows Diego Cell you want to retrieve logs from.

  5. Click the Logs tab.

  6. When the logs are ready, click the filename to download them.

  7. Unzip the file to examine the contents. Each component on the Diego Cell has its own logs directory:

    • /consul_agent_windows/
    • /garden-windows/
    • /metron_agent_windows/
    • /rep_windows/

Connect to a Windows Diego Cell

To connect to a Windows Diego Cell to run diagnostics:

  1. Download and install a Remote Desktop Protocol (RDP) client.

  2. Follow the procedure in Log In to BOSH in Advanced Troubleshooting with the BOSH CLI to log in to your BOSH Director.

    • The steps vary slightly depending on whether your Pivotal Platform deployment uses internal authentication or an external user store.
    • In PASW v2.6 and later, use of the bosh ssh command is enabled by default.
  3. Retrieve the IP address of your Windows Diego Cell using the BOSH CLI by running:

    bosh -e ENV-NAME -d DEPLOYMENT-NAME
    

    Where:

    • ENV-NAME is the alias you assigned to your BOSH Director.
    • DEPLOYMENT-NAME is your deployment’s name.

    For example:

    c:\Users\admin> bosh -e my-environ -d garden-windows
    Using environment '192.0.2.6' as client 'admin'

    Name Release(s) Stemcell(s) Team(s) Cloud Config garden-windows ... ... - latest

  4. Retrieve the administrator password for your Windows Diego Cell by following the steps for your IaaS:

    • On vSphere, this is the value of WINDOWS_PASSWORD in the consumer-vars.yml file you used to previously build a stemcell.
    • On Amazon Web Services (AWS), navigate to the AWS EC2 console. Right-click on your Windows Diego Cell and select Get Windows Password from the dropdown. Provide the local path to the ops_mgr.pem private key file you used when installing Ops Manager and click Decrypt password to obtain the administrator password for your Windows Diego Cell.
    • On Google Cloud Platform (GCP), navigate to the Compute Engine Dashboard. Under VM Instances, select the instance of the Windows VM. At the top of the page, click on Create or reset Windows password. When prompted, enter Administrator under Username and click Set. You then receive a one-time password for the Windows Diego Cell.
    • You cannot RDP into Windows Diego Cells on Azure.
  5. Open your RDP client. The examples below use the Microsoft Remote Desktop app.

  6. Click New and enter your connection information: Rdp connect

    • Connection name: Enter a name for this connection.
    • PC name: Enter the IP address of your Windows Diego Cell.
    • User name: Enter Administrator.
    • Password: Enter the password of your Windows Diego Cell that you obtained above.
  7. Mount a directory on your local machine as a drive in the Windows Diego Cell:

    1. From the same Edit Remote Desktops window as above, click Redirection.
    2. Click the plus icon at the bottom left. Rdp redirection
    3. For Name, enter the name of the drive as it will appear in the Windows Diego Cell. For Path, enter the path of the local directory.
    4. Click OK.
  8. Close the Edit Remote Desktops window and double-click the newly added connection under My Desktops to open a RDP connection to the Windows Diego Cell.

  9. In the RDP session, you can use the Consul CLI to diagnose problems with your Windows Diego Cell. For more information, see Consul CLI.

Consul CLI

To use the Consul CLI on your Windows Diego Cell to diagnose problems with your Consul cluster:

  1. In your RDP session, open a PowerShell window.

  2. Navigate to the directory containing the Consul CLI binary by running:

    cd CONSUL-CLI-DIR\bin
    

    Where CONSUL-CLI-DIR is the Consul CLI package’s directory path.
    For example:

    PS C:\Users\admin> cd C:\var\vcap\packages\consul-windows\bin\
    

  3. List the members of your Consul cluster by running:

    consul.exe members
    

    For example:

    PS C:\var\vcap\packages\consul-windows\bin> consul.exe members
    Node                       Address          Status  Type    Build  Protocol  DC
    cell-windows-0             10.0.0.111:8301  alive   client  0.6.4  2         dc1
    cloud-controller-0         10.0.0.94:8301   alive   client  0.6.4  2         dc1
    cloud-controller-worker-0  10.0.0.99:8301   alive   client  0.6.4  2         dc1
    consul-server-0            10.0.0.96:8301   alive   server  0.6.4  2         dc1
    diego-brain-0              10.0.0.109:8301  alive   client  0.6.4  2         dc1
    diego-cell-0               10.0.0.103:8301  alive   client  0.6.4  2         dc1
    diego-cell-1               10.0.0.104:8301  alive   client  0.6.4  2         dc1
    diego-cell-2               10.0.0.107:8301  alive   client  0.6.4  2         dc1
    diego-database-0           10.0.0.92:8301   alive   client  0.6.4  2         dc1
    ha-proxy-0                 10.0.0.254:8301  alive   client  0.6.4  2         dc1
    nfs-server-0               10.0.0.100:8301  alive   client  0.6.4  2         dc1
    router-0                   10.0.0.105:8301  alive   client  0.6.4  2         dc1
    uaa-0                      10.0.0.93:8301   alive   client  0.6.4  2         dc1
    

  4. Examine the output to ensure that the cell-windows-0 service is registered in the Consul cluster and is alive. Otherwise, your Windows Diego Cell cannot communicate with your Pivotal Platform deployment and developers cannot push .NET apps to the Windows Diego Cell. Check the configuration of your Consul cluster and ensure that your certificates are not missing or misconfigured.

Troubleshoot Windows Compilation VMs

BOSH automatically deletes a compilation VM after the compilation VM fails. In a vSphere environment, use one of the procedures below to troubleshoot your Windows stemcell v2019.7 and later compilation VM issues:

Troubleshoot a Slowly-Deleted Windows Compilation VM

The easiest method to troubleshoot a Windows compilation VM is to bosh ssh to the VM before BOSH deletes it.

To troubleshoot a compilation VM from an ssh session:

  1. Open the vSphere UI.

  2. Open two different BOSH CLI terminal sessions.

  3. Open Ops Manager.

  4. Enable the two following settings in Ops Manager:

    • Select Keep Unreachable Director VMs from BOSH Director tile > Director config.
    • Select enable BOSH-native SSH support on all VMs from PASW tile > VM options.
  5. Click Apply Changes against the PASW tile.

  6. From the first BOSH CLI terminal, monitor the BOSH task:

    watch -n 5 "bosh -d TAS-WINDOWS-DEPLOYMENT is --details | grep compilation"
    

    Where TAS-WINDOWS-DEPLOYMENT is the name of your PASW deployment.

  7. Wait until the compilation VM CID is up.

  8. From the second BOSH CLI terminal, SSH to the Windows compilation VM:

    bosh -d TAS-WINDOWS-DEPLOYMENT ssh COMPILATION-NAME
    

    Where:

    • TAS-WINDOWS-DEPLOYMENT is the name of your PASW deployment.
    • COMPILATION-NAME is the name of your Windows compilation VM.
  9. To prevent BOSH from deleting the compilation VM after the compilation VM fails, search for the compilation VM CID in the vSphere UI and rename it.

  10. You can now troubleshoot within this session.

  11. After troubleshooting, delete the VM manually.

Troubleshoot a Quickly-Deleted Windows Compilation VM

In some situations, the Windows compilation VM might be deleted very quickly, making it impossible to bosh ssh to the VM before BOSH deletes it.

To troubleshoot a quickly-deleted compilation VM:

  1. Download an Ubuntu desktop image from Ubuntu Releases Xenial.

  2. Upload the Ubuntu desktop image into your vSphere datastore.

  3. Open the vSphere UI.

  4. Open a BOSH CLI terminal session.

  5. Open Ops Manager.

  6. Enable the two following settings in Ops Manager:

    • Select Keep Unreachable Director VMs from BOSH Director tile > Director config.
    • Select enable BOSH-native SSH support on all VMs from PASW tile > VM options.
  7. Click Apply Changes in Ops Manager.

  8. From the BOSH CLI terminal, monitor the BOSH task:

    watch -n 5 "bosh -d TAS-WINDOWS-DEPLOYMENT is --details | grep compilation"
    

    Where TAS-WINDOWS-DEPLOYMENT is the name of your PASW deployment.

  9. Wait until the compilation VM CID is up.

  10. From the vSphere UI:

    1. Locate the compilation VM CID in the vSphere UI.
    2. To prevent BOSH from deleting the compilation VM after the compilation VM fails, rename the compilation VM.
    3. On the Windows compilation VM, go to Edit settings > add a device CD/DVD drive > browse Datastore ISO file, and select the Ubuntu desktop iso -> select Connect at Power ON.
    4. Go to Edit settings -> VM options tab -> Boot Options.
    5. Increase the Boot Delay to 10000 milliseconds.
    6. Select Force BIOS Setup.
    7. Select Start/Restart to restart the VM.
  11. On the BIOS setup screen, boot with the CD-ROM Drive.

  12. After Ubuntu desktop starts, select try Ubuntu and launch a terminal.

  13. In the terminal, run:

    sudo fdisk -l
    sudo mkdir /mnt/windows
    sudo mount /dev/sda1 /mnt/windows
    
  14. You can now troubleshoot within this session by exploring the contents of the windows VM’s file system within /mnt/windows

  15. After troubleshooting, delete the VM manually.