---
id: quickstart
title: Kubernetes Quickstart
sidebar_label: Quickstart
description: Get started with our Kubernetes solution in minutes.
slug: /help/docs/observability/kubernetes/quickstart/
canonical: https://www.sumologic.com/help/docs/observability/kubernetes/quickstart/
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import useBaseUrl from '@docusaurus/useBaseUrl';
import Iframe from 'react-iframe';

This guide will walk you through setting up the [Sumo Logic Kubernetes solution](https://github.com/SumoLogic/sumologic-kubernetes-collection) in a few steps. This will:

* Install the [Sumo Logic Kubernetes Helm Chart](/docs/send-data/kubernetes) in your Kubernetes environment.
* Set up data collection for your Kubernetes environment (orchestration, infrastructure, and app data).
* Install the relevant app dashboards to view data from your Kubernetes environment and share them with others in your org.
* Install the necessary alert monitors to get alerted of any issues.

:::tip
As an alternative to this quickstart, you can use our in-product onboarding to accomplish the same tasks in single setup workflow. Go to **App Catalog** > **Kubernetes** > **Begin Integration**.

<img src={useBaseUrl('img/observability/k8s-onboarding.png')} alt="Kubernetes onboarding" width="800" />
:::

:::training Micro Lesson

<Iframe url="https://fast.wistia.net/embed/iframe/8yo13sfpl2?web_component=true&seo=true&videoFoam=false"
  width="854px"
  height="480px"
  title="MicroLesson - Quick Onboarding with Kubernetes Video"
  id="wistiaVideo"
  className="video-container"
  display="initial"
  position="relative"
  allow="autoplay; fullscreen"
  allowfullscreen
/>

:::

## Prerequisites

* You must have a Sumo Logic account. If you do not have one, [sign up for a free trial](/get-started/sign-up.md).
* Obtain your Sumo Logic [Access ID and Access Key](/docs/manage/security/access-keys).
* Ensure that your Sumo Logic account has the Manage Content and Manage Collector [role capabilities](/docs/manage/users-roles/roles/role-capabilities/).

### Supported versions

A list of supported platforms for the [Sumo Logic Kubernetes solution](https://github.com/SumoLogic/sumologic-kubernetes-collection) can be found [here](https://github.com/SumoLogic/sumologic-kubernetes-collection/tree/main/docs#support-matrix).

### Resource requirements

The [Sumo Logic Kubernetes Helm Chart](https://github.com/SumoLogic/sumologic-kubernetes-collection) uses less than 1 CPU and less than 2 Gi memory deployed in default configuration in single-node Kubernetes environment where only the Sumo Logic Kubernetes Helm Chart is deployed.

However, [resource requests](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) for components of the Sumo Logic Kubernetes Helm Chart are set to a higher level (about 7 CPU and 10 Gi memory).

To deploy the Sumo Logic Kubernetes Helm Chart in the cluster with very limited resources, you need to modify default configuration and decrease resource requests and number of replicas. For example, to decrease resource requests and number of replicas for `otelcol-metrics`, you'd need to add the following configuration to your `values.yaml`:

```yaml
metadata:
  metrics:
    statefulset:
      replicaCount: 1
      resources:
        requests:
          memory: 100Mi
          cpu: 50m
```

:::note
Resource consumption depends on data traffic in your cluster. In clusters with huge data traffic, you will need to increase [resource limits](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.25/#resourcerequirements-v1-core) and/or increase number of replicas for components.
:::

## Installation

This will install the Sumo Logic Kubernetes collection as well as the core [dashboards](/docs/observability/kubernetes/monitoring.md) and [alerts](/docs/observability/kubernetes/alerts).

<Tabs
className="unique-tabs"
defaultValue="helm"
values={[
{label: 'Helm', value: 'helm'},
{label: 'YAML', value: 'yaml'}
]}>

<TabItem value="helm">

1. If this is your first time installing our helm chart, add the [Sumo Logic Helm repo](https://sumologic.github.io/sumologic-kubernetes-collection/):
   ```shell
   helm repo add sumologic https://sumologic.github.io/sumologic-kubernetes-collection
   helm repo update
   ```
1. Get your [Sumo Logic Access ID and Access Key](/docs/manage/security/access-keys) and run the following command:
    ```shell
    helm upgrade --install my-release sumologic/sumologic \
    --namespace=my-namespace \
    --create-namespace \
    --set sumologic.accessId=SUMO_ACCESS_ID \
    --set sumologic.accessKey=SUMO_ACCESS_KEY \
    --set sumologic.clusterName=Kubernetes_cluster \
    --set sumologic.collectorName=kubernetes \
    # To opt out of out-of-box alerts, omit the below line
    --set "sumologic.setup.monitors.notificationEmails={EMAIL ADDRESS}"
    ```

:::tip Helm Values File

If you're adding additional configuration, we recommend using the [helm values files](https://helm.sh/docs/chart_template_guide/values_files/), which should only contain properties you want to change from the [default values.yaml](https://github.com/SumoLogic/sumologic-kubernetes-collection/blob/main/deploy/helm/sumologic/values.yaml) to ensure upgrades behave properly.
:::

</TabItem>
<TabItem value="yaml">

1. Get your [Sumo Logic Access ID and Access Key](/docs/manage/security/access-keys) and run the following command to generate the YAML:
   ```shell
   kubectl run tools \
   -i --quiet --rm \
   --restart=Never \
   --image sumologic/kubernetes-tools:2.9.0 -- \
   template \
   --name-template 'collection' \
   --set sumologic.accessId='SUMO_ACCESS_ID' \
   --set sumologic.accessKey='SUMO_ACCESS_KEY' \
   --set sumologic.collectorName=kubernetes-2022-06-25T20:21:06.131Z \
   # To opt out of out-of-box alerts, omit the below line
   --set "sumologic.setup.monitors.notificationEmails={EMAIL ADDRESS}"
   | tee sumologic.yaml
   ```
1. Install the required CRDs and apply the generated YAML:
   ```shell
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_probes.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_alertmanagers.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_prometheuses.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_prometheusrules.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_servicemonitors.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_podmonitors.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_thanosrulers.yaml \
   kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/v0.43.2/example/prometheus-operator-crd/monitoring.coreos.com_alertmanagerconfigs.yaml \
   kubectl apply -f sumologic.yaml
   ```

</TabItem>
</Tabs>

## Next Steps

To get started, open a new [Kubernetes view](/docs/dashboards/explore-view/#kubernetes-views) and view your Kubernetes appd dashboards.

If you're looking to monitor specific aspects of Kubernetes control plane provided by different cloud vendors (such as GKE, AKS, EKS), you'll need to install those [Sumo Logic Kubernetes Apps](/docs/observability/kubernetes/apps).

If you do not see data in Sumo Logic, review our [troubleshooting guide](/docs/send-data/kubernetes/troubleshoot-collection).

## Additional resources

* [Full List of configuration options](https://github.com/SumoLogic/sumologic-kubernetes-collection/tree/main/deploy/helm/sumologic#configuration)
* [Share a Dashboard](/docs/dashboards/share-dashboard-new.md)
* [Linking Multiple Dashboards](/docs/dashboards/link-dashboards.md)


### Kubernetes partner apps

We provide an array of partner apps designed specifically for Kubernetes. The following CI/CD partner apps are initially available.

<img src={useBaseUrl('img/kubernetes/K8s_PartnerApps_CI-CD.png')} alt="Kubernetes partner apps" style={{border: '1px solid gray'}} width="800" />

### Sumo Logic security partner apps

We also provide a selection of security-focused partner apps with specialized detection and investigation features.

<img src={useBaseUrl('img/kubernetes/K8s_PartnerApps_Security.png')} alt="Sumo Logic Security partner apps" style={{border: '1px solid gray'}} width="800" />

### Get certified

Make the most of our Kubernetes Observability offerings by enrolling in our free training, where you'll learn more about using OpenTelemetry collectors, tracing agents, and our Reliability Management features. The Sumo Kubernetes Analyst Certification is a hands-on class that shows you how to expand your knowledge of Kubernetes by solving common use cases.

<a href="https://www.sumologic.com/learn/training/"><img src={useBaseUrl('img/kubernetes/K8s_Kubernetes_Analyst_Cert.png')} alt="Kubernetes Analyst Cert icon" width="450"/></a>