Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow the ILM policy name to be configurable #2971

Merged
merged 3 commits into from
May 4, 2021
Merged

Allow the ILM policy name to be configurable #2971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55d8acb
Allow the ILM Policy name to be configurable
jrRibeiro Apr 30, 2021
5dd9020
Add integration test for ILM Policy Name
jrRibeiro May 3, 2021
534dee9
Merge branch 'master' into configurable-ilm-policy
albertteoh May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 19 additions & 12 deletions cmd/esmapping-generator/app/flags.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,23 @@ import (

// Options represent configurable parameters for jaeger-esmapping-generator
type Options struct {
Mapping string
EsVersion uint
Shards int64
Replicas int64
IndexPrefix string
UseILM string // using string as util is being used in python and using bool leads to type issues.
Mapping string
EsVersion uint
Shards int64
Replicas int64
IndexPrefix string
UseILM string // using string as util is being used in python and using bool leads to type issues.
ILMPolicyName string
}

const (
mappingFlag = "mapping"
esVersionFlag = "es-version"
shardsFlag = "shards"
replicasFlag = "replicas"
indexPrefixFlag = "index-prefix"
useILMFlag = "use-ilm"
mappingFlag = "mapping"
esVersionFlag = "es-version"
shardsFlag = "shards"
replicasFlag = "replicas"
indexPrefixFlag = "index-prefix"
useILMFlag = "use-ilm"
ilmPolicyNameFlag = "ilm-policy-name"
)

// AddFlags adds flags for esmapping-generator main program
Expand Down Expand Up @@ -69,6 +71,11 @@ func (o *Options) AddFlags(command *cobra.Command) {
useILMFlag,
"false",
"Set to true to use ILM for managing lifecycle of jaeger indices")
command.Flags().StringVar(
&o.ILMPolicyName,
ilmPolicyNameFlag,
"jaeger-ilm-policy",
"The name of the ILM policy to use if ILM is active")

// mark mapping flag as mandatory
command.MarkFlagRequired(mappingFlag)
Expand Down
3 changes: 3 additions & 0 deletions cmd/esmapping-generator/app/flags_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ func TestOptionsWithDefaultFlags(t *testing.T) {
assert.Equal(t, int64(1), o.Replicas)
assert.Equal(t, "", o.IndexPrefix)
assert.Equal(t, "false", o.UseILM)
assert.Equal(t, "jaeger-ilm-policy", o.ILMPolicyName)
}

func TestOptionsWithFlags(t *testing.T) {
Expand All @@ -47,6 +48,7 @@ func TestOptionsWithFlags(t *testing.T) {
"--replicas=1",
"--index-prefix=test",
"--use-ilm=true",
"--ilm-policy-name=jaeger-test-policy",
})
require.NoError(t, err)
assert.Equal(t, "jaeger-span", o.Mapping)
Expand All @@ -55,4 +57,5 @@ func TestOptionsWithFlags(t *testing.T) {
assert.Equal(t, int64(1), o.Replicas)
assert.Equal(t, "test", o.IndexPrefix)
assert.Equal(t, "true", o.UseILM)
assert.Equal(t, "jaeger-test-policy", o.ILMPolicyName)
}
1 change: 1 addition & 0 deletions cmd/esmapping-generator/app/renderer/render.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ func GetMappingAsString(builder es.TemplateBuilder, opt *app.Options) (string, e
EsVersion: opt.EsVersion,
IndexPrefix: opt.IndexPrefix,
UseILM: enableILM,
ILMPolicyName: opt.ILMPolicyName,
}
return mappingBuilder.GetMapping(opt.Mapping)
}
Expand Down
10 changes: 5 additions & 5 deletions cmd/esmapping-generator/app/renderer/render_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,23 @@ func Test_getMappingAsString(t *testing.T) {
wantErr error
}{
{
name: "ES version 7", args: app.Options{Mapping: "jaeger-span", EsVersion: 7, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "true"},
name: "ES version 7", args: app.Options{Mapping: "jaeger-span", EsVersion: 7, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "true", ILMPolicyName: "jaeger-test-policy"},
want: "ES version 7",
},
{
name: "ES version 6", args: app.Options{Mapping: "jaeger-span", EsVersion: 6, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "false"},
name: "ES version 6", args: app.Options{Mapping: "jaeger-span", EsVersion: 6, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "false", ILMPolicyName: "jaeger-test-policy"},
want: "ES version 6",
},
{
name: "Parse Error version 6", args: app.Options{Mapping: "jaeger-span", EsVersion: 6, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "false"},
name: "Parse Error version 6", args: app.Options{Mapping: "jaeger-span", EsVersion: 6, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "false", ILMPolicyName: "jaeger-test-policy"},
wantErr: errors.New("parse error"),
},
{
name: "Parse Error version 7", args: app.Options{Mapping: "jaeger-span", EsVersion: 7, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "true"},
name: "Parse Error version 7", args: app.Options{Mapping: "jaeger-span", EsVersion: 7, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "true", ILMPolicyName: "jaeger-test-policy"},
wantErr: errors.New("parse error"),
},
{
name: "Parse bool error", args: app.Options{Mapping: "jaeger-span", EsVersion: 7, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "foo"},
name: "Parse bool error", args: app.Options{Mapping: "jaeger-span", EsVersion: 7, Shards: 5, Replicas: 1, IndexPrefix: "test", UseILM: "foo", ILMPolicyName: "jaeger-test-policy"},
wantErr: errors.New("strconv.ParseBool: parsing \"foo\": invalid syntax"),
},
}
Expand Down
12 changes: 8 additions & 4 deletions plugin/storage/es/esRollover.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
UNIT_COUNT = 2
SHARDS = 5
REPLICAS = 1
ILM_POLICY_NAME = 'jaeger-ilm-policy'


def main():
Expand All @@ -39,6 +40,7 @@ def main():
print('ES_TLS_CERT ... Path to TLS certificate file.')
print('ES_TLS_KEY ... Path to TLS key file.')
print('ES_USE_ILM .. Use ILM to manage jaeger indices.')
print('ES_ILM_POLICY_NAME .. The name of the ILM policy to use if ILM is active.')
print('ES_TLS_SKIP_HOST_VERIFY ... (insecure) Skip server\'s certificate chain and host name verification.')
print(
'ES_VERSION ... The major Elasticsearch version. If not specified, the value will be auto-detected from Elasticsearch.')
Expand Down Expand Up @@ -83,13 +85,14 @@ def perform_action(action, client, write_alias, read_alias, index_to_rollover, t
replicas = os.getenv('REPLICAS', REPLICAS)
esVersion = get_version(client)
use_ilm = str2bool(os.getenv("ES_USE_ILM", 'false'))
ilm_policy_name = os.getenv('ES_ILM_POLICY_NAME', ILM_POLICY_NAME)
if esVersion == 7:
if use_ilm:
check_if_ilm_policy_exists("jaeger-ilm-policy")
check_if_ilm_policy_exists(ilm_policy_name)
else:
if use_ilm:
sys.exit("ILM is supported only for ES version 7+")
create_index_template(fix_mapping(template_name, esVersion, shards, replicas, prefix.rstrip("-"), use_ilm),
create_index_template(fix_mapping(template_name, esVersion, shards, replicas, prefix.rstrip("-"), use_ilm, ilm_policy_name),
prefix + template_name)

index = index_to_rollover + '-000001'
Expand Down Expand Up @@ -194,10 +197,11 @@ def str2bool(v):
return v.lower() in ('true', '1')


def fix_mapping(template_name, esVersion, shards, replicas, indexPrefix, use_ilm):
def fix_mapping(template_name, esVersion, shards, replicas, indexPrefix, use_ilm, ilm_policy_name):
output = subprocess.Popen(['esmapping-generator', '--mapping', template_name, '--es-version', str(esVersion),
'--shards', str(shards), '--replicas',
str(replicas), '--index-prefix', indexPrefix, '--use-ilm', str(use_ilm)],
str(replicas), '--index-prefix', indexPrefix,
'--use-ilm', str(use_ilm), '--ilm-policy-name', ilm_policy_name],
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT)
mapping, stderr = output.communicate()
Expand Down
2 changes: 1 addition & 1 deletion plugin/storage/es/mappings/fixtures/jaeger-service-7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"index.mapping.nested_fields.limit":50,
"index.requests.cache.enable":true
,"lifecycle": {
"name": "jaeger-ilm-policy",
"name": "jaeger-test-policy",
"rollover_alias": "test-jaeger-service-write"
}
},
Expand Down
2 changes: 1 addition & 1 deletion plugin/storage/es/mappings/fixtures/jaeger-span-7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"index.mapping.nested_fields.limit":50,
"index.requests.cache.enable":true
,"lifecycle": {
"name": "jaeger-ilm-policy",
"name": "jaeger-test-policy",
"rollover_alias": "test-jaeger-span-write"
}
},
Expand Down
2 changes: 1 addition & 1 deletion plugin/storage/es/mappings/jaeger-service-7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"index.requests.cache.enable":true
{{- if .UseILM }}
,"lifecycle": {
"name": "jaeger-ilm-policy",
"name": "{{ .ILMPolicyName }}",
"rollover_alias": "{{ .IndexPrefix }}jaeger-service-write"
}
{{- end }}
Expand Down
2 changes: 1 addition & 1 deletion plugin/storage/es/mappings/jaeger-span-7.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"index.requests.cache.enable":true
{{- if .UseILM }}
,"lifecycle": {
"name": "jaeger-ilm-policy",
"name": "{{ .ILMPolicyName }}",
"rollover_alias": "{{ .IndexPrefix }}jaeger-span-write"
}
{{- end }}
Expand Down
1 change: 1 addition & 0 deletions plugin/storage/es/mappings/mapping.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ type MappingBuilder struct {
EsVersion uint
IndexPrefix string
UseILM bool
ILMPolicyName string
}

// GetMapping returns the rendered mapping based on elasticsearch version
Expand Down
80 changes: 45 additions & 35 deletions plugin/storage/es/mappings/mapping_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ func TestMappingBuilder_GetMapping(t *testing.T) {
EsVersion: tt.esVersion,
IndexPrefix: "test-",
UseILM: true,
ILMPolicyName: "jaeger-test-policy",
}
got, err := mb.GetMapping(tt.mapping)
require.NoError(t, err)
Expand Down Expand Up @@ -142,6 +143,7 @@ func TestMappingBuilder_fixMapping(t *testing.T) {
EsVersion: 7,
IndexPrefix: "test",
UseILM: true,
ILMPolicyName: "jaeger-test-policy",
}
_, err := mappingBuilder.fixMapping("test")
if test.err != "" {
Expand All @@ -156,11 +158,12 @@ func TestMappingBuilder_fixMapping(t *testing.T) {

func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
type args struct {
shards int64
replicas int64
esVersion uint
indexPrefix string
useILM bool
shards int64
replicas int64
esVersion uint
indexPrefix string
useILM bool
ilmPolicyName string
}
tests := []struct {
name string
Expand All @@ -171,11 +174,12 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
{
name: "ES Version 7",
args: args{
shards: 3,
replicas: 3,
esVersion: 7,
indexPrefix: "test",
useILM: true,
shards: 3,
replicas: 3,
esVersion: 7,
indexPrefix: "test",
useILM: true,
ilmPolicyName: "jaeger-test-policy",
},
mockNewTextTemplateBuilder: func() es.TemplateBuilder {
tb := mocks.TemplateBuilder{}
Expand All @@ -189,11 +193,12 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
{
name: "ES Version 7 Service Error",
args: args{
shards: 3,
replicas: 3,
esVersion: 7,
indexPrefix: "test",
useILM: true,
shards: 3,
replicas: 3,
esVersion: 7,
indexPrefix: "test",
useILM: true,
ilmPolicyName: "jaeger-test-policy",
},
mockNewTextTemplateBuilder: func() es.TemplateBuilder {
tb := mocks.TemplateBuilder{}
Expand All @@ -209,11 +214,12 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
{
name: "ES Version < 7",
args: args{
shards: 3,
replicas: 3,
esVersion: 6,
indexPrefix: "test",
useILM: true,
shards: 3,
replicas: 3,
esVersion: 6,
indexPrefix: "test",
useILM: true,
ilmPolicyName: "jaeger-test-policy",
},
mockNewTextTemplateBuilder: func() es.TemplateBuilder {
tb := mocks.TemplateBuilder{}
Expand All @@ -227,11 +233,12 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
{
name: "ES Version < 7 Service Error",
args: args{
shards: 3,
replicas: 3,
esVersion: 6,
indexPrefix: "test",
useILM: true,
shards: 3,
replicas: 3,
esVersion: 6,
indexPrefix: "test",
useILM: true,
ilmPolicyName: "jaeger-test-policy",
},
mockNewTextTemplateBuilder: func() es.TemplateBuilder {
tb := mocks.TemplateBuilder{}
Expand All @@ -246,11 +253,12 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
{
name: "ES Version < 7 Span Error",
args: args{
shards: 3,
replicas: 3,
esVersion: 6,
indexPrefix: "test",
useILM: true,
shards: 3,
replicas: 3,
esVersion: 6,
indexPrefix: "test",
useILM: true,
ilmPolicyName: "jaeger-test-policy",
},
mockNewTextTemplateBuilder: func() es.TemplateBuilder {
tb := mocks.TemplateBuilder{}
Expand All @@ -264,11 +272,12 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
{
name: "ES Version 7 Span Error",
args: args{
shards: 3,
replicas: 3,
esVersion: 7,
indexPrefix: "test",
useILM: true,
shards: 3,
replicas: 3,
esVersion: 7,
indexPrefix: "test",
useILM: true,
ilmPolicyName: "jaeger-test-policy",
},
mockNewTextTemplateBuilder: func() es.TemplateBuilder {
tb := mocks.TemplateBuilder{}
Expand All @@ -289,6 +298,7 @@ func TestMappingBuilder_GetSpanServiceMappings(t *testing.T) {
EsVersion: test.args.esVersion,
IndexPrefix: test.args.indexPrefix,
UseILM: test.args.useILM,
ILMPolicyName: test.args.ilmPolicyName,
}
_, _, err := mappingBuilder.GetSpanServiceMappings()
if test.err != "" {
Expand Down
Loading