Install Kubernetes 2.0 Agent

This section provides detailed instructions for installing and managing the Kubernetes 2.0 Agent on a Kubernetes Cluster. Follow these steps:

Prerequisites

Helm command to be installed on the server through which your Kubernetes cluster is being managed using kubectl/oc commands
Ensure that the Helm repository is accessible from the user cluster.
The Agent repository must also be reachable from the user cluster.

Note

If you want to ingest Logs into the platform, please set Yes in the Enable Log Management section on the client registration page. To enable this, navigate to Setup > Account > Clients and select your client name in the OpsRamp portal.

Step 1: Configure Kubernetes 2.0 Integration

To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
Note: You may either type your client’s name in the search bar or select your client from the list.
Navigate to Setup > Account. The Account Details screen will appear.
Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
Note: If no applications are installed, you will be directed to the Available Integrations page, displaying all available applications, including the newly activated Kubernetes 2.0 integration.
Click + ADD on the Installed Integrations page.
Note: Search for the integration by entering Kubernetes 2.0 or by selecting Container Orchestration category from the All Categories dropdown list.
Click ADD in the Kubernetes 2.0 tile.
The Configuration screen appears, click + ADD.
Enter the following Basic Information.

Field Name	Description	Field Type
Name	Enter the name for the configuration.	String
Distribution Type	Select the Distribution Type from following. K8S: Open-source platform for automating deployment, scaling, and management of containerized applications. EKS: AWS-managed service that simplifies Kubernetes cluster deployment and management. AKS: Microsoft Azure's managed service for deploying and managing containerized applications with Kubernetes. GKE: Google Cloud's managed environment for deploying and scaling containerized applications using Kubernetes.. K3S: Lightweight Kubernetes distribution optimized for resource-constrained environments and edge computing. MicroK8s: Minimalistic Kubernetes distribution by Canonical, ideal for local development and IoT applications. RKE2: Secure and simple next-generation Kubernetes distribution from Rancher for production workloads. OKD : Upstream community version of Red Hat OpenShift for developing and deploying containerized applications.	Dropdown

Choose the required Metric Receivers based on your monitoring needs. A detailed list of available metrics for each receiver can be found here.
Under the Additional Settings section, you can configure the following options:
- Kube-Events: Choose whether to enable or disable Kube-Events for monitoring Kubernetes event logs.
- Log Management: If Log Management is enabled at the client level, you will see an option to enable or disable log collection from the cluster. Enabling this will allow the platform to ingest logs for better visibility and analysis.
- Trace Management: If Trace Management is enabled at the client level, you will have the option to enable tracing from the cluster. Additionally, you can specify the number of tracing-proxy replica pods required to manage the tracing workload efficiently.
Click ADD to apply the selected settings and complete the setup.
Once the configuration is saved, the cluster will be created and it will be appear on the configurations page.
Note
1. Each configuration having one cluster. To create another cluster, click + ADD button again, as shown in the figure above.
2. Bypass Resource Reconciliation: Select this checkbox to bypass resource reconciliation for resources discovered through multiple apps. multiple apps.

Manage the Configured Cluster

Once the configuration is created, you can manage it by clicking the ellipsis (…). The below options are available:

Edit: Modify the Distribution Type and click Update.
Remove: This will delete all resources and related metrics associated with the configuration.
Instruction: Detailed instructions to install the OpsRamp Agent on Kubernetes cluster.
Download YAML: Link to download the YAML file.
View Logs: Click to view the logs details.
Copy UID: Hover over the UID, then click the copy button to copy the UID.

Manage the Kubernetes 2.0 Integration

For detailed instructions on modifying an installed integration, see the Modify an Installed Integration or Application article.

Step 2: Download and Copy the opsramp-agent-values.yaml file

Download

Click the ellipsis (…) next to the configuration and select Download YAML.
The YAML file will be downloaded in your local system.
Please remember that you downloaded the YAML file location path.

Copy:

Click the ellipsis (…) next to the configuration and select Instructions.
The YAML content will be displayed on the screen.
Click on the Copy button to copy the yaml content.
You can store this copied content in one file, for example, opsramp-agent-values.yaml.

For example, the downloaded or copied file would look like the one below.

agent:
  config:
    masterUuid: "INTG-<integration UUID>"
    appServer: "<app-server-URL>"
    clientId: "<some client ID>"
    integrationResUuid: "<integration UUID>"
    kubernetesType: "<type-of-k8s-distro>"
    enableLogManagement: "TRUE"
    clusterUuid: "<cluster-UUID>"
    clusterName: "<name-of-the-cluster-you-have-given>"
    appConfigId: "ADAPTER-MANIFEST-<app-Config-ID>"
    sdkAppName: "Kubernetes-2.0"
    apiKey: "<api-key>"
    apiSecret: "<api-secret>"
    metricEndpoint: "<opsramp endpoint>"
    metricAuthTokenUrl: "<opsramp URL>"
    logLevel: "warn"

Step 3: Install Kubernetes 2.0 Agent on Kubernetes Cluster

Log in to your server/host and ensure your kubeconfig is pointing to the Kubernetes cluster.
Before we go to the next step, please copy the path of the file you downloaded or copied from the last step we require while running the command below.

Now, with the location of the path, run the following helm command to install the OpsRamp Agent on the cluster:

helm install opsramp oci://us-docker.pkg.dev/opsramp-registry/agent-helm-charts/agent -n opsramp-agent --create-namespace --values <download-file-path-or-copied-file-path>.yaml

Install Kubernetes 2.0 Agent behind a Proxy

To install the agent behind the proxy, the user can update the downloaded or copied manifest from Step 2 with the following values.
```
    connMode: "proxy"
    proxyProto: ""
    proxyServer: ""
    proxyPort: ""
    proxyUser: ""
    proxyPassword: ""
```
The above details tell about the proxy URL details.

For example, with the above fields, our config would become:

agent:
  config:
    masterUuid: "INTG-<integration UUID>"
    appServer: "<app-server-URL>"
    clientId: "<some client ID>"
    integrationResUuid: "<integration UUID>"
    kubernetesType: "<type-of-k8s-distro>"
    enableLogManagement: "TRUE"
    clusterUuid: "<cluster-UUID>"
    clusterName: "<name-of-the-cluster-you-have-given>"
    appConfigId: "ADAPTER-MANIFEST-<app-Config-ID>"
    sdkAppName: "Kubernetes-2.0"
    apiKey: "<api-key>"
    apiSecret: "<api-secret>"
    metricEndpoint: "<opsramp endpoint>"
    metricAuthTokenUrl: "<opsramp URL>"
    logLevel: "warn"
    connMode: "proxy"
    proxyProto: "http"
    proxyServer: "proxy.example.com"
    proxyPort: "8080"
    proxyUser: "monitoring_user"
    proxyPassword: "securepassword123"

Then, proceed to Step 3 to install the Agent.