Deploying Kubeturbo to a Kubernetes cluster through the Turbonomic user interface

Edit online

This topic describes the wizard in the Turbonomic user interface that enables you to deploy Kubeturbo to a Kubernetes cluster with ease. The wizard prompts you for the required Kubeturbo settings and then generates a downloadable script that you run in your cluster to complete the deployment.

Note:

You can also deploy Kubeturbo through YAML, a Helm chart in a Helm chart repository, a Helm chart in a GitHub repository, or an operator.

Deployment requirements

Before deploying Kubeturbo, be sure to:

Review the general requirements.

Deploying Kubeturbo

Click Settings > Target configuration.
On the Target configuration page, click Add Target.
On the Select target page, click Kubernetes.
In the side panel, review the connection requirements and then click Connect Target.
Configure Cluster settings.
- Cluster name
  
  Specify a unique cluster name that will display in the Turbonomic user interface.
- Namespace
  
  It is recommended that you leave the default namespace name (turbo) unchanged. If you change the name, be sure to specify one that follows the naming convention for namespaces to avoid errors. For more information, see this topic.
Select your cluster role.
- Optimize (preferred)
  
  This role specifies the minimum permissions that Kubeturbo needs to monitor your workloads and execute the actions that Turbonomic generated to optimize these workloads.
- Monitor (Read-only)
  
  This role specifies the minimum permissions that Kubeturbo needs to monitor your workloads. Actions that Turbonomic generated to optimize these workloads can only be executed externally (for example, in your cluster).
Skip this step if you did not deploy the secure client to your Turbonomic instance.

If you deployed the secure client to your Turbonomic instance, choose from the following options for updates and logging.

Note: For more information about the secure client, see this topic.
- Automatic (preferred)
  
  Turbonomic secure client automatically syncs the Kubeturbo version with the Turbonomic version and enables centralized logging.
  
  Note:
  Currently, proxy settings are not supported for this option.
- Manual (self-managed)
  
  You manually sync the Kubeturbo version with the Turbonomic version and logging is not centralized.
  
  If you choose this option, you can specify proxy settings if a proxy is required to allow communications to Turbonomic.
  - Proxy hostname or IP address
    
    Specify the address of the proxy used for this target.
  - Proxy port
    
    Specify the port to use with the proxy used for this target. By default, the port is 8080.
  - Proxy username
    
    Specify the username to use with the proxy.
  - Proxy password
    
    Specify the password to use with the proxy.
  - Connect using HTTPS
    
    Select this option if Turbonomic will connect to the proxy through HTTPS.
(Optional) Configure a private container image repository.

By default, the Kubeturbo container images are pulled from IBM Container registry (icr.io). The node to which Kubeturbo deploys must have internet access to pull the images.

To use a private image repository, import the container images first and then specify the Private image repository name. The username and password are optional.
- Private image repository name
- Private image repository username
- Private image repository password
(Optional) Specify your proxy settings.

Note:
If you deployed the secure client to your Turbonomic instance and chose the Automatic option in a previous step, this step does not apply as proxy settings are currently not supported for automatic updates and logging.

Configure proxy settings if a proxy (with or without a username or password) is required to allow communications from the cluster worker nodes to Turbonomic.
- Proxy hostname or IP address
  
  Specify the address of the proxy used for this target.
- Proxy port
  
  Specify the port to use with the proxy used for this target. By default, the port is 8080.
- Proxy username
  
  Specify the username to use with the proxy.
- Proxy password
  
  Specify the password to use with the proxy.
- Connect using HTTPS
  
  Select this option if Turbonomic will connect to the proxy through HTTPS.
Download and run the script.
1. Make sure kubectl is installed and that it can access your cluster.
2. Click Download script.
3. Run the following command. This command makes the script executable and automatically executes it.
```
chmod +x aa.sh &&./aa.sh
```
4. After the script executes, click I ran the script to finish the deployment process.
  
  If the deployment was successful, Kubeturbo automatically adds itself as a container platform target in the Turbonomic user interface, in Settings > Target Configuration.
5. If you need further assistance, contact your Turbonomic representative.

Validating the deployment

Open the Turbonomic user interface and navigate to Settings > Target Configuration. If the deployment was successful, a new container platform target appears in the list.

If you do not see the target, there might be a deployment issue that you need to resolve.

To start troubleshooting an issue, review the Kubeturbo logs. You can retrieve logs by running the following command.
```
kubectl logs kubeturbo-{kubeturbo_pod_ID} -n turbo
```
For example:
```
kubectl logs kubeturbo-asdf1234asd3 -n turbo
```
If you need further assistance, contact your Turbonomic representative.