Skip to content

Commit 2fe9911

Browse files
fmassotestherk15guilload
authored
Update CloudPrem doc (#31136)
* Update CloudPrem doc * Remove private label on docs, add left nav * Fix typo * Fixing wording, whatsnext description * Reorg cloudprem docs and update links. * Fix cloudprem menu. * Fix cloudprem menu * Move cloudprem aws configuration in configure folder. * Fix cloudprem architecture in the menu * Fix cloudprem op image path. * Remove pipeline ID from cloudprem op page * Fix cloudprem OP image url and page links * Fix links and file names for docs style * Frontmatter, formatting, and url fixes * Apply suggestions from code review Co-authored-by: Esther Kim <[email protected]> * CLOUDPREM-137: Add documentation for Azure (#31254) * CLOUDPREM-137: Add documentation for Azure * Formatting fixes --------- Co-authored-by: Esther Kim <[email protected]> * Move prerequisite to install landing page --------- Co-authored-by: Esther Kim <[email protected]> Co-authored-by: Adrien Guillo <[email protected]>
1 parent de25d62 commit 2fe9911

22 files changed

+1246
-246
lines changed

‎config/_default/menus/main.en.yaml‎

Lines changed: 101 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5899,12 +5899,107 @@ menu:
58995899
parent: log_troubleshooting
59005900
identifier: log_troubleshooting_live_tail
59015901
weight: 1101
5902-
# - name: CloudPrem
5903-
# pre: cloud
5904-
# url: cloudprem/
5905-
# parent: log_management_heading
5906-
# identifier: cloud_prem
5907-
# weight: 30000
5902+
- name: CloudPrem
5903+
pre: upload-wui
5904+
url: cloudprem/
5905+
parent: log_management_heading
5906+
identifier: cloudprem
5907+
weight: 30000
5908+
- name: Architecture
5909+
url: /cloudprem/architecture
5910+
parent: cloudprem
5911+
identifier: cloudprem_architecture
5912+
weight: 1
5913+
- name: Installation
5914+
url: /cloudprem/install
5915+
parent: cloudprem
5916+
identifier: cloudprem_installation
5917+
weight: 2
5918+
- name: AWS EKS
5919+
url: /cloudprem/install/aws_eks
5920+
parent: cloudprem_installation
5921+
identifier: cloudprem_aws_eks
5922+
weight: 201
5923+
- name: Azure AKS
5924+
url: /cloudprem/install/azure_aks
5925+
parent: cloudprem_installation
5926+
identifier: cloudprem_azure_aks
5927+
weight: 202
5928+
# - name: Kubernetes with NGINX
5929+
# url: /cloudprem/install/kubernetes_nginx
5930+
# parent: cloudprem_installation
5931+
# identifier: cloudprem_kubernetes_nginx
5932+
# weight: 203
5933+
- name: Log Ingestion
5934+
url: /cloudprem/ingest_logs/
5935+
parent: cloudprem
5936+
identifier: cloudprem_log_ingestion
5937+
weight: 3
5938+
- name: Datadog Agent
5939+
url: /cloudprem/ingest_logs/datadog_agent
5940+
parent: cloudprem_log_ingestion
5941+
identifier: cloudprem_ingest_datadog_agent
5942+
weight: 301
5943+
- name: Observability Pipelines
5944+
url: /cloudprem/ingest_logs/observability_pipelines
5945+
parent: cloudprem_log_ingestion
5946+
identifier: cloudprem_ingest_observability_pipelines
5947+
weight: 302
5948+
- name: REST API
5949+
url: /cloudprem/ingest_logs/rest_api/
5950+
parent: cloudprem_log_ingestion
5951+
identifier: cloudprem_ingest_api
5952+
weight: 304
5953+
- name: Configuration
5954+
url: /cloudprem/configure/
5955+
parent: cloudprem
5956+
identifier: cloudprem_advanced_configuration
5957+
weight: 4
5958+
- name: Datadog Account
5959+
url: /cloudprem/configure/datadog_account
5960+
parent: cloudprem_advanced_configuration
5961+
identifier: cloudprem_datadog_account
5962+
weight: 401
5963+
- name: AWS Configuration
5964+
url: /cloudprem/configure/aws_config
5965+
parent: cloudprem_advanced_configuration
5966+
identifier: cloudprem_aws_configuration
5967+
weight: 402
5968+
- name: Azure Configuration
5969+
url: /cloudprem/configure/azure_config
5970+
parent: cloudprem_advanced_configuration
5971+
identifier: cloudprem_azure_configuration
5972+
weight: 403
5973+
- name: Cluster Sizing
5974+
url: /cloudprem/configure/cluster_sizing
5975+
parent: cloudprem_advanced_configuration
5976+
identifier: cloudprem_cluster_sizing
5977+
weight: 404
5978+
- name: Ingress
5979+
url: /cloudprem/configure/ingress
5980+
parent: cloudprem_advanced_configuration
5981+
identifier: cloudprem_ingress
5982+
weight: 405
5983+
- name: Processing
5984+
url: /cloudprem/configure/processing
5985+
parent: cloudprem_advanced_configuration
5986+
identifier: cloudprem_processing
5987+
weight: 406
5988+
- name: Management
5989+
url: /cloudprem/manage/
5990+
parent: cloudprem
5991+
identifier: cloudprem_manage
5992+
weight: 5
5993+
- name: Supported Features
5994+
url: /cloudprem/supported_features/
5995+
parent: cloudprem
5996+
identifier: cloudprem_supported_features
5997+
weight: 6
5998+
- name: Troubleshooting
5999+
url: /cloudprem/troubleshooting/
6000+
parent: cloudprem
6001+
identifier: cloudprem_troubleshooting
6002+
weight: 7
59086003
- name: Security Overview
59096004
url: security/
59106005
pre: security-platform

‎content/en/cloudprem/_index.md‎

Lines changed: 8 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,22 @@
11
---
22
title: CloudPrem
33
description: Learn how to deploy and manage Datadog CloudPrem, a self-hosted log management solution for cost-effective log ingestion, processing, indexing, and search capabilities
4-
private: true
54
---
65

7-
<div class="alert alert-warning">CloudPrem is in Preview.</div>
8-
9-
## Overview
6+
{{< callout btn_hidden="true" >}}
7+
Datadog CloudPrem is in Preview.
8+
{{< /callout >}}
109

1110
{{< img src="/cloudprem/overview_diagram_cloudprem.png" alt="CloudPrem architecture overview showing how logs flow from sources through CloudPrem to the Datadog platform" style="width:100%;" >}}
1211

1312
Datadog CloudPrem is a self-hosted log management solution that enables cost-effective log ingestion, processing, indexing, and search capabilities within your own infrastructure. Built to meet data residency, stringent security, and high-volume requirements, CloudPrem integrates with the Datadog platform to provide log analysis, visualization, and alerting — all while keeping your log data at rest within your infrastructure boundaries.
1413

1514
## Get started
1615

17-
{{< whatsnext >}}
18-
{{< nextlink href="/cloudprem/installation/" >}}Install CloudPrem and Send Logs with the Agent {{< /nextlink >}}
19-
{{< nextlink href="/cloudprem/ingress/" >}}Configure CloudPrem Ingress{{< /nextlink >}}
20-
{{< nextlink href="/cloudprem/aws_config" >}}Configure AWS{{< /nextlink >}}
21-
{{< nextlink href="/cloudprem/processing/" >}}Configure CloudPrem Log Processing{{< /nextlink >}}
22-
{{< nextlink href="/cloudprem/cluster/" >}}Learn more about Cluster Sizing and Operations{{< /nextlink >}}
23-
{{< nextlink href="/cloudprem/architecture/" >}}Learn more about CloudPrem Architecture{{< /nextlink >}}
24-
{{< nextlink href="/cloudprem/troubleshooting/" >}}Troubleshooting{{< /nextlink >}}
16+
{{< whatsnext desc="Follow our guides to get CloudPrem up and running:">}}
17+
{{< nextlink href="/cloudprem/install/" >}}Install CloudPrem{{< /nextlink >}}
18+
{{< nextlink href="/cloudprem/ingest_logs/datadog_agent/" >}}Ingest logs with Datadog Agent{{< /nextlink >}}
19+
{{< nextlink href="/cloudprem/configure/datadog_account" >}}Configure your Datadog account{{< /nextlink >}}
20+
{{< nextlink href="/cloudprem/architecture/" >}}Understand CloudPrem architecture{{< /nextlink >}}
2521
{{< /whatsnext >}}
2622

27-
28-
[1]: https://kubernetes-sigs.github.io/aws-load-balancer-controller/latest/deploy/installation/
29-
[2]: /cloudprem/installation/
30-
[3]: /cloudprem/processing/
31-
[4]: /cloudprem/architecture/

‎content/en/cloudprem/architecture.md‎

Lines changed: 5 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,14 @@
11
---
22
title: Architecture
3-
private: true
43
further_reading:
5-
- link: "/cloudprem/"
4+
- link: "/cloudprem/install/"
65
tag: "Documentation"
7-
text: "CloudPrem Overview"
8-
- link: "/cloudprem/installation/"
9-
tag: "Documentation"
10-
text: "Install CloudPrem and Send Logs with the Agent"
11-
- link: "/cloudprem/ingress/"
12-
tag: "Documentation"
13-
text: "Configure CloudPrem Ingress"
14-
- link: "/cloudprem/aws_config"
15-
tag: "Documentation"
16-
text: "Configure AWS"
17-
- link: "/cloudprem/processing/"
18-
tag: "Documentation"
19-
text: "Configure CloudPrem Log Processing"
20-
- link: "/cloudprem/cluster/"
21-
tag: "Documentation"
22-
text: "Learn more about Cluster Sizing and Operations"
23-
- link: "/cloudprem/troubleshooting/"
24-
tag: "Documentation"
25-
text: "Troubleshooting"
6+
text: "CloudPrem Installation Prerequisites"
267
---
278

28-
<div class="alert alert-warning">CloudPrem is in Preview.</div>
9+
{{< callout btn_hidden="true" >}}
10+
Datadog CloudPrem is in Preview.
11+
{{< /callout >}}
2912

3013
## Overview
3114

‎content/en/cloudprem/configure/_index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: Configure CloudPrem
3+
description: Learn how to configure and customize your CloudPrem deployment for optimal performance and security
4+
---
5+
6+
{{< callout btn_hidden="true" >}}
7+
Datadog CloudPrem is in Preview.
8+
{{< /callout >}}
9+
10+
## Overview
11+
12+
After installing CloudPrem, you can configure your deployment to meet your environment, security, and performance requirements. Key configuration areas include account integration, cloud resource setup, cluster sizing, ingress, and processing options. These settings allow you to tailor CloudPrem for your specific needs.
13+
14+
{{< whatsnext desc="Customize your CloudPrem deployment:">}}
15+
{{< nextlink href="/cloudprem/configure/datadog_account/" >}}Configure your Datadog account{{< /nextlink >}}
16+
{{< nextlink href="/cloudprem/configure/aws_config/" >}}AWS Configuration{{< /nextlink >}}
17+
{{< nextlink href="/cloudprem/configure/azure_config/" >}}Azure Configuration{{< /nextlink >}}
18+
{{< nextlink href="/cloudprem/configure/cluster_sizing/" >}}Size your cluster{{< /nextlink >}}
19+
{{< nextlink href="/cloudprem/configure/ingress/" >}}Configure Ingress{{< /nextlink >}}
20+
{{< nextlink href="/cloudprem/configure/processing/" >}}Configure processing{{< /nextlink >}}
21+
{{< /whatsnext >}}

‎content/en/cloudprem/aws_config.md‎ renamed to ‎content/en/cloudprem/configure/aws_config.md‎

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,33 @@
11
---
22
title: AWS Configuration
33
description: Learn how to configure AWS for CloudPrem
4-
private: true
54
further_reading:
6-
- link: "/cloudprem/"
5+
- link: "/cloudprem/install/aws_eks/"
76
tag: "Documentation"
8-
text: "CloudPrem Overview"
9-
- link: "/cloudprem/installation/"
7+
text: "Install CloudPrem on AWS EKS"
8+
- link: "/cloudprem/ingest_logs/"
109
tag: "Documentation"
11-
text: "Install CloudPrem and Send Logs with the Agent"
12-
- link: "/cloudprem/ingress/"
13-
tag: "Documentation"
14-
text: "Configure CloudPrem Ingress"
15-
- link: "/cloudprem/processing/"
16-
tag: "Documentation"
17-
text: "Configure CloudPrem Log Processing"
18-
- link: "/cloudprem/cluster/"
19-
tag: "Documentation"
20-
text: "Learn more about Cluster Sizing and Operations"
21-
- link: "/cloudprem/architecture/"
22-
tag: "Documentation"
23-
text: "Learn more about CloudPrem Architecture"
24-
- link: "/cloudprem/troubleshooting/"
25-
tag: "Documentation"
26-
text: "Troubleshooting"
10+
text: "Configure Log Ingestion"
2711
---
2812

13+
{{< callout btn_hidden="true" >}}
14+
Datadog CloudPrem is in Preview.
15+
{{< /callout >}}
16+
2917
## Overview
3018

31-
This guide covers how to configure your AWS account for CloudPrem. For ingress configuration, see [CloudPrem Ingress Configuration][1].
19+
This guide covers how to configure your AWS account prerequisites for CloudPrem deployment. This configuration is required before installing CloudPrem on AWS EKS.
20+
21+
For the complete EKS installation process, see the [AWS EKS Installation Guide][1].
22+
23+
## AWS prerequisites
3224

3325
To deploy CloudPrem on AWS, you need to configure:
34-
- AWS credentials
35-
- AWS region
36-
- IAM permissions for S3
26+
- AWS credentials and authentication
27+
- AWS region selection
28+
- IAM permissions for S3 object storage
29+
- RDS PostgreSQL database (recommended)
30+
- EKS cluster with AWS Load Balancer Controller
3731

3832
## AWS credentials
3933

@@ -68,8 +62,7 @@ Required authorized actions:
6862

6963
Here is an example of a bucket policy:
7064

71-
```
72-
65+
```json
7366
{
7467
"Version": "2012-10-17",
7568
"Statement": [
@@ -99,9 +92,19 @@ Here is an example of a bucket policy:
9992
}
10093
```
10194

95+
## Next steps
96+
97+
After completing the AWS configuration:
98+
99+
1. **Install CloudPrem on EKS** - Follow the [AWS EKS Installation Guide][1] to deploy CloudPrem
100+
2. **Configure ingress** - Set up [ingress configuration][3] for external access
101+
3. **Set up log ingestion** - Configure [log ingestion][4] to start sending logs to CloudPrem
102+
102103
## Further reading
103104

104105
{{< partial name="whats-next/whats-next.html" >}}
105106

106-
[1]: /cloudprem/ingress/
107+
[1]: /cloudprem/install/aws_eks
107108
[2]: https://docs.rs/rusoto_credential/latest/rusoto_credential/struct.ChainProvider.html
109+
[3]: /cloudprem/configure/ingress/
110+
[4]: /cloudprem/ingest_logs/

0 commit comments

Comments
 (0)