diff --git a/.gitignore b/.gitignore index 341d0e67fe5..6adb6ccbeca 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ content/en/developers/integrations/*.md content/en/developers/amazon_cloudformation.md # Agent section +content/en/agent/basic_agent_usage/chef.md content/en/agent/basic_agent_usage/heroku.md content/en/agent/basic_agent_usage/puppet.md diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 74e05df4c0f..f22e5b374b5 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -106,7 +106,7 @@ build_live: variables: CONFIG: ${LIVE_CONFIG} URL: ${LIVE_DOMAIN} - UNTRACKED_EXTRAS: "data,content/en/integrations,content/en/agent/basic_agent_usage/heroku.md,content/en/agent/basic_agent_usage/puppet.md,content/en/developers/integrations,content/en/developers/amazon_cloudformation.md" + UNTRACKED_EXTRAS: "data,content/en/integrations,content/en/agent/basic_agent_usage/heroku.md,content/en/agent/basic_agent_usage/chef.md,content/en/agent/basic_agent_usage/puppet.md,content/en/developers/integrations,content/en/developers/amazon_cloudformation.md" CONFIGURATION_FILE: "./local/bin/py/build/configurations/pull_config.yaml" LOCAL: "False" script: diff --git a/Makefile b/Makefile index 84fdd70e9ba..c9454ee7535 100644 --- a/Makefile +++ b/Makefile @@ -85,6 +85,8 @@ clean-integrations: ## Remove built integrations files. clean-auto-doc: ##Remove all doc automatically created @if [ -d content/en/developers/integrations ]; then \ find ./content/en/developers/integrations -type f -maxdepth 1 -exec rm -rf {} \; ;fi + @if [ content/en/agent/basic_agent_usage/chef.md ]; then \ + rm -f content/en/agent/basic_agent_usage/chef.md ;fi @if [ content/en/agent/basic_agent_usage/heroku.md ]; then \ rm -f content/en/agent/basic_agent_usage/heroku.md ;fi @if [ content/en/agent/basic_agent_usage/puppet.md ]; then \ diff --git a/config/_default/menus/menus.en.yaml b/config/_default/menus/menus.en.yaml index 2b2230632e0..42c7b7b9ac7 100644 --- a/config/_default/menus/menus.en.yaml +++ b/config/_default/menus/menus.en.yaml @@ -149,10 +149,15 @@ main: url: "agent/basic_agent_usage/centos/" weight: 103 parent: "basic_agent_usage" + - name: "Chef" + identifier: "basic_agent_usage_chef" + url: "agent/basic_agent_usage/chef/" + weight: 104 + parent: "basic_agent_usage" - name: "Debian" identifier: "basic_agent_usage_deb" url: "agent/basic_agent_usage/deb/" - weight: 104 + weight: 105 parent: "basic_agent_usage" - name: "Fedora" identifier: "basic_agent_usage_fedora" diff --git a/content/en/agent/cluster_agent/clusterchecks.md b/content/en/agent/cluster_agent/clusterchecks.md index 1ff009e9eb7..6ee5cd58f48 100644 --- a/content/en/agent/cluster_agent/clusterchecks.md +++ b/content/en/agent/cluster_agent/clusterchecks.md @@ -69,11 +69,11 @@ Enable the `clusterchecks` configuration provider on the Datadog **Node** Agent. [Restart the Agent][5] to apply the configuration change. -**Note**: The [Datadog Helm Chart][12] offers the possibility to deploy, via the `clusterChecksRunner` field, a set of Datadog Agents configured to run cluster checks only. +**Note**: The [Datadog Helm Chart][6] offers the possibility to deploy, via the `clusterChecksRunner` field, a set of Datadog Agents configured to run cluster checks only. ### Custom checks -Running [custom Agent checks][6] as cluster checks is supported, as long as all node-based Agents are able to run it. This means your checks' code: +Running [custom Agent checks][7] as cluster checks is supported, as long as all node-based Agents are able to run it. This means your checks' code: - Must be installed on all node-based Agents where the `clusterchecks` config provider is enabled. - Must **not** depend on local resources that are not accessible to all Agents. @@ -108,7 +108,7 @@ When the IP of a given resource is constant (eg. external service endpoint, publ #### Example: MySQL check on a CloudSQL database -After setting up a CloudSQL instance and a [Datadog user][7], mount a `/conf.d/mysql.yaml` file in the Cluster Agent container with the following content: +After setting up a CloudSQL instance and a [Datadog user][8], mount a `/conf.d/mysql.yaml` file in the Cluster Agent container with the following content: ```yaml cluster_check: true @@ -124,7 +124,7 @@ The `cluster_check` field informs the Cluster Agent to delegate this check to on ### Template Source: Kubernetes Service Annotations -You can annotate services with the following syntax, similar to the syntax for [annotating Kubernetes Pods][8]: +You can annotate services with the following syntax, similar to the syntax for [annotating Kubernetes Pods][9]: ```yaml ad.datadoghq.com/service.check_names: '[]' @@ -132,11 +132,11 @@ ad.datadoghq.com/service.init_configs: '[]' ad.datadoghq.com/service.instances: '[]' ``` -The `%%host%%` [template variable][9] is supported and is replaced by the service's IP. The `kube_namespace` and `kube_service` tags are automatically added to the instance. +The `%%host%%` [template variable][10] is supported and is replaced by the service's IP. The `kube_namespace` and `kube_service` tags are automatically added to the instance. #### Example: HTTP check on an NGINX-backed service -The following Service definition exposes the Pods from the `my-nginx` deployment and runs an [HTTP check][10] to measure the latency of the load balanced service: +The following Service definition exposes the Pods from the `my-nginx` deployment and runs an [HTTP check][11] to measure the latency of the load balanced service: ```yaml apiVersion: v1 @@ -164,7 +164,7 @@ spec: run: my-nginx ``` -In addition, each pod should be monitored with the [NGINX check][11], as it enables the monitoring of each worker as well as the aggregated service. +In addition, each pod should be monitored with the [NGINX check][12], as it enables the monitoring of each worker as well as the aggregated service. ## Troubleshooting @@ -301,10 +301,10 @@ The Agent `status` command should show the check instance running and reporting [3]: /agent/cluster_agent/setup [4]: /agent/autodiscovery/integrations [5]: /agent/guide/agent-commands -[6]: /developers/write_agent_check -[7]: /integrations/mysql -[8]: /agent/autodiscovery/integrations/?tab=kubernetes#configuration -[9]: /agent/autodiscovery/template_variables -[10]: /integrations/http_check -[11]: /integrations/nginx -[12]: https://github.com/helm/charts/tree/master/stable/datadog \ No newline at end of file +[6]: https://github.com/helm/charts/tree/master/stable/datadog +[7]: /developers/write_agent_check +[8]: /integrations/mysql +[9]: /agent/autodiscovery/integrations/?tab=kubernetes#configuration +[10]: /agent/autodiscovery/template_variables +[11]: /integrations/http_check +[12]: /integrations/nginx diff --git a/content/en/agent/faq/kubernetes-cluster-name-detection.md b/content/en/agent/faq/kubernetes-cluster-name-detection.md index c119c951eca..970013a8618 100644 --- a/content/en/agent/faq/kubernetes-cluster-name-detection.md +++ b/content/en/agent/faq/kubernetes-cluster-name-detection.md @@ -18,4 +18,4 @@ For Agent v6.11+, the Datadog Agent can auto-detect the Kubernetes cluster name **Note**: You can manually set this cluster name value with Agent v6.5+ thanks to the Agent configuration parameter [`clusterName`][11] or the `DD_CLUSTER_NAME` environment variable. [10]: /integrations/amazon_ec2/#configuration -[11]: https://github.com/helm/charts/blob/a744ff8c90730d6d36698412150875fa96882b9d/stable/datadog/values.yaml#L58 \ No newline at end of file +[11]: https://github.com/helm/charts/blob/a744ff8c90730d6d36698412150875fa96882b9d/stable/datadog/values.yaml#L58 diff --git a/content/en/tracing/troubleshooting/_index.md b/content/en/tracing/troubleshooting/_index.md index c42529c231d..856969bbbcd 100644 --- a/content/en/tracing/troubleshooting/_index.md +++ b/content/en/tracing/troubleshooting/_index.md @@ -166,8 +166,8 @@ Logs files are saved in the following directories by default. The `DD_TRACE_LOG_ For more details on how to configure the .NET Tracer, see the [Configuration][1] section. -[1]: /tracing/setup/dotnet#configuration +[1]: /tracing/setup/dotnet#configuration {{% /tab %}} {{% tab "PHP" %}} diff --git a/data/partials/platforms.yaml b/data/partials/platforms.yaml index 16fd8a65f34..ea6354f279d 100644 --- a/data/partials/platforms.yaml +++ b/data/partials/platforms.yaml @@ -8,6 +8,9 @@ platforms: - name: centos link: "agent/basic_agent_usage/centos/" image: "platform_centos.png" + - name: chef + link: "agent/basic_agent_usage/chef/" + image: "platform_chef.png" - name: deb link: "agent/basic_agent_usage/deb/" image: "platform_debian.png" diff --git a/local/bin/py/build/configurations/pull_config.yaml b/local/bin/py/build/configurations/pull_config.yaml index d25a1b4f8b6..a31bfff1ffa 100644 --- a/local/bin/py/build/configurations/pull_config.yaml +++ b/local/bin/py/build/configurations/pull_config.yaml @@ -73,6 +73,21 @@ - "*/assets/service_checks.json" - "*/README.md" + - repo_name: chef-datadog + contents: + + - action: pull-and-push-file + branch: master + globs: + - README.md + options: + dest_path: '/agent/basic_agent_usage/' + file_name: 'chef.md' + front_matters: + title: Chef + kind: documentation + dependencies: ["https://github.com/DataDog/chef-datadog/blob/master/README.md"] + - repo_name: heroku-buildpack-datadog contents: diff --git a/local/bin/py/build/configurations/pull_config_preview.yaml b/local/bin/py/build/configurations/pull_config_preview.yaml index d25a1b4f8b6..293a3c7f720 100644 --- a/local/bin/py/build/configurations/pull_config_preview.yaml +++ b/local/bin/py/build/configurations/pull_config_preview.yaml @@ -73,6 +73,21 @@ - "*/assets/service_checks.json" - "*/README.md" + - repo_name: chef-datadog + contents: + + - action: pull-and-push-file + branch: ruth/docs-629 + globs: + - README.md + options: + dest_path: '/agent/basic_agent_usage/' + file_name: 'chef.md' + front_matters: + title: Chef + kind: documentation + dependencies: ["https://github.com/DataDog/chef-datadog/blob/master/README.md"] + - repo_name: heroku-buildpack-datadog contents: