https://github.com/massdriver-cloud/k8s-datadog
https://github.com/massdriver-cloud/k8s-datadog
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/massdriver-cloud/k8s-datadog
- Owner: massdriver-cloud
- Created: 2023-04-15T22:45:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-09-20T16:20:57.000Z (9 months ago)
- Last Synced: 2025-01-23T03:13:47.421Z (5 months ago)
- Language: HCL
- Homepage: https://massdriver.cloud
- Size: 27.3 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![Massdriver][logo]][website]
# k8s-datadog
[![Release][release_shield]][release_url]
[![Contributors][contributors_shield]][contributors_url]
[![Forks][forks_shield]][forks_url]
[![Stargazers][stars_shield]][stars_url]
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
This chart installs the Datadog Agent into your Kubernetes cluster to collect and send observability information to Datadog
---
## Design
For detailed information, check out our [Operator Guide](operator.md) for this bundle.
## Usage
Our bundles aren't intended to be used locally, outside of testing. Instead, our bundles are designed to be configured, connected, deployed and monitored in the [Massdriver][website] platform.
### What are Bundles?
Bundles are the basic building blocks of infrastructure, applications, and architectures in [Massdriver][website]. Read more [here](https://docs.massdriver.cloud/concepts/bundles).
## Bundle
### Params
Form input parameters for configuring a bundle for deployment.
View
## Properties
- **`clusterAgent`** *(object)*
- **`metricsProvider`** *(object)*
- **`enabled`** *(boolean)*: Default: `True`.
- **`datadog`** *(object)*
- **`apiKey`** *(string)*
- **`apm`** *(object)*
- **`portEnabled`** *(boolean)*: Enable Application Performance Monitoring. Default: `True`.
- **`dogstatsd`** *(object)*
- **`useHostPort`** *(boolean)*: Bind to and expose the Host port. This is required for custom metrics. Default: `True`.
- **`env`** *(array)*: Review [Datadog's documentation](https://docs.datadoghq.com/agent/docker/?tab=standard#environment-variables) on supported environment variables). Default: `[]`.
- **Items** *(object)*
- **`name`** *(string)*
- **`value`** *(string)*
- **`logs`** *(object)*
- **`enabled`** *(boolean)*: Default: `True`.
- **`site`** *(string)*: The site of the Datadog intake to send Agent data to. Normally the default \"datadoghq.com\" is fine, but during Datadog setup you may need to use a specific endpoint. Must be one of: `['datadoghq.com', 'datadoghq.eu', 'us3.datadoghq.com', 'us5.datadoghq.com', 'ddog-gov.com']`. Default: `datadoghq.com`.
- **`namespace`** *(string)*: Default: `datadog`.
- **`networkMonitoring`** *(object)*
- **`enabled`** *(boolean)*: Enable [network performance monitoring](https://docs.datadoghq.com/network_monitoring/performance/). Default: `True`.
- **`securityAgent`** *(object)*
- **`runtime`** *(object)*
- **`enabled`** *(boolean)*: Set to true to enable [Cloud Workload Security (CWS)](https://www.datadoghq.com/product/cloud-security-management/cloud-workload-security/). Default: `True`.
- **`systemProbe`** *(object)*
- **`enableOOMKill`** *(boolean)*: Enable the [OOM kill eBPF-based](https://docs.datadoghq.com/integrations/oom_kill/) check. Default: `True`.
- **`enableTCPQueueLength`** *(boolean)*: Enable the [TCP queue length eBPF-based](https://docs.datadoghq.com/integrations/tcp_queue_length/) check. Default: `True`.
### Connections
Connections from other bundles that this bundle depends on.
View
## Properties
- **`kubernetes_cluster`** *(object)*: Kubernetes cluster authentication and cloud-specific configuration. Cannot contain additional properties.
- **`data`** *(object)*
- **`authentication`** *(object)*
- **`cluster`** *(object)*
- **`certificate-authority-data`** *(string)*
- **`server`** *(string)*
- **`user`** *(object)*
- **`token`** *(string)*
- **`infrastructure`** *(object)*: Cloud specific Kubernetes configuration data.
- **One of**
- AWS EKS infrastructure config*object*: . Cannot contain additional properties.
- **`arn`** *(string)*: Amazon Resource Name.
Examples:
```json
"arn:aws:rds::ACCOUNT_NUMBER:db/prod"
```
```json
"arn:aws:ec2::ACCOUNT_NUMBER:vpc/vpc-foo"
```
- **`oidc_issuer_url`** *(string)*: An HTTPS endpoint URL.
Examples:
```json
"https://example.com/some/path"
```
```json
"https://massdriver.cloud"
```
- Infrastructure Config*object*: Azure AKS Infrastructure Configuration. Cannot contain additional properties.
- **`ari`** *(string)*: Azure Resource ID.
Examples:
```json
"/subscriptions/12345678-1234-1234-abcd-1234567890ab/resourceGroups/resource-group-name/providers/Microsoft.Network/virtualNetworks/network-name"
```
- **`oidc_issuer_url`** *(string)*
- GCP Infrastructure GRN*object*: Minimal GCP Infrastructure Config. Cannot contain additional properties.
- **`grn`** *(string)*: GCP Resource Name (GRN).
Examples:
```json
"projects/my-project/global/networks/my-global-network"
```
```json
"projects/my-project/regions/us-west2/subnetworks/my-subnetwork"
```
```json
"projects/my-project/topics/my-pubsub-topic"
```
```json
"projects/my-project/subscriptions/my-pubsub-subscription"
```
```json
"projects/my-project/locations/us-west2/instances/my-redis-instance"
```
```json
"projects/my-project/locations/us-west2/clusters/my-gke-cluster"
```
- **`specs`** *(object)*
- **`aws`** *(object)*: .
- **`region`** *(string)*: AWS Region to provision in.
Examples:
```json
"us-west-2"
```
- **`azure`** *(object)*: .
- **`region`** *(string)*: Select the Azure region you'd like to provision your resources in.
- **`gcp`** *(object)*: .
- **`project`** *(string)*
- **`region`** *(string)*: The GCP region to provision resources in.
Examples:
```json
"us-east1"
```
```json
"us-east4"
```
```json
"us-west1"
```
```json
"us-west2"
```
```json
"us-west3"
```
```json
"us-west4"
```
```json
"us-central1"
```
- **`kubernetes`** *(object)*: Kubernetes distribution and version specifications.
- **`cloud`** *(string)*: Must be one of: `['aws', 'gcp', 'azure']`.
- **`distribution`** *(string)*: Must be one of: `['eks', 'gke', 'aks']`.
- **`platform_version`** *(string)*
- **`version`** *(string)*
### Artifacts
Resources created by this bundle that can be connected to other bundles.
View
## Properties
## Contributing
### Bug Reports & Feature Requests
Did we miss something? Please [submit an issue](https://github.com/massdriver-cloud/k8s-datadog/issues) to report any bugs or request additional features.
### Developing
**Note**: Massdriver bundles are intended to be tightly use-case scoped, intention-based, reusable pieces of IaC for use in the [Massdriver][website] platform. For this reason, major feature additions that broaden the scope of an existing bundle are likely to be rejected by the community.
Still want to get involved? First check out our [contribution guidelines](https://docs.massdriver.cloud/bundles/contributing).
### Fix or Fork
If your use-case isn't covered by this bundle, you can still get involved! Massdriver is designed to be an extensible platform. Fork this bundle, or [create your own bundle from scratch](https://docs.massdriver.cloud/bundles/development)!
## Connect
Questions? Concerns? Adulations? We'd love to hear from you!
Please connect with us!
[![Email][email_shield]][email_url]
[![GitHub][github_shield]][github_url]
[![LinkedIn][linkedin_shield]][linkedin_url]
[![Twitter][twitter_shield]][twitter_url]
[![YouTube][youtube_shield]][youtube_url]
[![Reddit][reddit_shield]][reddit_url]
[logo]: https://raw.githubusercontent.com/massdriver-cloud/docs/main/static/img/logo-with-logotype-horizontal-400x110.svg
[docs]: https://docs.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=docs
[website]: https://www.massdriver.cloud/?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=website
[github]: https://github.com/massdriver-cloud?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=github
[slack]: https://massdriverworkspace.slack.com/?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=slack
[linkedin]: https://www.linkedin.com/company/massdriver/?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=linkedin
[contributors_shield]: https://img.shields.io/github/contributors/massdriver-cloud/k8s-datadog.svg?style=for-the-badge
[contributors_url]: https://github.com/massdriver-cloud/k8s-datadog/graphs/contributors
[forks_shield]: https://img.shields.io/github/forks/massdriver-cloud/k8s-datadog.svg?style=for-the-badge
[forks_url]: https://github.com/massdriver-cloud/k8s-datadog/network/members
[stars_shield]: https://img.shields.io/github/stars/massdriver-cloud/k8s-datadog.svg?style=for-the-badge
[stars_url]: https://github.com/massdriver-cloud/k8s-datadog/stargazers
[issues_shield]: https://img.shields.io/github/issues/massdriver-cloud/k8s-datadog.svg?style=for-the-badge
[issues_url]: https://github.com/massdriver-cloud/k8s-datadog/issues
[release_url]: https://github.com/massdriver-cloud/k8s-datadog/releases/latest
[release_shield]: https://img.shields.io/github/release/massdriver-cloud/k8s-datadog.svg?style=for-the-badge
[license_shield]: https://img.shields.io/github/license/massdriver-cloud/k8s-datadog.svg?style=for-the-badge
[license_url]: https://github.com/massdriver-cloud/k8s-datadog/blob/main/LICENSE
[email_url]: mailto:[email protected]
[email_shield]: https://img.shields.io/badge/email-Massdriver-black.svg?style=for-the-badge&logo=mail.ru&color=000000
[github_url]: mailto:[email protected]
[github_shield]: https://img.shields.io/badge/follow-Github-black.svg?style=for-the-badge&logo=github&color=181717
[linkedin_url]: https://linkedin.com/in/massdriver-cloud
[linkedin_shield]: https://img.shields.io/badge/follow-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&color=0A66C2
[twitter_url]: https://twitter.com/massdriver?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=twitter
[twitter_shield]: https://img.shields.io/badge/follow-Twitter-black.svg?style=for-the-badge&logo=twitter&color=1DA1F2
[discourse_url]: https://community.massdriver.cloud?utm_source=github&utm_medium=readme&utm_campaign=k8s-datadog&utm_content=discourse
[discourse_shield]: https://img.shields.io/badge/join-Discourse-black.svg?style=for-the-badge&logo=discourse&color=000000
[youtube_url]: https://www.youtube.com/channel/UCfj8P7MJcdlem2DJpvymtaQ
[youtube_shield]: https://img.shields.io/badge/subscribe-Youtube-black.svg?style=for-the-badge&logo=youtube&color=FF0000
[reddit_url]: https://www.reddit.com/r/massdriver
[reddit_shield]: https://img.shields.io/badge/subscribe-Reddit-black.svg?style=for-the-badge&logo=reddit&color=FF4500