Skip to content

Latest commit

 

History

History
142 lines (90 loc) · 7 KB

add_kubernetes.md

File metadata and controls

142 lines (90 loc) · 7 KB
Raw

Add a Kubernetes Integration

VMware Aria Operations for Applications (formerly known as Tanzu Observability by Wavefront) provides a comprehensive solution for monitoring Kubernetes. To set up the Kubernetes integration, you must install and configure our Kubernetes Metrics Collector and a Wavefront proxy. With the 2022-48.x release we introduced the Kubernetes Observability Operator which simplifies the deployment of the Kubernetes Metrics Collector and the Wavefront proxy.

The setup process varies based on the distribution type that you choose to monitor.

  1. Log in to your product cluster.
  2. Click Integrations on the toolbar.
  3. In the Featured section, click the Kubernetes tile.
  4. Click Add Integration.

Kubernetes Quick Install Using the Kubernetes Operator

  1. In the Collector Configuration section, configure the deployment options for the cluster.

    1. In the Cluster Name text box provide the name of your Kubernetes cluster.
    2. Choose the Kubernetes Cluster as a distribution type.

  2. Choose whether you want to see the logs for your cluster. By default, the Logs option is enabled.

  3. Choose whether you want to enable or disable Metrics. By default, the Metrics option is enabled.

  4. Choose whether you want to use an HTTP Proxy. If you enable HTTP proxy, to allow outbound traffic, you must add these URLs to your proxy rules:

    In addition, you must also configure the HTTP proxy settings, such as:

    1. Host Name - HTTP proxy host name.
    2. Port - HTTP proxy port number.
    3. HTTP Proxy Authentication - Can be either basic (with user name and password), or CA certificate - based (with a CA certificate).

  5. Enter the authentication options and click Next. You can authenticate to the Operations for Applications REST API using either a user account, or a service account. In both cases, the account must have an Operations for Applications API token associated with it.

  6. In the Script section, review the script and click the Copy to clipboard button.

  7. Run the script in your Kubernetes cluster.

  8. After successful installation, return back to the Operations for Applications UI, and click Finish.

Kubernetes Install in an OpenShift Cluster

Complete the steps below and click Finish.

Note: The Logs feature is not supported when you use OpenShift.

Install and Configure the Operations for Applications Helm Chart on OpenShift Enterprise 4.x

This section contains the installation and configuration steps for full-stack monitoring of OpenShift clusters using the Operations for Applications Helm Chart.

Install the Operations for Applications Helm Chart

  1. Log in to the OpenShift Container Platform web console as an administrator.

  2. Create a project named MyProject.

  3. In the left pane, navigate to Helm and select Install a Helm Chart from the developer catalog.

  4. Search for MyProject and click Install Helm Chart.

  5. Install from the form view tab. Replace the following parameters with your values:

    • clusterName: <OPENSHIFT_CLUSTER_NAME>
    • token: <YOUR_WF_API_TOKEN>
    • url: https://<YOUR_WF_INSTANCE>.wavefront.com

  6. Click Install.

    Because default parameters are used, the Kubernetes Metrics Collector runs as a DaemonSet and uses a Wavefront proxy as a sink. The Collector auto discovers the pods and services that expose metrics and dynamically starts collecting metrics for the targets. It collects metrics from the Kubernetes API server, if configured.

    Now, go back to your Operations for Applications cluster and search for the OPENSHIFT_CLUSTER_NAME in the Kubernetes integration dashboards.

Configure the Collector to Use an Existing Proxy

To configure the Kubernetes Metrics Collector to use a Wavefront proxy that's already running in your environment, follow these steps:

  1. In the OpenShift Container Platform web console, on the yaml view tab, in the proxy section, set enabled to false:

          proxy:
        enabled: false

  2. On the yaml view tab, add proxyAddress under collector.

         collector:
       proxyAddress: <YOUR_WF_PROXY_ADDRESS>:2878

  3. Click Install.

Advanced Wavefront Proxy Configuration

You can configure the proxy to change how it processes your data, port numbers, metric prefix, etc.

Configure the Wavefront Proxy Preprocessor Rules

Preprocessor rules allow you to manipulate incoming metrics before they reach the proxy. For example, you can remove confidential text strings or replace unacceptable characters. Follow these steps to create a ConfigMap with custom preprocessor rules:

  1. In the left pane, navigate to Helm, and choose your installation.

  2. Under Actions, click Upgrade.

  3. On the yaml view tab, under proxy, add preprocessor.

      proxy:
        preprocessor:
          rules.yaml: |
            '2878':
              # fix %2F to be a / instead.  May be required on EKS.
              - rule    : fix-forward-slash
                action  : replaceRegex
                scope   : pointLine
                search  : "%2F"
                replace : "/"
              # replace bad characters ("&", "$", "!", "@") with underscores in the entire point line string
              - rule    : replace-badchars
                action  : replaceRegex
                scope   : pointLine
                search  : "[&\\$!@]"
                replace : "_"
  1. Click Upgrade.

Install and Configure the Collector on OpenShift Enterprise 3.x

Note: The Helm or manually installed Kubernetes Metrics Collector and Wavefront proxy is deprecated and has reached EOL. Our Observability for Kubernetes Operator replaces the Helm or manually installed Kubernetes Metrics Collector and Wavefront proxy for all Kubernetes Distributions except for the OpenShift Container Platform.

Our Collector supports monitoring of OpenShift clusters:

Learn More