From 980d728e1a7e01aef72d4cfb13d4ad1b29614b3c Mon Sep 17 00:00:00 2001 From: Ruth Naebeck Date: Tue, 25 Feb 2020 15:27:39 -0500 Subject: [PATCH 1/5] DOCS-631 Puppet doc pull --- .gitignore | 1 + .gitlab-ci.yml | 2 +- Makefile | 2 ++ config/_default/menus/menus.en.yaml | 15 ++++++++++----- data/partials/platforms.yaml | 3 +++ .../bin/py/build/configurations/pull_config.yaml | 15 +++++++++++++++ .../build/configurations/pull_config_preview.yaml | 15 +++++++++++++++ 7 files changed, 47 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 10b3bf3ff84..341d0e67fe5 100644 --- a/.gitignore +++ b/.gitignore @@ -11,6 +11,7 @@ content/en/developers/amazon_cloudformation.md # Agent section content/en/agent/basic_agent_usage/heroku.md +content/en/agent/basic_agent_usage/puppet.md # Tracing content/en/tracing/setup/ruby.md diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 41764da5eda..e0288544b1e 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/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/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 83f64f0f784..84fdd70e9ba 100644 --- a/Makefile +++ b/Makefile @@ -87,6 +87,8 @@ clean-auto-doc: ##Remove all doc automatically created find ./content/en/developers/integrations -type f -maxdepth 1 -exec rm -rf {} \; ;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 \ + rm -f content/en/agent/basic_agent_usage/puppet.md ;fi @if [ content/en/tracing/setup/ruby.md ]; then \ rm -f content/en/tracing/setup/ruby.md ;fi @if [ content/en/developers/amazon_cloudformation.md ]; then \ diff --git a/config/_default/menus/menus.en.yaml b/config/_default/menus/menus.en.yaml index 916235186fe..8f621ee0555 100644 --- a/config/_default/menus/menus.en.yaml +++ b/config/_default/menus/menus.en.yaml @@ -174,30 +174,35 @@ main: url: "agent/basic_agent_usage/osx/" weight: 108 parent: "basic_agent_usage" + - name: "Puppet" + identifier: "basic_agent_usage_puppet" + url: "agent/basic_agent_usage/puppet/" + weight: 109 + parent: "basic_agent_usage" - name: "Red Hat" identifier: "basic_agent_usage_redhat" url: "agent/basic_agent_usage/redhat/" - weight: 109 + weight: 110 parent: "basic_agent_usage" - name: "SUSE" identifier: "basic_agent_usage_suse" url: "agent/basic_agent_usage/suse/" - weight: 110 + weight: 111 parent: "basic_agent_usage" - name: "Ubuntu" identifier: "basic_agent_usage_ubuntu" url: "agent/basic_agent_usage/ubuntu/" - weight: 111 + weight: 112 parent: "basic_agent_usage" - name: "Windows" identifier: "basic_agent_usage_windows" url: "agent/basic_agent_usage/windows/" - weight: 112 + weight: 113 parent: "basic_agent_usage" - name: "From Source" identifier: "basic_agent_usage_source" url: "agent/basic_agent_usage/source/" - weight: 113 + weight: 114 parent: "basic_agent_usage" ## AGENT - Docker diff --git a/data/partials/platforms.yaml b/data/partials/platforms.yaml index 669ebc43b70..16fd8a65f34 100644 --- a/data/partials/platforms.yaml +++ b/data/partials/platforms.yaml @@ -20,6 +20,9 @@ platforms: - name: heroku link: "agent/basic_agent_usage/heroku/" image: "platform_heroku.png" + - name: puppet + link: "agent/basic_agent_usage/puppet/" + image: "platform_puppet.png" - name: kubernetes link: "agent/kubernetes/" image: "platform_kubernetes.png" diff --git a/local/bin/py/build/configurations/pull_config.yaml b/local/bin/py/build/configurations/pull_config.yaml index 8e82cfbc3ae..406558f633d 100644 --- a/local/bin/py/build/configurations/pull_config.yaml +++ b/local/bin/py/build/configurations/pull_config.yaml @@ -90,6 +90,21 @@ aliases: - /developers/faq/how-do-i-collect-metrics-from-heroku-with-datadog + - repo_name: puppet-datadog-agent + contents: + + - action: pull-and-push-file + branch: master + globs: + - README.md + options: + dest_path: '/agent/basic_agent_usage/' + file_name: 'puppet.md' + front_matters: + title: Puppet + kind: documentation + dependencies: ["https://github.com/DataDog/puppet-datadog-agent/blob/master/README.md"] + - repo_name: dd-trace-rb contents: - action: pull-and-push-file diff --git a/local/bin/py/build/configurations/pull_config_preview.yaml b/local/bin/py/build/configurations/pull_config_preview.yaml index 8e82cfbc3ae..406558f633d 100644 --- a/local/bin/py/build/configurations/pull_config_preview.yaml +++ b/local/bin/py/build/configurations/pull_config_preview.yaml @@ -90,6 +90,21 @@ aliases: - /developers/faq/how-do-i-collect-metrics-from-heroku-with-datadog + - repo_name: puppet-datadog-agent + contents: + + - action: pull-and-push-file + branch: master + globs: + - README.md + options: + dest_path: '/agent/basic_agent_usage/' + file_name: 'puppet.md' + front_matters: + title: Puppet + kind: documentation + dependencies: ["https://github.com/DataDog/puppet-datadog-agent/blob/master/README.md"] + - repo_name: dd-trace-rb contents: - action: pull-and-push-file From 4a10fd87b03aa29eb7611dab98ed86aaa160718f Mon Sep 17 00:00:00 2001 From: l0k0ms Date: Wed, 26 Feb 2020 08:26:16 +0100 Subject: [PATCH 2/5] testing preview branch --- local/bin/py/build/configurations/pull_config_preview.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/local/bin/py/build/configurations/pull_config_preview.yaml b/local/bin/py/build/configurations/pull_config_preview.yaml index 406558f633d..ae526030f17 100644 --- a/local/bin/py/build/configurations/pull_config_preview.yaml +++ b/local/bin/py/build/configurations/pull_config_preview.yaml @@ -94,7 +94,7 @@ contents: - action: pull-and-push-file - branch: master + branch: ruth/docs-631 globs: - README.md options: From 8969bf5c997ff02aa1e9326beb28e3401daccbeb Mon Sep 17 00:00:00 2001 From: Ruth Naebeck Date: Mon, 2 Mar 2020 14:48:31 -0500 Subject: [PATCH 3/5] run pipeline From 9d69535c201882e1ff0907d90f13d8ea22173cc8 Mon Sep 17 00:00:00 2001 From: Ruth Naebeck Date: Wed, 4 Mar 2020 18:21:08 -0500 Subject: [PATCH 4/5] DOCS-629 Chef doc pull --- .gitignore | 1 + .gitlab-ci.yml | 2 +- Makefile | 2 ++ config/_default/menus/menus.en.yaml | 7 ++++++- data/partials/platforms.yaml | 3 +++ .../bin/py/build/configurations/pull_config.yaml | 15 +++++++++++++++ .../build/configurations/pull_config_preview.yaml | 15 +++++++++++++++ 7 files changed, 43 insertions(+), 2 deletions(-) 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 e0288544b1e..2757387d01f 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 8f621ee0555..cc757c32145 100644 --- a/config/_default/menus/menus.en.yaml +++ b/config/_default/menus/menus.en.yaml @@ -154,10 +154,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/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 406558f633d..cf2e6a40f8e 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 ae526030f17..cb66966dc41 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: From 56af88724e15026eef55a70fdf3c63d8c68dc38e Mon Sep 17 00:00:00 2001 From: Ruth Naebeck Date: Wed, 11 Mar 2020 11:49:55 -0400 Subject: [PATCH 5/5] revert change --- content/en/agent/faq/kubernetes-cluster-name-detection.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/agent/faq/kubernetes-cluster-name-detection.md b/content/en/agent/faq/kubernetes-cluster-name-detection.md index 85f18bbcb56..970013a8618 100644 --- a/content/en/agent/faq/kubernetes-cluster-name-detection.md +++ b/content/en/agent/faq/kubernetes-cluster-name-detection.md @@ -13,9 +13,9 @@ further_reading: text: "Custom Integrations" --- -For Agent v6.11+, the Datadog Agent can auto-detect the Kubernetes cluster name on Google GKE, Azure AKS, and AWS EKS. If detected, an alias which contains the cluster name as a suffix on the node name is added to all data collected to facilitate the identification of nodes across Kubernetes clusters. On Google GKE and Azure AKS, the cluster name is retrieved from the cloud provider API. For AWS EKS, the cluster name is retrieved from EC2 instance tags. On AWS, it is required to add the `ec2:DescribeInstances` [permission][1] to your Datadog IAM policy so that the Agent can query the EC2 instance tags. +For Agent v6.11+, the Datadog Agent can auto-detect the Kubernetes cluster name on Google GKE, Azure AKS, and AWS EKS. If detected, an alias which contains the cluster name as a suffix on the node name is added to all data collected to facilitate the identification of nodes across Kubernetes clusters. On Google GKE and Azure AKS, the cluster name is retrieved from the cloud provider API. For AWS EKS, the cluster name is retrieved from EC2 instance tags. On AWS, it is required to add the `ec2:DescribeInstances` [permission][10] to your Datadog IAM policy so that the Agent can query the EC2 instance tags. -**Note**: You can manually set this cluster name value with Agent v6.5+ thanks to the Agent configuration parameter [`clusterName`][2] or the `DD_CLUSTER_NAME` environment variable. +**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. -[1]: /integrations/amazon_ec2/#configuration -[2]: https://github.com/helm/charts/blob/a744ff8c90730d6d36698412150875fa96882b9d/stable/datadog/values.yaml#L58 +[10]: /integrations/amazon_ec2/#configuration +[11]: https://github.com/helm/charts/blob/a744ff8c90730d6d36698412150875fa96882b9d/stable/datadog/values.yaml#L58