[7.16](backport #28814) Deprecate generating custom Beats (#28837)

* Deprecate generating custom Beats (#28814) (cherry picked from commit 0f989b8) * Based on origin/7.16 Co-authored-by: Noémi Ványi <kvch@users.noreply.github.com> Co-authored-by: Noémi Ványi <sitbackandwait@gmail.com>
elastic · Nov 5, 2021 · 8fbebba · 8fbebba
1 parent c958550
commit 8fbebba
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 1 deletion.
diff --git a/CHANGELOG-developer.next.asciidoc b/CHANGELOG-developer.next.asciidoc
@@ -122,3 +122,4 @@ The list below covers the major changes between 7.0.0-rc2 and master only.
 ==== Deprecated
 
 - Deprecated the `common.Float` type. {issue}28279[28279] {pull}28280[28280]
+- Deprecate Beat generators. {pull}28814[28814]
diff --git a/docs/devguide/creating-beat-from-metricbeat.asciidoc b/docs/devguide/creating-beat-from-metricbeat.asciidoc
@@ -1,6 +1,8 @@
 [[creating-beat-from-metricbeat]]
 === Creating a Beat based on Metricbeat
 
+deprecated:[7.16.0]
+
 The metricset Beat generator enables you to create a Beat that uses Metricbeat as a library and has your
 own metricsets.
 

diff --git a/docs/devguide/newbeat.asciidoc b/docs/devguide/newbeat.asciidoc
@@ -1,6 +1,8 @@
 [[new-beat]]
 == Creating a New Beat
 
+deprecated:[7.16.0]
+
 This guide walks you through the steps for creating a new Elastic Beat.  The
 Beats are a collection of lightweight daemons that collect operational data from
 your servers and ship it to Elasticsearch or Logstash.  The common parts for

diff --git a/generator/common/Makefile b/generator/common/Makefile
@@ -37,7 +37,7 @@ prepare-test:: mage
 	export NEWBEAT_FULL_NAME="Nicolas Ruflin" ; \
 	export NEWBEAT_TYPE=${BEAT_TYPE} ; \
 	export NEWBEAT_DEV=1 ; \
-	export NEWBEAT_BEATS_REVISION=$(shell git rev-parse origin/master) ; \
+	export NEWBEAT_BEATS_REVISION=$(shell git rev-parse origin/7.16) ; \
 	mage GenerateCustomBeat
 
 # Runs test build for the created beat

diff --git a/generator/common/beatgen/beatgen.go b/generator/common/beatgen/beatgen.go
@@ -92,6 +92,8 @@ var configList = []ConfigItem{
 
 // Generate generates a new custom beat
 func Generate() error {
+	fmt.Println("Generating custom Beats are going to be removed in 8.0.0.")
+
 	cfg, err := getConfig()
 	if err != nil {
 		return errors.Wrap(err, "error getting config")

diff --git a/libbeat/docs/communitybeats.asciidoc b/libbeat/docs/communitybeats.asciidoc
@@ -6,6 +6,8 @@
 [[community-beats]]
 == Community Beats
 
+Please note that generating new Beats is deprecated since 7.16.
+
 The open source community has been hard at work developing new Beats. You can check
 out some of them here.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -122,3 +122,4 @@ The list below covers the major changes between 7.0.0-rc2 and master only.
		==== Deprecated

		- Deprecated the `common.Float` type. {issue}28279[28279] {pull}28280[28280]
		- Deprecate Beat generators. {pull}28814[28814]