Enable Automation Orchestrator Server Debugging
Automation Orchestrator
Server DebuggingYou can start the
Automation Orchestrator
server in debug mode to debug
issues when developing a plug-in. Install and configure the Kubernetes command-line tool on your local machine. See Install and Set Up kubectl.
- Log in to theAutomation Orchestrator Appliancecommand line asroot.
- Run thekubectl -n prelude edit deployment vco-appcommand.
- Edit the deploymentYAMLfile, by adding a debug environment variable to thevco-server-appcontainer. The variable must be added under theenvsection of thevco-server-appcontainer.containers: - command: ... env: - name: DEBUG_PORT value: "your_desired_debug_port" ... name: vco-server-app ...When adding the debug environment variable to theenvsection, you must follow the YAML indentation formatting as presented in the preceding example.
- Save the changes to the deployment file.If the edit to the deployment file is successful, you receive thedeployment.extensions/vco-app editedmessage.
- Generate the Kubernetes configuration file, by running thevracli dev kubeconfigcommand.As kubeconfig is a developer environment, you are prompted to confirm that you want to continue. Enteryesto continue ornoto stop.
- Copy the content of the generated configuration file fromapiVersion: v1up to and including theclient-key-datacontent.
- Save the generated Kubernetes configuration file on your local machine.
- Log out of theAutomation Orchestrator Appliance.
- Finish configuring the debug mode on your local machine.
- Open a command-line shell.
- Bind theKUBECONFIGenvironment variable to the saved configuration file.This example is based on a Linux environment.export KUBECONFIG=/file/path/fileName
- To validate that the services are running, run thekubectl cluster-infocommand.
- To finish configuring the debug mode, perform the following Kubernetes API request.The value of thelocalhost_debug_portvariable is the port set in your remote debugging configuration of your Integrated Development Environment (IDE). The value of thevro_debug_portvariable is generated during step 3 of this procedure.kubectl port-forward pod/vco_app_pod_IDlocalhost_debug_port:vro_debug_port
When configuring your debugging tool, provide the DNS and IP settings of the local machine where you performed the port forward command.
You have configured server
debugging for your
Automation Orchestrator
Appliance
.