Add support for elasticsearch.privileges.cluster (#750)

elastic · Oct 14, 2021 · e1ac6f1 · e1ac6f1
1 parent e3cd9de
commit e1ac6f1
Show file tree

Hide file tree

Showing 10 changed files with 44 additions and 25 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Configuration file path can be selected with the `-config` flag. [#745](https://github.com/elastic/package-registry/pull/745)
 * Configuration flags can be provided using environment variables. [#745](https://github.com/elastic/package-registry/pull/745)
 * Add `-tls-cert` and `-tls-key` flags to configure HTTPS. [#711](https://github.com/elastic/package-registry/issues/711) [#746](https://github.com/elastic/package-registry/issues/746)
+* Support for `elasticsearch.privileges.cluster` in package manifest. [#750](https://github.com/elastic/package-registry/pull/750)
 * Update Go runtime to 1.17.1. [#753](https://github.com/elastic/package-registry/pull/753)
 
 ### Deprecated

diff --git a/packages/datastream.go b/packages/datastream.go
@@ -47,10 +47,10 @@ type DataStream struct {
 	Release string `config:"release" json:"release"`
 
 	// Deprecated: Replaced by elasticsearch.ingest_pipeline.name
-	IngestPipeline string         `config:"ingest_pipeline,omitempty" config:"ingest_pipeline" json:"ingest_pipeline,omitempty" yaml:"ingest_pipeline,omitempty"`
-	Streams        []Stream       `config:"streams" json:"streams,omitempty" yaml:"streams,omitempty" `
-	Package        string         `json:"package,omitempty" yaml:"package,omitempty"`
-	Elasticsearch  *Elasticsearch `config:"elasticsearch,omitempty" json:"elasticsearch,omitempty" yaml:"elasticsearch,omitempty"`
+	IngestPipeline string                   `config:"ingest_pipeline,omitempty" config:"ingest_pipeline" json:"ingest_pipeline,omitempty" yaml:"ingest_pipeline,omitempty"`
+	Streams        []Stream                 `config:"streams" json:"streams,omitempty" yaml:"streams,omitempty" `
+	Package        string                   `json:"package,omitempty" yaml:"package,omitempty"`
+	Elasticsearch  *DataStreamElasticsearch `config:"elasticsearch,omitempty" json:"elasticsearch,omitempty" yaml:"elasticsearch,omitempty"`
 
 	// Generated fields
 	Path string `json:"path,omitempty" yaml:"path,omitempty"`
@@ -94,14 +94,14 @@ type Variable struct {
 	Default     interface{} `config:"default" json:"default,omitempty" yaml:"default,omitempty"`
 }
 
-type Elasticsearch struct {
-	IndexTemplateSettings map[string]interface{}   `config:"index_template.settings" json:"index_template.settings,omitempty" yaml:"index_template.settings,omitempty"`
-	IndexTemplateMappings map[string]interface{}   `config:"index_template.mappings" json:"index_template.mappings,omitempty" yaml:"index_template.mappings,omitempty"`
-	IngestPipelineName    string                   `config:"ingest_pipeline.name,omitempty" json:"ingest_pipeline.name,omitempty" yaml:"ingest_pipeline.name,omitempty"`
-	Privileges            *ElasticsearchPrivileges `config:"privileges,omitempty" json:"privileges,omitempty" yaml:"privileges,omitempty"`
+type DataStreamElasticsearch struct {
+	IndexTemplateSettings map[string]interface{}             `config:"index_template.settings" json:"index_template.settings,omitempty" yaml:"index_template.settings,omitempty"`
+	IndexTemplateMappings map[string]interface{}             `config:"index_template.mappings" json:"index_template.mappings,omitempty" yaml:"index_template.mappings,omitempty"`
+	IngestPipelineName    string                             `config:"ingest_pipeline.name,omitempty" json:"ingest_pipeline.name,omitempty" yaml:"ingest_pipeline.name,omitempty"`
+	Privileges            *DataStreamElasticsearchPrivileges `config:"privileges,omitempty" json:"privileges,omitempty" yaml:"privileges,omitempty"`
 }
 
-type ElasticsearchPrivileges struct {
+type DataStreamElasticsearchPrivileges struct {
 	Indices []string `config:"indices,omitempty" json:"indices,omitempty" yaml:"indices,omitempty"`
 }
 

diff --git a/packages/package.go b/packages/package.go
@@ -59,12 +59,12 @@ type Package struct {
 	Readme          *string `config:"readme,omitempty" json:"readme,omitempty" yaml:"readme,omitempty"`
 	License         string  `config:"license,omitempty" json:"license,omitempty" yaml:"license,omitempty"`
 	versionSemVer   *semver.Version
-	Screenshots     []Image          `config:"screenshots,omitempty" json:"screenshots,omitempty" yaml:"screenshots,omitempty"`
-	Assets          []string         `config:"assets,omitempty" json:"assets,omitempty" yaml:"assets,omitempty"`
-	PolicyTemplates []PolicyTemplate `config:"policy_templates,omitempty" json:"policy_templates,omitempty" yaml:"policy_templates,omitempty"`
-	DataStreams     []*DataStream    `config:"data_streams,omitempty" json:"data_streams,omitempty" yaml:"data_streams,omitempty"`
-	Vars            []Variable       `config:"vars" json:"vars,omitempty" yaml:"vars,omitempty"`
-
+	Screenshots     []Image               `config:"screenshots,omitempty" json:"screenshots,omitempty" yaml:"screenshots,omitempty"`
+	Assets          []string              `config:"assets,omitempty" json:"assets,omitempty" yaml:"assets,omitempty"`
+	PolicyTemplates []PolicyTemplate      `config:"policy_templates,omitempty" json:"policy_templates,omitempty" yaml:"policy_templates,omitempty"`
+	DataStreams     []*DataStream         `config:"data_streams,omitempty" json:"data_streams,omitempty" yaml:"data_streams,omitempty"`
+	Vars            []Variable            `config:"vars" json:"vars,omitempty" yaml:"vars,omitempty"`
+	Elasticsearch   *PackageElasticsearch `config:"elasticsearch,omitempty" json:"elasticsearch,omitempty" yaml:"elasticsearch,omitempty"`
 	// Local path to the package dir
 	BasePath string `json:"-" yaml:"-"`
 
@@ -143,6 +143,14 @@ type Image struct {
 	Type  string `config:"type" json:"type,omitempty"`
 }
 
+type PackageElasticsearch struct {
+	Privileges *PackageElasticsearchPrivileges `config:"privileges,omitempty" json:"privileges,omitempty" yaml:"privileges,omitempty"`
+}
+
+type PackageElasticsearchPrivileges struct {
+	Cluster []string `config:"cluster,omitempty" json:"cluster,omitempty" yaml:"cluster,omitempty"`
+}
+
 func (i Image) getPath(p *Package) string {
 	return path.Join(packagePathPrefix, p.Name, p.Version, i.Src)
 }

diff --git a/testdata/generated/package/elasticsearch_privileges/1.0.0/index.json b/testdata/generated/package/elasticsearch_privileges/1.0.0/index.json
@@ -3,7 +3,7 @@
   "title": "Elasticsearch Privileges",
   "version": "1.0.0",
   "release": "beta",
-  "description": "Test package-specified Elasticsearch index privileges",
+  "description": "Test package-specified Elasticsearch index privileges and cluster privileges",
   "type": "solution",
   "download": "/epr/elasticsearch_privileges/elasticsearch_privileges-1.0.0.zip",
   "path": "/package/elasticsearch_privileges/1.0.0",
@@ -44,5 +44,12 @@
       },
       "path": "elasticsearch_privileges"
     }
-  ]
+  ],
+  "elasticsearch": {
+    "privileges": {
+      "cluster": [
+        "monitor"
+      ]
+    }
+  }
 }
diff --git a/testdata/generated/search-all.json b/testdata/generated/search-all.json
@@ -78,7 +78,7 @@
     "title": "Elasticsearch Privileges",
     "version": "1.0.0",
     "release": "beta",
-    "description": "Test package-specified Elasticsearch index privileges",
+    "description": "Test package-specified Elasticsearch index privileges and cluster privileges",
     "type": "solution",
     "download": "/epr/elasticsearch_privileges/elasticsearch_privileges-1.0.0.zip",
     "path": "/package/elasticsearch_privileges/1.0.0",

diff --git a/testdata/generated/search-category-custom.json b/testdata/generated/search-category-custom.json
@@ -37,7 +37,7 @@
     "title": "Elasticsearch Privileges",
     "version": "1.0.0",
     "release": "beta",
-    "description": "Test package-specified Elasticsearch index privileges",
+    "description": "Test package-specified Elasticsearch index privileges and cluster privileges",
     "type": "solution",
     "download": "/epr/elasticsearch_privileges/elasticsearch_privileges-1.0.0.zip",
     "path": "/package/elasticsearch_privileges/1.0.0",

diff --git a/testdata/generated/search-package-experimental.json b/testdata/generated/search-package-experimental.json
@@ -78,7 +78,7 @@
     "title": "Elasticsearch Privileges",
     "version": "1.0.0",
     "release": "beta",
-    "description": "Test package-specified Elasticsearch index privileges",
+    "description": "Test package-specified Elasticsearch index privileges and cluster privileges",
     "type": "solution",
     "download": "/epr/elasticsearch_privileges/elasticsearch_privileges-1.0.0.zip",
     "path": "/package/elasticsearch_privileges/1.0.0",

diff --git a/testdata/generated/search-package-internal.json b/testdata/generated/search-package-internal.json
@@ -78,7 +78,7 @@
     "title": "Elasticsearch Privileges",
     "version": "1.0.0",
     "release": "beta",
-    "description": "Test package-specified Elasticsearch index privileges",
+    "description": "Test package-specified Elasticsearch index privileges and cluster privileges",
     "type": "solution",
     "download": "/epr/elasticsearch_privileges/elasticsearch_privileges-1.0.0.zip",
     "path": "/package/elasticsearch_privileges/1.0.0",

diff --git a/testdata/generated/search.json b/testdata/generated/search.json
@@ -78,7 +78,7 @@
     "title": "Elasticsearch Privileges",
     "version": "1.0.0",
     "release": "beta",
-    "description": "Test package-specified Elasticsearch index privileges",
+    "description": "Test package-specified Elasticsearch index privileges and cluster privileges",
     "type": "solution",
     "download": "/epr/elasticsearch_privileges/elasticsearch_privileges-1.0.0.zip",
     "path": "/package/elasticsearch_privileges/1.0.0",

diff --git a/testdata/package/elasticsearch_privileges/1.0.0/manifest.yml b/testdata/package/elasticsearch_privileges/1.0.0/manifest.yml
@@ -1,14 +1,17 @@
 format_version: 1.0.0
 
 name: elasticsearch_privileges
-description: Test package-specified Elasticsearch index privileges
+description: Test package-specified Elasticsearch index privileges and cluster privileges
 version: 1.0.0
 title: Elasticsearch Privileges
 categories: ["custom"]
 type: solution
 release: beta
 
+elasticsearch:
+  privileges:
+    cluster: ["monitor"]
+
 conditions:
   kibana:
     version: ">=7.16.0"
-