Deploy Enterprise PKS by Importing a YAML Configuration File

Page last updated:

If you have an existing YAML configuration file from a previous deployment of Enterprise Pivotal Container Service (Enterprise PKS), you can use the VMware Enterprise PKS Management Console to deploy a new Enterprise PKS instance from that file.

Note: You can only use the management console to deploy Enterprise PKS from a YAML file if that YAML file was generated by Enterprise PKS Management Console version 1.0 or later. YAML files from beta releases of the management console are incompatible with this release.

YAML Files and Passwords

When Enterprise PKS Management Console generates the content of the YAML file for the YAML editor, it masks the passwords for NSX Manager, vCenter Server, and Harbor so that they do not appear in plain text. In the generated YAML files, the password fields look like the following example:

admin_password: <hidden:f065be51-84e9-4ca7-972d-ed46f7273123>

The <hidden> tag includes a GUID that refers to a database entry for the password that was entered into the configuration wizard. If you import a YAML file from an instance of Enterprise PKS Management Console that is deployed in a different vSphere environment, the GUID provided in the hidden tag will not correspond to an entry in the database of the environment in which you are importing the YAML. As a consequence, if you import a YAML from a different vSphere environment, you must manually update the passwords for NSX Manager, vCenter Server, and Harbor in the YAML editor.

Prerequisites

Import a YAML Configuration File

  1. On the VMware Enterprise PKS landing page, click Install then Import Configuration File.
  2. Drag the YAML file into the Import Configuration File window, or click Browse to navigate to it.
  3. In the Configuration File editor, modify the contents of the YAML file appropriately for the new instance of Enterprise PKS that you want to deploy.

    If the YAML was generated by an instance of management console that is running in a different vSphere environment, update the passwords for NSX Manager, vCenter Server, and Harbor.

    To abandon this YAML and start again, click Import to upload the YAML again or to import a new one.

    You can also click the Edit in Wizard button, to open the imported configuration in the wizard.
  4. When you have finished editing the YAML in the Configuration File editor, click Export to save a copy of your updated YAML configuration.
  5. Click Apply Configuration and Continue to deploy Enterprise PKS.
  6. On the Installing PKS Instance page, follow the progress of the deployment.
  7. When the deployment has completed successfully, click Go to VMware Enterprise PKS to monitor and manage your deployment.

Networking Options in the YAML File

The networking parameters for the three types of Enterprise PKS networking are all included in the network: section of the YAML file. When you edit the YAML file, you only need to set those parameters that apply to your type of networking.

The following table lists the parameters to set for each type of networking.

Unprepared NSX-T Data Center Prepared NSX-T Data Center Flannel
use_nsx
autoprovision_nsx
external_portgroup_gateway
external_portgroup_netmask
external_portgroup_subnet
external_vlan_id
active_t0_edge_node
active_t0_edge_node_ip
standby_t0_edge_node
standby_t0_edge_node_ip
t0_edge_node_lb_ip
dep_network_cidr
dep_dns
nsx_pod_cidr
nsx_node_cidr
nsx_dns
floating_ips_range
nsx_manual_ssl_certs
nsx_ca_crt
nsx_verify_ssl_certs
nsx_host
nsx_password
nsx_username
ntp_servers
use_nsx
autoprovision_nsx
dep_network_name
nsx_pod_ip_block_id
nsx_node_ip_block_id
nsx_t0_id
nsx_fip_id
dep_dns
nsx_dns
nsx_manual_ssl_certs
nsx_ca_crt
nsx_verify_ssl_certs
nsx_nat_mode
nsx_host
nsx_password
nsx_username
ntp_servers
use_nsx
dep_network_name
dep_network_cidr
dep_network_gateway
dep_dns
dep_reserved_ip_range_from
dep_reserved_ip_range_to
svc_network_name
svc_network_cidr
svc_network_gateway
svc_dns
svc_reserved_ip_range_from
svc_reserved_ip_range_to
flannel_pod_network_cidr
flannel_service_network_cidr
ntp_servers

Next Step

For information about how you can use Enterprise PKS Management Console to monitor and manage your deployment, see Monitor and Manage Enterprise PKS in the Management Console.

If Enterprise PKS fails to deploy, see Troubleshooting.


Please send any feedback you have to pks-feedback@pivotal.io.