Deploy Enterprise PKS by Importing a YAML Configuration File
Page last updated:
Warning: Pivotal Container Service (PKS)
v1.5 is no longer supported because it has reached the End
of General Support (EOGS) phase as defined by the
Support Lifecycle Policy.
To stay up to date with the latest software and security updates, upgrade to a supported version.
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.
- For information about how to deploy Enterprise PKS by using the configuration wizard, see Deploy Enterprise PKS by Using the Configuration Wizard.
- For information about how to upgrade an existing deployment, see Upgrade Enterprise PKS Management Console.
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:
<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.
- Deploy the Enterprise PKS Management Console Appliance to vCenter Server.
- The vCenter Server instance must be correctly configured for Enterprise PKS deployment. For information about the vCenter Server requirements, see Virtual Infrastructure Prerequisites.
- Depending on the type of networking to use, your infrastructure must meet the appropriate prerequisites. For information about networking prerequisites, see the following topics:
- Log in to Enterprise PKS Management Console.
- You have copied an existing YAML configuration file from a previous Enterprise PKS deployment to your local machine.
- You are familiar with editing YAML configuration files for Enterprise PKS.
- For information about how to set the networking parameters in the YAML file, see Networking Options in the YAML File below.
- On the VMware Enterprise PKS landing page, click Install then Import Configuration File.
- Drag the YAML file into the Import Configuration File window, or click Browse to navigate to it.
- 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.
- When you have finished editing the YAML in the Configuration File editor, click Export to save a copy of your updated YAML configuration.
- Click Apply Configuration and Continue to deploy Enterprise PKS.
- On the Installing PKS Instance page, follow the progress of the deployment.
- When the deployment has completed successfully, click Go to VMware Enterprise PKS to monitor and manage your deployment.
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|
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 firstname.lastname@example.org.