Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions config/_default/menus/main.en.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6640,16 +6640,21 @@ menu:
parent: log_management_heading
identifier: cloudprem
weight: 30000
- name: Quickstart
url: /cloudprem/quickstart
parent: cloudprem
identifier: cloudprem_quickstart
weight: 1
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- name: Architecture
url: /cloudprem/architecture
parent: cloudprem
identifier: cloudprem_architecture
weight: 1
weight: 2
- name: Installation
url: /cloudprem/install
parent: cloudprem
identifier: cloudprem_installation
weight: 2
weight: 3
- name: AWS EKS
url: /cloudprem/install/aws_eks
parent: cloudprem_installation
Expand All @@ -6660,6 +6665,11 @@ menu:
parent: cloudprem_installation
identifier: cloudprem_azure_aks
weight: 202
- name: Install Locally with Docker
url: /cloudprem/install/docker
parent: cloudprem_installation
identifier: cloudprem_docker
weight: 203
- name: Log Ingestion
url: /cloudprem/ingest_logs/
parent: cloudprem
Expand Down
1 change: 1 addition & 0 deletions content/en/cloudprem/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Datadog CloudPrem is a self-hosted log management solution that enables cost-eff
## Get started

{{< whatsnext desc="Follow our guides to get CloudPrem up and running:">}}
{{< nextlink href="/cloudprem/quickstart/" >}}Quickstart: Run CloudPrem locally in 5 minutes{{< /nextlink >}}
{{< nextlink href="/cloudprem/install/" >}}Install CloudPrem{{< /nextlink >}}
{{< nextlink href="/cloudprem/ingest_logs/datadog_agent/" >}}Ingest logs with Datadog Agent{{< /nextlink >}}
{{< nextlink href="/cloudprem/configure/datadog_account" >}}Configure your Datadog account{{< /nextlink >}}
Expand Down
6 changes: 0 additions & 6 deletions content/en/cloudprem/install/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,3 @@ CloudPrem supports the following object storage types:
{{< nextlink href="/cloudprem/install/azure_aks/" >}}Install on Azure AKS{{< /nextlink >}}
{{< nextlink href="/cloudprem/install/docker/" >}}Install locally with Docker for testing{{< /nextlink >}}
{{< /whatsnext >}}

<!-- ## Self-managed Kubernetes

{{< whatsnext desc=" ">}}
{{< nextlink href="cloudprem/install/kubernetes_nginx/" >}}Install on a K8s cluster with NGINX Ingress Controller{{< /nextlink >}}
{{< /whatsnext >}} -->
93 changes: 93 additions & 0 deletions content/en/cloudprem/quickstart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
---
title: CloudPrem Quickstart
description: Get started with CloudPrem locally in less than 5 minutes
further_reading:
- link: "/cloudprem/install/docker/"
tag: "Documentation"
text: "CloudPrem Docker Installation"
- link: "/cloudprem/ingest_logs/rest_api/"
tag: "Documentation"
text: "CloudPrem REST API"
---

{{< callout url="https://www.datadoghq.com/product-preview/cloudprem/" btn_hidden="false" header="CloudPrem is in Preview" >}}
Join the CloudPrem Preview to access new self-hosted log management features.
{{< /callout >}}

## Overview

This quickstart covers the following:
1. Start CloudPrem locally using Docker.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might consider making these steps anchor links down to each section; this can help users if they are, for example, particularly interested in sending a demo log. It's not a long page, though, and there's the right navigation, so I'll leave it up to you.

2. Verify the cluster status.
3. Send a "Hello World" log.
4. View the log in the Datadog Log Explorer.

## Prerequisites

- Ask for the [CloudPrem Preview][1].
- **Datadog API Key**: [Get your API key][2].
- **Docker**: [Install Docker][3].

## Step 1: Start CloudPrem

Run the following command in your terminal to start a local CloudPrem instance. Replace `<YOUR_API_KEY>` with your actual Datadog API Key.

```shell
export DD_API_KEY="<YOUR_API_KEY>"
export DD_SITE="datadoghq.com"

docker run -d \
--name cloudprem \
-v $(pwd)/qwdata:/quickwit/qwdata \
-e DD_SITE=${DD_SITE} \
-e DD_API_KEY=${DD_API_KEY} \
-p 127.0.0.1:7280:7280 \
datadog/cloudprem run
```

## Step 2: Verify status in the CloudPrem console

In Datadog, go to the [CloudPrem console][4] and check that your cluster is connected. You should see the `connected` status.

In the CloudPrem console, you can edit the cluster metadata and rename your cluster to `demo`.

{{< img src="/cloudprem/quickstart/clouprem_console.png" alt="Screenshot of the CloudPrem console showing the cluster connected status" style="width:100%;" >}}

## Step 3: Send a log

In your terminal, send a "Hello World" log entry directly to your local CloudPrem instance using the API:

```shell
curl -X POST "http://localhost:7280/api/v2/logs" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d '[
{
"message": "Hello world from CloudPrem",
"level": "info",
"service": "demo"
}
]'
```

## Step 4: Explore logs

1. Go to the [Datadog Log Explorer][5].
2. On the left facet panel, select the checkbox for your index under **CLOUDPREM INDEXES**.
3. You should see your "Hello world from CloudPrem" log entry.

{{< img src="/cloudprem/quickstart/cloudprem_indexes.png" alt="The CloudPrem index selection in the Datadog Log Explorer" style="width:100%;" >}}

## Next steps

With CloudPrem running, you can:
- [Send logs with the Datadog Agent][6] to automatically collect logs from your containers.
- [Send logs with Observability Pipelines][7].

[1]: https://www.datadoghq.com/product-preview/cloudprem/
[2]: /account_management/api-app-keys/#add-an-api-key-or-client-token
[3]: https://docs.docker.com/get-docker/
[4]: https://app.datadoghq.com/cloudprem
[5]: https://app.datadoghq.com/logs?query=index=cloudprem-demo&storage=hot
[6]: /cloudprem/ingest_logs/datadog_agent
[7]: /cloudprem/ingest_logs/observability_pipelines/
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading